FedEx: Update to the New FedEx API

Background

ShipWorks is updating how it connects to FedEx. This update ensures that you have access to the latest FedEx services and features.

This article will guide you through the process of migration your FedEx account to the new FedEx API.

First Things First

Prior to following the steps in the The Process section, please ensure that you review the Things to Know and FedEx Available Features sections below to ensure that you are aware of the latest features and of any changes after migrating to the new FedEx API. Changes include updates to FedEx SmartPost, emailing return labels to your customers, Dangerous Goods with FedEx, email notifications sent from FedEx, and more.

Please also ensure that:

You have your FedEx account number and the account Shipping Address on file with FedEx. This information can be located in your online FedEx account.
- Log in to your online FedEx account. Then, go to My Profile > Account Management. Then, click View/Edit to the right of your FedEx account number to view the Shipping Address.
You can log in to ShipWorks as a user with administrator rights.
If running more than one ShipWorks workstation, you have access to the ShipWorks server (the PC running the ShipWorks database).

The Process

1. Verify the FedEx Account Address in ShipWorks

Successfully migrating your FedEx accounts to the new API requires the FedEx account address in ShipWorks to match the Shipping Address on file in your online FedEx account.

Follow these steps to ensure that the address in ShipWorks and in your online FedEx account match.

Launch and log in to the ShipWorks software.
Click on the Manage tab and then on the Shipping Settings button.
Select FedEx in the list of carriers on the left side of the Shipping Settings screen.
Select your FedEx account and click the Edit button.
Verify that the Address on the Account tab in ShipWorks matches the Shipping Address on file in your FedEx account. If the addresses do NOT match, update the address information in ShipWorks to match the address in your FedEx account. Click OK to save your changes.
Repeat this process for all FedEx accounts connected to ShipWorks.

2. Note the Current ShipWorks Software Version and Make a Backup

Please don't skip this section. We don't expect anything to go wrong, but making a backup of your ShipWorks database is a great idea in case you need to restore your database back to its current state.

The steps in this section need to be completed on the main ShipWorks server (the PC running the ShipWorks database).

Open the ShipWorks software and go to the Help tab and click on the About ShipWorks button. Make note of the ShipWorks software version number. Write it down. Knowing the current version may be useful if you need support and a support team member asks you for it.
Click on the Manage tab and then on the Backup button. Then, click the Browse button.
Navigate to the folder in which you wish to save your ShipWorks backup file.
Rename the file so that the filename includes the current version number. For example: ShipWorks Backup v9.13.3.14470.
Click the Backup button to save your backup.

You're now ready to move to step 3 Upgrade to ShipWorks Version 10.

3. Upgrade to ShipWorks Version 10

ShipWorks version 10 or later automates the process of migrating your connected FedEx accounts to the new FedEx API as part of the upgrade process.

Follow the steps outlined in our help article, How Do I Upgrade ShipWorks, to upgrade to version 10 or later.

Back up ShipWorks

During the update process, you will be prompted to create a database backup. If you created a backup in the previous section of this article:

It is OK to overwrite the previously created backup with this new one.
Please be sure to leave the backup file name as is, leaving the version number as part of the file name. (See step 4 above for more info).

During the upgrade process, ShipWorks detects any FedEx accounts added to the ShipWorks software and attempts to update the accounts to the new FedEx API connection. After successfully migrating the FedEx accounts, ShipWorks will open to the Orders Grid. At this point, there is nothing further that you need to do. You can continue shipping as normal.

Be sure to review the Things to Know and FedEx Available Features sections below to ensure that you are aware of the latest features and of any changes after migrating to the new FedEx API.

The migrating FedEx accounts modal is shown.

Error When Updating

Did you encounter an error during the migration process? Please see the Troubleshooting section below.

Things to Know

The following five items are changing and may impact your shipping workflow:

FedEx Ground® Economy (Formerly SmartPost)

SmartPost is now FedEx Ground® Economy: FedEx SmartPost has been renamed to FedEx Ground® Economy. All instances of 'SmartPost' are now listed as 'FedEx Ground® Economy' in the ShipWorks software.
Hub IDs: FedEx Ground® Economy Hubs are now listed as the city and state of the Hub location instead of the Hub ID. For example: Instead of Hub ID: 5631, the Hub will be displayed as Hub: St. Louis, MO.
Multiple Hub Locations: FedEx accounts in ShipWorks can now only be associated to a single Hub location. Merchants using FedEx accounts associated to multiple Hub locations:
- During the migration, FedEx accounts associated to more than one Hub ID were duplicated with each, individual Hub being associated to a single FedEx account.
  
  For example: Prior to the migration FedEx account 1234567890 had Hub IDs 5531, 5087, and 5379 associated to it in ShipWorks.
  
  After the migration, FedEx account 1234567890 is added to ShipWorks three times, each account with an individual Hub associated with it.
