FedEx REST API Configuration in SureShip

FedEx REST API Configuration in SureShip


FedEx REST API Configuration in SureShip

This document is intended to be used by customers who have already obtained their API key and Secret key from FedEx.

Test Environment for Parcel

  1. Open the SureShip Carrier Connection Configurations form
  2. Select or Filter in the Carrier field to select the FedEx record
  3. Select the Attributes tab and specify the following for ParcelPickupType:
    1. USE_SCHEDULED_PICKUP if you have a daily scheduled pickup.
    2. CONTACT_FEDEX_TO_SCHEDULE if you don't have a FedEx parcel driver making daily pickups. 



  1. Standard label size is 4 X 6. If your label type is not STOCK_4X6, specify the exact label type for the parameter LabelStockType. The following are the available options:
PAPER_4X6
PAPER_4X675
PAPER_4X8
PAPER_4X9
PAPER_7X475
PAPER_85X11_BOTTOM_HALF_LABEL
PAPER_85X11_TOP_HALF_LABEL
PAPER LETTER
STOCK_4X85_TRAILING_DOC_TAB
STOCK_4X675_LEADING_DOC_TAB
STOCK_4X8
STOCK_4X9_LEADING_DOC_TAB
STOCK_4X6
STOCK_675_LEADING_LEADING_DOC
STOCK_4X6
STOCK_4X675_TRAILING_DOC_TAB
STOCK_4X9_TRAILING_DOC_TAB
STOCK_4X675
STOCK_4X9




*If you select an option that starts with Paper then update the ImageType from ZPII to PDF:



      2. On the Address tab, specify your Billing and Shipping addresses. Note that the Billing Address must match the address on your FedEx Invoice. 



      3. On the API Calls tab for each API Type, override any values that reference "AccountNumber", "ClientId", and "ClientSecret" with your company's Test information received when creating your Test credentials. 








NotesNote: If you are shipping LTL in the Test environment follow these instructions:

  1. Open the SureShip Carrier Connection Configurations form
  2. Select the Attributes tab and specify the following for FreightPickupType:
    1. USE_SCHEDULED_PICKUP

  3. On the API Calls tab for both API SHIP and SHOP Type, override any values that reference "FreightAccountNumber", "FreightClientId", and "FreightClientSecret" with the freight information you generated for Test Keys.


      4. On the API Calls tab for both API SHIP and SHOP Type, override the value that references "FreightAPIAccountNumber
    1. If you ship using both Parcel & Freight this number will be the same as your ParcelAccountNumber.
    2. If you only ship using Freight this number will be your FreightAccountNumber.

Production Environment for Parcel

  1. Open the SureShip Carrier Connection Configurations form
  2. Select or Filter in the Carrier field to select the FedEx record
  3. Select the Attributes tab and specify the following for ParcelPickupType:
    1. USE_SCHEDULED_PICKUP if you have a parcel driver that makes daily scheduled stops.
    2. CONTACT_FEDEX_TO_SCHEDULE if you don't have a FedEx parcel driver making daily pickups. 

  1. Standard label size is 4 X 6. If your label type is not STOCK_4X6, specify the exact label type for the parameter LabelStockType. The following are the available options:
PAPER_4X6
PAPER_4X675
PAPER_4X8
PAPER_4X9
PAPER_7X475
PAPER_85X11_BOTTOM_HALF_LABEL
PAPER_85X11_TOP_HALF_LABEL
PAPER LETTER
STOCK_4X85_TRAILING_DOC_TAB
STOCK_4X675_LEADING_DOC_TAB
STOCK_4X8
STOCK_4X9_LEADING_DOC_TAB
STOCK_4X6
STOCK_675_LEADING_LEADING_DOC
STOCK_4X6
STOCK_4X675_TRAILING_DOC_TAB
STOCK_4X9_TRAILING_DOC_TAB
STOCK_4X675
STOCK_4X9



