How to Integrate with the FedEx REST API

A guide on how to integrate your FedEx account with StoreFeeder using the new FedEx REST API courier.

What's this Guide For?

This guide will get your FedEx account up and running with StoreFeeder using the FedEx REST API integration. Once it is set up you'll be able to despatch orders through StoreFeeder using your FedEx services.

Unlike the older FedEx integration, you no longer need to contact FedEx to request a key, meter number and password. Instead, StoreFeeder registers with FedEx on your behalf: you accept the FedEx licence agreement, enter your account number and billing address, verify that you own the account, and StoreFeeder receives and stores the API credentials automatically.

Before You Start

Have the following to hand before you begin — the registration will fail without them:

• Your 9-digit FedEx account number.
• The billing address exactly as FedEx holds it for that account.
• Access to either:
  • the email address or mobile number registered with FedEx for that account (so you can receive a one-time PIN), or
  • the details of a recent FedEx invoice (invoice number, date, currency and amount).

Step 1.

Sign into StoreFeeder using your login details. Go to Settings in the top right of the page, then click Your Integrations.

On the Integration Manager page, click the green + New Integration button, choose Courier as the integration type, and then select FEDEX REST API from the list of couriers.

Please note: there are several FedEx tiles in this list. Make sure you pick FEDEX REST API — not FED EX, FEDEX API or FEDEX INTERNATIONAL CONNECT, as these are separate, older integrations that are set up in a different way.

You will then be asked to enter a name for the integration, and whether you wish to extend permissions to all users on your account. Once you have finished, click + Add Integration to proceed.

Step 2.

Before you can start verification you must read and accept the FedEx End User License Agreement (EULA).

In the FedEx account registration section, click Review and accept the FedEx EULA. The full agreement opens in a window.

The FedEx End User License Agreement window, showing the agreement, the read confirmation tick box and the accept button 

If you would like to keep a copy of the agreement, use the download the copy shown above (PDF) link underneath it. You can also open it on fedex.com if the agreement does not display in the window.

Please note: clicking Maybe later closes the window without accepting. You will not be able to start verification until the EULA has been accepted, so you will need to come back to this step.

Once accepted, an Accepted badge is shown along with the date you accepted it. You only need to do this once per integration.

Step 3.

Enter your FedEx account number before you fill in the address.

Type your 9-digit FedEx account number into the FedEx account number field at the top of the FedEx account registration section.

Important: the account number must be entered first. The billing address is validated against the account number you supply, so if the field is left blank — or filled in after you have started verification — the registration will be rejected.

Step 4.

Now complete Step 1 of 3: Billing address. These fields are prefilled from the Company Identity attached to the integration, so check every one and adjust it to match the billing address FedEx holds for your account.

The address must match what FedEx holds character for character. Two things catch people out most often:

• Postcode spacing must match FedEx exactly. If FedEx holds the postcode with a space (NG9 2JR), enter it with the space. If FedEx holds it without one (NG92JR), enter it without. A postcode that is otherwise correct will still be rejected if the spacing differs.
• Capitalisation must be correct. Enter the address using the same capitalisation FedEx holds — don't retype it in all capitals or all lower case.

If you are not sure how FedEx holds your address, check a recent FedEx invoice or your FedEx online account, and copy it from there.

When the address is complete, click Start verification.

Please note: once verification has started, the account number field is locked, because it is the account the address was validated against.

Step 5.

Step 2 of 3: Verify your identity. FedEx now needs to confirm that you own this account. There are two ways to do this, and StoreFeeder will show whichever options FedEx offers for your account.

Option A — Verify with a one-time PIN

Choose how you would like FedEx to send the PIN from the Send a PIN via dropdown, then click Send PIN. Depending on what FedEx holds for your account, the options offered are:

• SMS — a text message to the mobile number registered with FedEx.
• Email — an email to the address registered with FedEx.
• Call — an automated phone call to the number registered with FedEx.

StoreFeeder shows the masked email address and phone number FedEx will send to, so you can check which contact details are on the account before you send the PIN.

Please note: the PIN is only ever sent to the contact details registered with FedEx for that account — you cannot send it to a different email address or phone number from within StoreFeeder. If those details are out of date, contact FedEx to update them, or use Option B below.

Option B — Verify with a recent FedEx invoice

If you can't receive a PIN, use Or verify with a recent FedEx invoice instead and enter all four values from a recent invoice:

All four values are required, and they must match the invoice exactly. Then click Verify with invoice.

Step 6.

If you chose to verify by PIN, you will be taken to Step 3 of 3: Enter your PIN. Type the PIN FedEx sent you into Enter the PIN you received and click Confirm PIN.

The FedEx account registration section showing the FedEx account number field and Step 3 of 3, Enter your PIN, with the Confirm PIN button 

When the PIN is accepted, FedEx issues the API credentials and StoreFeeder stores them against the integration for you. You will see a green Verified badge and the message "Credentials are stored for this channel and it is ready to dispatch."

If you verified with an invoice instead, the credentials are issued at that point and you'll see the same Verified badge without needing a PIN.

Step 7.

Click Save at the bottom of the page to finish. Your FedEx REST API integration is now ready to despatch orders.

Optional - Broker (Broker Select Option)

Underneath the registration section you'll find Broker (Broker Select Option). This is entirely optional and only applies to international dutiable shipments.

Complete these fields only if you want to nominate your own customs broker to clear your international shipments instead of FedEx's default broker. Leave every field blank to use FedEx's default broker.

Re-verifying Your Account

Once an integration is verified, the registration wizard is replaced by a Re-verify / update credentials button.

You only need this if:

• FedEx has re-issued your credentials, or
• you have changed the FedEx account number on the integration.

Re-verifying takes you back through the address and verification steps, and updates both the stored credentials and the account number.

Troubleshooting

FedEx service marks are owned by Federal Express Corporation and are used by permission.