Shipping Profiles: Check all Shipping Profiles to ensure the correct FedEx Account/Hub combination is selected for each profile. This will ensure that any automation and Shipping Rules configured in ShipWorks to automatically apply FedEx Ground® Economy services will continue to function properly.
- Click on the Manage tab and then on Shipping Profiles. Then, select the FedEx profile and click the Edit button.
- Select the FedEx account associated to the correct Hub from the Account: drop-down menu.

Shipping Dangerous Goods with FedEx No Longer Supported

The ability to ship Dangerous Goods is no longer available. You may wish to reach out to your FedEx account manager to discuss available options for shipping Dangerous Goods with FedEx.

Disable Dangerous Goods Automation Rules

If you ship Dangerous Goods with FedEx AND have automation rules configured in ShipWorks to automatically select the Dangerous Goods option, please disable any Dangerous Goods automation rules.

Your Dangerous Goods automation rules will NOT cause an error when applied to shipments. However, it is important to note that the printed FedEx label will NOT have the Dangerous Goods option applied.

Go to the Manage tab and click on the Shipping Settings button. Then, select FedEx from the list of carriers.
Select the Settings tab.
Delete any shipping rules that apply the Dangerous Goods option to your FedEx shipments by clicking the red X to the left of the rule.

EPL (Eltron Programming Language) Printers No Longer Supported with FedEx

The EPL printer format, used with printers such as older thermal printers or some Dymo label printers, is no longer supported with FedEx.

Merchants using printers that only support the EPL label format should configure ShipWorks to send Standard formatted labels to a thermal printer.

FedEx Email Notifications No Longer Supported

The FedEx option to email shipment/delivery notifications to your customers is no longer supported.

Use ShipWorks' email and delivery notification functionality to automatically keep customers apprised of the delivery status of their orders.

Email FedEx Return Labels no Longer Supported

The ability to have FedEx email a return label to your customers is no longer supported.

Use ShipWorks' email functionality to email return labels to your customers.

FedEx Available Features and Additional Details

FedEx Features in ShipWorks

Key: Green checkmark. Supported feature. Yes. = Supported; Red X mark. Unsupported feature. No. = Not Supported; Grey dash icon. Not applicable. = Does Not Apply

Feature	Supported?	Notes
Domestic Shipping
International Shipping
FIMS (FedEx International Mail Service)
Electronic Customs Submission		Commercial Invoices will be automatically generated by FedEx and sent electronically if supported by the destination country. You may be required to upload a header and signature image in ShipWorks for some countries.
DDP (Delivered Duties Paid)
Commercial Invoice Letterhead and Signature
Return Labels		Generate a FedEx return label with an associated RMA Number. RMA Reason is not supported. Did you know that you can automatically generate a return label at the same time as the shipping label?
Dangerous Goods		The ability to ship Dangerous Goods is unavailable within ShipWorks. You may wish to reach out to your FedEx account manager to discuss available options for shipping Dangerous Goods with FedEx.
FedEx Email Return Labels		Learn how to configure ShipWorks to automatically email return labels.
Estimated Rates
Carrier Declared Value
Tracking
FedEx Email Notifications (Ship, Delivery, Exception)		Learn how to configure ShipWorks to automatically send your customers shipment notification emails based on delivery status changes.
FedEx Ground® Economy
FedEx Ground® Economy Close (Electronic)
Ground Close (Printable)
FedEx One Rate®
Label Messages
Multi-package Shipping
Multiple Accounts
Bill to Third Party
FedEx Ground® Collect
FedEx® Collect On Delivery
Saturday Delivery
Saturday Pickup		Schedule a Saturday pickup directly within your FedEx account on the FedEx Pickup Options page.
Hold at Location
FedEx Priority Alert®
FedEx Signature Release		The FedEx 'Signature Release' option authorizes the shipment to be released without anyone present or signing for the shipment. This should not be confused with the 'Signature Required' option which is fully supported in ShipWorks.
EORI and VAT Numbers
Alcohol Shipping and Dry Ice
Print Labels to Standard Laser and Inkjet Printer
Print Labels to Thermal Printers (ZPL only)		The EPL printer format, used with printers such as older thermal printers or some Dymo label printers, is no longer supported with FedEx accounts. Merchants using printers that only support the EPL label format should configure ShipWorks to send Standard formatted labels to a thermal printer.
Labels with Printed Doc-tab		Learn how to configure ShipWorks to print labels that include a doc-tab or to 4" x 8" label stock.

FedEx Services, Package Types, and Signature Confirmation Options

