LTL
      Back to home
      1. Knowledge Base
      2. Shipments
      3. LTL

      FedEx REST API Transition Guide

      This article aims to assist Tai users with upgrading their FedEx integration to their new REST API. Our current version of the FedEx tariff is scheduled to be deprecated on August 31st, 2024.

      OVERVIEW 

      1. Retrieve the new credentials. The credentials required will be:
        1. Rating Client ID
        2. Rating Secret ID
        3. Tracking Client ID
        4. Tracking Secret ID
        5. Account Number
        6. Bill To Account Number
      2. Create a new FEDEX REST integration in the TMS. 
      3. Create a new tariff attached to this newly created integration. 

      RETRIEVE NEW CREDENTIALS


      The FedEx team has facilitated the following video and step-by-step guide explaining how to retrieve the new credentials needed for this integration. 


      Getting Started with FedEx APIs - Video

      Getting Started with FedEx APIs - Guide


      Note you will need to log in with your FedEx username and password to access the guide. You will also need to have your shipping account number ready to be added throughout the process. 


      The path to create the credentials will need to be conducted for two APIs, Rating and Tracking.

      For Rating specifically, select the option called Freight LTL API:

      When concluded, generate the Production Key, and grab the Client ID and Secret ID as follows. You must do this for the Freight LTL API and the Tracking API. 


      FEDEX REST INTEGRATION

      1. From the TMS, go to Rates > Integration Sources > Add New Integration Source. 
      2. Under the name field, enter the name you’d like the integration to have. You can name it following the tariff criteria, which is typically determined by the direction (blanket or customer-specific). An example would be ‘BL - Brokers' Name - FedEx REST’ or ‘CS - Brokers' Name - End Customer Name - FedEx REST.’ 
      3. Under Source Group, select Rating. 
      4. Under Rating Type, select FEDEX REST. 
      5. Under Username, enter the Freight LTL API Client ID. 
      6. Under Password, enter the Freight LTL API Secret ID. 
      7. Under Account Number, enter your FedEx Account Number. 
      8. Save the integration. 
      9. Once created, click on Edit Source. 
      10. Enter the following information under Source Settings:
        1. paymentType = Sender, Recipient, Third Party → User S for Sender, R for Recipient, T for Third Party. 
        2. bill to number  = Bill To Account Number
        3. billTo.Lines (bill to address line) = Address
        4. billTo.city
        5. billTo.StateName
        6. billTo.postalCode
        7. billTo.country
        8. Direction = Consignee or shipper, Third Party → User C for Consignee, S for Shipper, T for Third Party. 
        9. TrackingUsername: Tracking Client ID. 
        10. TrackingPassword: Tracking Secret ID. 

      The end result should look like this: 

      NEW TARIFF FOR THE INTEGRATION

      1. On the same integration source newly created for the FedEx REST integration, scroll down and click Add New Tariff. 
        1. Name: Even though the name will be built automatically, enter a preliminary name to save the tariff. If the tariff is blanket for all customers, the name will start with a "BL," and if the tariff is customer-specific, it will start with a "CS." The name of the customer or the organization will follow, as will the carrier's SCAC. 
        2. Carrier: FEDEX FREIGHT (FXFR)
        3. Mode: LTL. 
        4. Effective Date/Expiration Date: The system will default to today's effective date and 20 years' expiration date. 
        5. Service level: Normal. 
        6. Status: Active. 
        7. Pricing Instructions: Customize as needed.  
        8. Tariff Sources: Select the newly created integration source if it is not populated automatically. 
        9. Tariff Owner: Typically, it will be the accounting organization or the parent account, which is the company in charge of paying the carrier. 
        10. Check the "Customer Specific" box if it needs to be linked to a particular customer. To complete this, a tariff link will also need to be added. 
        11. Bill To Type: 1st or 3rd party collect and prepaid are the options. 
        12. Bill To Address & Account Number: These will populate on the BOL and default to the tariff owner's organization address. 
        13. Tariff Settings: Select if the tariff will be available for the front office, the rate requirements, and the lane's initial points. These can then be modified and adjusted on the tariff lane. For the time being, leave the lane point unchecked.
      2. Save the tariff. 
      3. Click Import/Export CSV > Import Tariff. Follow the prompts and attach the following file:
        1. FedEx Tariff Lanes
        2. Download the file in Excel or CSV format. Either should work. 
      4. Click Tariff Tools > Tariff Links and ensure the tariff is correctly linked to the organization or applicable customers.

      You should be all set after following these steps. Try testing with a shipment, and if you see any issues, reach out to automation@tai-software.com.

       

       

       

      FEDEX VOLUME INTEGRATION

      If volume rating is also needed, the API key for PROD can be obtained from the Spot Quote Online Registration page: https://ecom-gateway-ws.freight.fedex.com/fxfSpotQuote/index.html