Adobe Commerce merchants can no longer transact with the current UPS integration after August 5, 2024. This is because the United Parcel Service (UPS) APIs used by the native Adobe Commerce integration do not currently support the required OAuth 2.0 security model.
In this post, we will share details about UPS API changes for Adobe Commerce and the difficulties we faced.
ON THIS PAGE
UPS API Authentication Migration and Adobe Commerce Patch Update for OAuth 2.0 Integration
UPS has announced that the access key authentication is deprecated in favor of an OAuth 2.0 security model for all APIs. June 4, 2024, was the date announced for deprecation previously. Now it has been extended until August 5, 2024. After August 5, 2024, all integrations must utilize the OAuth 2.0 authentication model to continue transacting with UPS APIs.
Adobe Commerce Merchants should apply a quality patch update to their store to migrate from the SOAP API to the RESTful API, which supports OAuth 2.0 authentication protocols. Adobe released a hotfix, which allows Adobe Commerce 2.4.4+/2.4.5+/2.4.6+ merchants to migrate to the latest UPS REST APIs.
UPS Configuration at Magento Admin->Stores->Configuration->Sales->Delivery Methods->UPS
Read Also: How to Create Custom Magento 2 CMS Directives
Affected/Deprecated UPS Type
- United Parcel Service.
- United Parcel Service Xml.
New UPS Type
- United Parcel Service REST.
We must use the United Parcel Service REST type, this will be the default option in UPS configuration in future releases including Adobe Commerce 2.4.7.
The patch can be downloaded from the below page based on the version of Magento you are running.
UPS shipping method integration migration from SOAP to RESTful API
Upload the patch file
AC-9648_UPS_Shipping_Method_Migration_REST_API_2.4.6x_COMPOSER.patch into the Magento root folder and run the following commands in the terminal to apply the patch.
patch -p1 < AC-9648_UPS_Shipping_Method_Migration_REST_API_2.4.6x_COMPOSER.patch.
Depending on the Magento version we work on, the patch file will differ and will require full deployment.
Instructions for Applying UPS REST API Patch and Configuration in Adobe Commerce
To ensure a successful patch application, UPS type “United Parcel Service REST” will be added in addition to the existing types.
It is necessary to select United Parcel Service REST in admin and confirm the rates on the front end. A new UPS account credential must be created in order to verify whether UPS shipping rates are fetched correctly from UPS in RESTful API.
The patch has been applied to one of the v2.4.6 Magento stores in order to ensure that UPS shipping will not be a problem for them. At first, we could not get any rates in the front end after selecting “United Parcel Service REST”. Later, we discovered that UPS has some specific settings to accomplish this.
The “Rating” product must be added to UPS’s My Apps section and approved to retrieve shipping rates via RESTful API. Please find the screenshot below,
Note: The patch for the previous version of Magento v2.4.4 is not available. We need to prepare for the customer who uses UPS shipping with the lowest version of Magento.
Conclusion
The transition of OAuth 2.0 for UPS API authentication is important for Adobe Commerce merchants to ensure uninterrupted transactions beyond August 5, 2024. The necessary migration from SOAP to RESTful API requires applying the latest Adobe Commerce patch. Merchants should update their UPS configurations to “United Parcel Service REST” and create new UPS account credentials to fetch shipping rates correctly.
In order to avoid last-minute changes on live servers, please ensure the patches are updated on the website we are working on.
Feel free to contact us for further questions regarding the UPS API patch and shipping rates.
