Shopping Cart - Carrier API Settings: Fedex

Breadcrumb path: Shopping Cart / Shipping Settings / Carrier API Settings

You can access this page by clicking on Shopping Cart from your main menu, and Shipping Settings from the drop-down menu. Click the Carrier API Settings button.

Click the FedEx tab to select FedEx API Settings. This is where the user can edit and manage the FedEx Carrier API Settings. 

FedEx API Keys

In this section, the user can enter the FeEx API Keys and Webhook settings.

• 1 Fedex API & Webhook On/Off

  [On | Off ] Button: This button allows the user to turn on or off the FedEx API & Webhook. 

• 2 API Key

  API Key: In this field, the user enters their FedEx API key. 

• 3 Secret Key

  Secret Key: In this field, the user enters their FedEx Secret Key. 

• 4 Account Number

  [Products Content Generator]. Click this button to open the Products Content Generator. This is covered in more detail in Products Content Generator.

• 5 Sandbox

  Sandbox:  The user can check this box to enable the Sandbox mode. Test purchases can be made using Sandbox mode to simulate different FedEx events.  

• 6 Webhook Notifications

  Webhook Notifications: This field enables the user to select [Yes | No] to get automated messages from FedEx directly pushed to the Website. 

• 7 Webhook URL

  [Filter]. Click this button to expand and reveal new fields as shown below.

• 7 Webhook Secret

  Webhook Secret: In this field, the user enters their FedEx Webhook Secret security token. 

The [Save] Button will save the entered API Keys and Webhook settings. 

The [Test my Settings] button will test all API Keys and Webhook settings keys 

FedEx Track Order Shipments

• 1 Status

  Status:  Shows the status of the FedEx Tracking API. 

• 2 Last Update

   Last Update: This shows the user the last update received from the 

• 3 Tracking API

  Tracking API: This  [On | Off ] button allows the user to turn on or off the FedEx Tracking API.

• 4 Tracking API Interval

   Tracking API Interval:  The user can set the interval at which the Tracking API updates. 

The [Test my Settings] button will test all API Keys and Webhook settings keys.

FedEx Events

The user can select the Webhook Events tab to view all available Webhook events. Each event can have its status checked so that an automated email is sent when that event is triggered by FedEx.   

• 1 Webhook Events

  Click this tab to view all Webhook events from FedEx. 

• 2 Event Code

  Event Code: This column shows the user the Event Code from FedEx.

• 3 Category

  Category: This column shows the user the Category from FedEx.

• 4 Description

  Description: This column shows the user the Description of the event from FedEx.

• 5 Status

  Status: The user can check the Status checkbox to enable an automated email to be sent for the selected Event. 

Below is a list of all Webhook Events from FedEx

Event Code	Category	Description
OC	Ship	Shipment information sent to FedEx
DO	Ship	Dropped Off
LC	Ship	Return label link cancelled by shipment originator
DS	Ship	Vehicle Dispatched
PD	Ship	Pickup delayed
CA	Ship	Shipment cancelled
PU	Ship	Picked up
US	Ship	Scheduled delivery updated
RD	Ship	Return label link expired
IP	Ship	In FedEx possession
HP	Ship	Ready for pickup
RG	Ship	Return label link expiring soon
RP	Ship	Return label link emailed to return sender
RS	Ship	Returning package to shipper
AR	In Transit	Arrived at Port of Entry
AF	In Transit	At local FedEx facility
AC	In Transit	At Canada Post Facility
IT	In Transit	On the way
OX	In Transit	Shipment information sent to U.S. Postal Service
PM	In Transit	In Progress
DP	In Transit	Left FedEx origin facility
DR	In Transit	Vehicle Furnished but Not Used
CP	In Transit	Clearance in Progress
EA	In Transit	US Export Approved
IN	In Transit	On Demand Care completed
MD	In Transit	Manifest data
TR	In Transit	Enroute to delivery
CC	In Transit	International shipment release
RC	In Transit	Delivery Option Request Cancelled
CH	In Transit	Location changed
OD	Delivery	Out for delivery
DL	Delivery	Delivered
DD	Exception	Delivery Delay
DE	Exception	Delivery Exception
SE	Exception	Shipment Exception
CD	Exception	Clearance delay
AE	Estimated Delivery Date	Shipment arriving early
AO	Estimated Delivery Date	Shipment arriving On-Time
DY	Estimated Delivery Date	Delivery updated
RR	Convenient Delivery Options	Delivery option requested
RM	Convenient Delivery Options	Delivery option updated
HA	Convenient Delivery Options	Hold at location request accepted
RT	Convenient Delivery Options	Return to Shipper Requested
RA	Convenient Delivery Options	Address Change Requested
PR	CDO	Performed Redirect - Address Change Completed
AS	Convenient Delivery Options	Address Corrected