FedEx Domestic Services	FedEx International Services	FedEx Package Types	FedEx Signature Confirmation Options
FedEx Ground® FedEx Standard Overnight® FedEx First Overnight® FedEx Priority Overnight® FedEx 2Day® FedEx 2Day® A.M. FedEx Express Saver® FedEx Home Delivery® FedEx Ground® Economy FedEx First Overnight® Freight FedEx 2Day® Freight FedEx 3Day® Freight FedEx One Rate®	FedEx International First® FedEx International Priority® FedEx International Priority® Express FedEx International Economy® FedEx International Priority® Freight FedEx International Economy® Freight FedEx International Ground® FedEx International Connect Plus®	Your Packaging FedEx® Small Box FedEx® Medium Box FedEx® Large Box FedEx® Extra Large Box FedEx® Envelope FedEx® Pak FedEx® Box FedEx®Tube	No Signature Required Indirect Signature Adult Signature Direct Signature

Additional FedEx Details

ShipWorks does not support "Cash Only" FedEx account types. You must be on a billed account to connect FedEx with ShipWorks.
The ability to mask the FedEx account number on the printed shipping label is not supported.
The Ship Date for created labels must be within 10 days of the current date.
The ability to ship Dangerous Goods is unavailable within ShipWorks. Please ship Dangerous Goods directly with FedEx.
If you include carrier insurance and the declared value exceeds $500 USD, FedEx will require a Direct Signature for delivery regardless of the confirmation option selected in ShipWorks.

This requirement will apply to each package valued at over $500 USD in a multi-package shipment, thus adding Direct Signature fees to those packages. If this multi-package shipment has only one master tracking number, check with FedEx billing support for details about the signature requirements/fees for each individual package.
ShipWorks' address validation tool determines if an address is Residential or Commercial. This tool is based on the Stamps.com database, and it pulls heavily from the USPS database. Since FedEx uses its own database to determine Residential and Commercial addresses, there are rare cases where the address type set by ShipWorks does not match FedEx's address type for the same address. This can result in a mismatch between the estimated rate and the actual amount that FedEx bills you for the shipment.
When you get rates for FedEx on a Saturday, a Saturday-Pickup fee will be included in the estimated rate. This fee will only apply when the package is actually picked up on a Saturday.
The Drop Off Type you select in the FedEx carrier settings can affect estimated rates. We recommend that you choose the same Drop Off Type you and your FedEx representative set up to use with your account. The available options are as follows:
- Regular Pickup: The shipper already has an every-day pickup scheduled with a courier.
- Request Courier: The shipper will call FedEx to ask for a courier.
- Drop Box: The shipper will drop the package in a FedEx dropbox.
- Business Service Center: The shipper will drop off the package at an authorized FedEx business service center.
- Station: The shipper will drop off the package at a FedEx Station.
FedEx Ground® Economy shipments do not support the ability to request a USPS delivery confirmation or to print a Manifest ID on the shipping label.
When shipping internationally with FedEx:
- AES/EEI Exemptions: Filing EEI (Electronic Export Information) exemptions directly in ShipWorks is not supported. Please visit the FedEx Electronic Export Information filing requirements page for detailed information.
- NAFTA: Filing NAFTA information electronically for your FedEx shipments in ShipWorks is not supported. ShipWorks allows you to print commercial invoices for your international shipments. However, other forms your shipments may require (like USMCA/NAFTA forms) cannot be filed or printed through ShipWorks. Forms not provided through ShipWorks must be created and printed outside of ShipWorks and included with your shipment according to the carrier's standards. See the FedEx New U.S.-Mexico-Canada Agreement (USMCA) page for detailed information.
- International Broker: Using an international broker is not supported. See the FedEx Broker Option page for details on using a broker with FedEx international shipments.
- Return Clearance: Return Clearance is not supported. See the FedEx Tips and tools for FedEx® Global Returns page for detailed information on international returns.
- Bill Duties/Fees to: The ability to bill duties and fees to the sender/3rd party is no longer supported.

Troubleshooting

Did you receive the following errors during the FedEx migration process? Expand each error to view more details.

Some accounts encountered issues migrating. See the log for details.

Reason:

The most common reason that this error is encountered is that the FedEx account address in ShipWorks does not match the Shipping Address on file in your online FedEx account.

What to Do:

Follow the steps in The Process section of our FedEx: Add to ShipWorks help article to add your FedEx account to ShipWorks. Make sure that the FedEx account address you enter when adding the account matches the Shipping Address on file in your online FedEx account.
Delete the original FedEx account (the account already in ShipWorks when you migrated). This will save any confusion and possible errors when shipping.
1. Go to the Manage tab and click the Shipping Settings button. Then, select FedEx from the list of carriers.
2. Select the account you wish to delete (the account in ShipWorks when you migrated).
3. Click the Delete button.

A shipping carrier error occurred: There are no valid services available.