Add Fedex REST API rate and tracking functionality, to co-exist with Fedex WSDL #4374

xqiu · 2024-11-21T22:34:20Z

Description (*)

Add Fedex REST API rate and tracking functionality, to co-exist with Fedex WSDL.
The reason is that Fedex WSDL still functions. But Fedex starts to require some accounts to use REST API (in my actual case), and stopped one of my accounts to use WSDL.

Fixed Issues (if relevant)

Fixes FedEx WSDLS will be retired on May 15, 2024, need to use RESTful API #3308

Manual testing scenarios (*)

Use Fedex shipping method, get quotation from Fedex test server
Use Fedex shipping method, get quotation from Fedex production server (I've used the code in production)
Use Fedex shipping method, to track the shipment in openmage backend and frontend, when clicking the fedex shipment number 123456789012 for both Fedex test and productions server (I've used the code in production)

Questions or comments

The change requires PHP 8.1 and above, as the package shipstream/fedex-rest-sdk requires.

Fedex is currently in transition from WSDL to REST API. This change allows configurable usage of WSDL or REST API. Note: uses shipstream/fedex-rest-sdk, but currently it's not updated with fedex tracking API schema, so need to use a patch branch for it. Also composer installing shipstream/fedex-rest-sdk requires PHP 8.1+, so I've to change php version as well for this commit.

sreichel · 2025-01-06T22:33:57Z

Someone using FEDEX to test it?

sonarqubecloud · 2025-01-26T18:25:56Z

Quality Gate failed

Failed conditions
3.9% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

Copilot

Pull Request Overview

This PR adds FedEx REST API functionality to co-exist alongside the existing FedEx WSDL implementation, allowing users to switch between API types as needed.

Adds a REST API SDK dependency and configuration options for REST API credentials
Implements REST API rate calculation and shipment tracking functionality
Maintains backward compatibility with existing WSDL implementation while supporting PHP 8.1+ requirement

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
composer.json	Adds FedEx REST SDK dependency and updates PHP version requirement to 8.1.28
app/code/core/Mage/Usa/etc/system.xml	Adds configuration fields for REST API toggle and tracking credentials
app/code/core/Mage/Usa/etc/config.xml	Adds encrypted backend models for new REST API tracking credentials
app/code/core/Mage/Usa/Model/Shipping/Carrier/Fedex.php	Implements REST API rate and tracking methods with conditional logic
README.md	Adds contributor entry
.all-contributorsrc	Adds contributor configuration

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-14T19:27:41Z

composer.json

@@ -138,7 +139,7 @@
            "openmage/composer-plugin": true
        },
        "platform": {
-            "php": "7.4"
+            "php": "8.1.28"


The platform PHP version should be specified as a minimum version (e.g., "8.1") rather than a specific patch version ("8.1.28") to allow flexibility with newer compatible patch releases.

Suggested change

"php": "8.1.28"

"php": "8.1"

Copilot · 2025-08-14T19:27:42Z

app/code/core/Mage/Usa/etc/system.xml

+                            <comment>Fedex RestAPI need a seperate project for tracking, it's different with project that collect rate.</comment>
+                        </rest_track_key>
+                        <rest_track_secrete translate="label">
+                            <label>RestAPI Track Secrete</label>


The field name 'rest_track_secrete' contains a spelling error. It should be 'rest_track_secret' (without the 'e' at the end).

Suggested change

<label>RestAPI Track Secrete</label>

<rest_track_secret translate="label">

<label>RestAPI Track Secret</label>

Copilot · 2025-08-14T19:27:42Z

app/code/core/Mage/Usa/etc/system.xml

+                            <comment>Fedex RestAPI need a seperate project for tracking, it's different with project that collect rate.</comment>
+                        </rest_track_key>
+                        <rest_track_secrete translate="label">
+                            <label>RestAPI Track Secrete</label>


The label contains a spelling error. 'Secrete' should be 'Secret'.

Copilot · 2025-08-14T19:27:42Z

app/code/core/Mage/Usa/etc/system.xml

+                            <show_in_default>1</show_in_default>
+                            <show_in_website>1</show_in_website>
+                            <show_in_store>0</show_in_store>
+                            <comment>Fedex RestAPI need a seperate project for tracking, it's different with project that collect rate.</comment>


The comment contains a spelling error. 'seperate' should be 'separate'.

Copilot · 2025-08-14T19:27:42Z

app/code/core/Mage/Usa/etc/config.xml

@@ -126,6 +126,8 @@
                <meter_number backend_model="adminhtml/system_config_backend_encrypted"/>
                <key backend_model="adminhtml/system_config_backend_encrypted"/>
                <password backend_model="adminhtml/system_config_backend_encrypted"/>
+                <rest_track_key backend_model="adminhtml/system_config_backend_encrypted"/>
+                <rest_track_secrete backend_model="adminhtml/system_config_backend_encrypted"/>


The configuration key 'rest_track_secrete' contains a spelling error. It should be 'rest_track_secret' to match standard terminology.

Copilot · 2025-08-14T19:27:43Z

app/code/core/Mage/Usa/Model/Shipping/Carrier/Fedex.php

+            if ($this->getConfigData('use_rest_api')) {
+                $this->_getRestApiTracking($tracking);
+            }
+            else{


Missing space before opening brace. Should be 'else {' for consistency with PHP coding standards.

Copilot · 2025-08-14T19:27:43Z

app/code/core/Mage/Usa/Model/Shipping/Carrier/Fedex.php

+                new RequestedPackageLineItem(
+                    weight: new Weight(
+                        units: $this->getConfigData('unit_of_measure'),
+                        value: $this->getTotalNumOfBoxes($request->getPackageWeight()),


Using 'getTotalNumOfBoxes' with weight parameter suggests incorrect usage. This method typically calculates number of boxes, but the weight should be the actual package weight, not number of boxes.

Copilot · 2025-08-14T19:27:43Z

app/code/core/Mage/Usa/Model/Shipping/Carrier/Fedex.php

+            if($storeCurrencyCode != $currencyCode){    
+                $currencyStore = Mage::getModel('directory/currency')->load($storeCurrencyCode);
+                $currencyCurrent = Mage::getModel('directory/currency')->load($currencyCode);
+                $rate = round($rate / $currencyStore->getRate($currencyCurrent));


Currency conversion logic is incorrect. Should multiply by the rate, not divide. The correct formula should be: $rate = round($rate * $currencyStore->getRate($currencyCurrent)).

Copilot · 2025-08-14T19:27:43Z

app/code/core/Mage/Usa/Model/Shipping/Carrier/Fedex.php

+
+        // Handle delivery date and time
+        if($trackInfo->dateAndTimes){
+            if($trackInfo->dateAndTimes[0]->type == 'ACTUAL_DELIVERY' || $trackInfo->dateAndTimes[0]->type == 'ACTUAL_PICKUP' ||


The condition checks for 'ESTIMATED_DELIVERY' twice (lines 1926), which appears to be a copy-paste error. The second occurrence should likely be 'ESTIMATED_PICKUP'.

mattdavenport · 2025-08-14T19:34:14Z

Figured I would try the Copilot reviewer here. FedEx will be retiring Web Services on 6/1/26 (per a recent reminder email), which I suppose was pushed back from the original May '24 date, and as @xqiu mentioned, new accounts can potentially no longer access the SOAP API. I'll keep an eye on this one and do some testing myself in the coming weeks, but if any other maintainer has an account (and the time 😄) to test it would be great to push this through.

xqiu added 5 commits November 13, 2024 11:32

Update composer.json shipstream/fedex-rest-sdk to ^1.1.2

3627816

Merge branch 'OpenMage:main' into main

aad7c8e

Add @xqiu as a contributor

10f3f38

Merge branch 'main' of https://github.com/xqiu/magento-lts

99694a6

github-actions bot added documentation Component: Usa Relates to Mage_Usa composer Relates to composer.json labels Nov 21, 2024

xqiu marked this pull request as ready for review December 1, 2024 22:47

Merge branch 'main' into main

2a24dc3

xqiu added 3 commits January 26, 2025 10:02

Add retry logic with shipDatestamp increment for Fedex REST API quote

17f8dce

Merge branch 'main' of https://github.com/xqiu/magento-lts

87e815b

Merge branch 'main' into main

8760062

mattdavenport requested a review from Copilot August 14, 2025 19:26

Copilot AI reviewed Aug 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add Fedex REST API rate and tracking functionality, to co-exist with Fedex WSDL #4374

Add Fedex REST API rate and tracking functionality, to co-exist with Fedex WSDL #4374

Uh oh!

xqiu commented Nov 21, 2024

Uh oh!

sreichel commented Jan 6, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Jan 26, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

mattdavenport commented Aug 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

	<label>RestAPI Track Secrete</label>
	<rest_track_secret translate="label">
	<label>RestAPI Track Secret</label>

Uh oh!

Add Fedex REST API rate and tracking functionality, to co-exist with Fedex WSDL #4374

Are you sure you want to change the base?

Add Fedex REST API rate and tracking functionality, to co-exist with Fedex WSDL #4374

Uh oh!

Conversation

xqiu commented Nov 21, 2024

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Uh oh!

sreichel commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud bot commented Jan 26, 2025

Quality Gate failed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

mattdavenport commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

sreichel commented Jan 6, 2025 •

edited

Loading

mattdavenport commented Aug 14, 2025 •

edited

Loading