The user can select the Tracking Events tab to view all available Tracking Events from FedEx. Each event can have its status checked so that an automated email is sent when that event is triggered by FedEx. 

• 1 Tracking Events

  Click this tab to view all Tracking Events from FedEx. 

• 2 Event Code

  Event Code: This column shows the user the Event Code from FedEx.

• 3 Category

  Category: This column shows the user the Category from FedEx.

• 4 Description

  Description: This column shows the user the Description of the event from FedEx.

• 5 Status

  Status: The user can check the Status checkbox to enable an automated email to be sent for the selected Event. 

• 6 Final Event

  Final Event: The user can check the Final Event checkbox to verify that the selected event will generate a final automated email. The order will no longer send automated emails once a final event automated email is sent to the customer. 

Below is list of all Webhook Events from FedEx

Event Code	Category	Description
PF	Movement	Plane in Flight
AA	Movement	At Airport
AC	Movement	At Canada Post facility
AD	Movement	At Delivery
AF	Movement	At local FedEx Facility
AO	Movement	Shipment arriving On-time
AP	Movement	At Pickup
AR	Movement	Arrived at FedEx location
AX	Movement	At USPS facility
CA	Movement	Shipment Cancelled
CH	Movement	Location Changed
DD	Movement	Delivery Delay
DE	Movement	Delivery Exception
DL	Movement	Delivered
DP	Movement	Departed
DR	Movement	Vehicle furnished but not used
DS	Movement	Vehicle Dispatched
DY	Movement	Delay
EA	Movement	Enroute to Airport
ED	Movement	Enroute to Delivery
EO	Movement	Enroute to Origin Airport
EP	Movement	Enroute to Pickup
FD	Movement	At FedEx Destination
HL	Movement	Hold at Location
HP	Movement	Ready for Recipient Pickup
IT	Movement	In Transit
IX	Movement	In transit (see Details)
LO	Movement	Left Origin
OC	Movement	Order Created
OD	Movement	Out for Delivery
OF	Movement	At FedEx origin facility
OW	Movement	On the way
OX	Movement	Shipment information sent to USPS
PD	Movement	Pickup Delay
PL	Status	Plane Landed
PM	Status	In Progress
PU	Status	Picked Up
PX	Status	Picked up (see Details)
RR	Status	CDO requested
RM	Status	CDO Modified
RC	Status	CDO Cancelled
RS	Status	Return to Shipper
RP	Status	Return label link emailed to return sender
LP	Status	Return label link cancelled by shipment originator
RG	Status	Return label link expiring soon
RD	Status	Return label link expired
SE	Status	Shipment Exception
SF	Status	At Sort Facility
SP	Status	Split Status
TR	Status	Transfer
CC	Regulatory	Cleared Customs
CD	Regulatory	Clearance Delay
CP	Regulatory	Clearance in Progress
CA_POS	Possession	Carrier
RC_POS	Possession	Recipient
SH	Possession	Shipper
CU	Possession	Customs
BR	Possession	Broker
TP	Possession	Transfer Partner

Now that you have learned about the FedEx Carrier API Settings, this completes the section of the user manual. It is recommended that you also read our article on Managing Orders with FedEx.