Info
* If you select an option that starts with Paper then update the ImageType from ZPII to PDF.


      4. On the Address tab, specify your Billing and Shipping addresses. Note that the Billing Address must match the address on your FedEx Invoice. 


      5. On the API Calls tab, update all keys that have "AccountNummber", "ClientId", and "ClientSecret" in the name with your company's Production information received when creating your Production credentials.



6. Update URLs in the value column to the following URLs:
Type
Parameter
Value 
ADDRESS
ParcelAuthenticationURL
ADDRESS

ParcelURL

https://apis.fedex.com/address/v1/addresses/resolve

CERT

ParcelAuthenticationURL

CERT

ParcelURL

RETURN

ParcelAuthenticationURL

RETURN

ParcelURL

SHIP

FreightAuthenticationURL

https://apis.fedex.com/oauth/token

SHIP

FreightPickupURL

SHIP

FreightURL

SHIP

ParcelAuthenticationURL

SHIP

ParcelPickupURL

SHIP

ParcelURL

SHOP

FreightAuthenticationURL

SHOP

FreightURL

SHOP

ParcelAuthenticationURL

SHOP

ParcelURL

TRACK

ParcelAuthenticationURL

TRACK

ParcelURL

UPLOAD

ParcelAuthenticationURL

https://apis.fedex.com/oauth/token

UPLOAD

ParcelURL

VOID

ParcelAuthenticationURL

VOID

ParcelURL




NotesNote: If you are shipping LTL in the Production Environment follow these instructions:

  1. Open the SureShip Carrier Connection Configurations form
  2. Select the Attributes tab and specify one of the following for FreightPickupType:
    1. USE_SCHEDULED_PICKUP if you have a FedEx freight driver that makes daily pickups.
    2. CONTACT_FEDEX_TO_SCHEDULE if you don't have a FedEx freight driver making daily pickups. 
  3. On the API Calls tab for both API SHIP and SHOP Type, override any values that reference "FreightAccountNumber", "FreightClientId", and "FreightClientSecret" with the freight information you generated for Production Keys. 

      4. On the API Calls tab for both API SHIP and SHOP Type, override the value that references "FreightAPIAccountNumber."
    1. If you ship using both Parcel & Freight this number will be the same as your ParcelAccountNumber.
    2. If you only ship using Freight this number will be the same as your FreightAccountNumber.
 

    • Related Articles

    • FedEx REST API Checklist

      FedEx REST API Checklist Introduction Start by compiling the five main documents necessary for the transition from FedEx SOAP to FedEx REST. Those documents are the following: FedEx REST API Keys UCS Carrier API Setup and Configuration FedEx REST API ...

    • FedEx REST API Key Generation

      FedEx REST API Key Generation Initial Setup Before using the FedEx app, you should: Create a FedEx merchant account to receive an account number. For more information, see the official FedEx documentation: Open an Account Create a fedex.com User ID ...

    • SureShip API Connected Carriers

      SureShip API Connected Carriers Parcel Carriers DHL Worldwide Easy Post (and all carriers they support) Endicia (USPS) FedEx Express United Parcel Service (UPS) USPS TNT Freight Carriers ABF Freight CH Robinson Dayton Freight Lines Estes Freight ...

    • UCS Carrier API Setup and Configuration - FedEx (Cloud)

      UCS Carrier API Setup and Configuration - FedEx (Cloud) Overview This document is designed to describe how to setup and configure a Universal Carrier Schema (UCS) in SureShip™. UCS Setup In the Carriers form, add the Carrier Code listed for the UCS ...

    • UCS Carrier API Setup and Configuration - FedEx (On Prem)

      UCS Carriers API Setup and Configuration - FedEx (On Prem) Overview This document is designed to describe how to setup and configure a Universal Carrier Schema (UCS) in SureShip™. UCS Setup In the Carriers form, add the Carrier Code listed for the ...