FedEx

Overview

The PB Shipping APIs provide integration with FedEx® shipping services. Shipments can originate from the U.S. and Canada. To print FedEx labels, a merchant must have an existing FedEx account.

This page describes how to register a merchant’s existing FedEx account for use with the PB Shipping APIs and lists the supported API operations, services, parcel types, and label sizes.

Onboarding a Merchant to use FedEx

To print FedEx labels through the Pitney Bowes Shipping APIs:

  • The merchant must be enrolled with your developer account. For more information, see Merchant Enrollment Models.
  • The merchant must have an existing account with FedEx.
  • The merchant must register the FedEx account for use with the PB Shipping APIs, as described in Carrier Account Registration.

Shipping Operations

The following shipping operations can be used with FedEx.

Operation
Method Endpoint

Register an Existing Carrier Account

POST

/v1/developers/{developerId}/merchants/{postalReportingNumber}/carrier-accounts/register?carrier={carrier}
 

Rate a Parcel

POST

/v1/rates
 

Create a FedEx Label

POST

/v1/shipments
 

Reprint a Label

GET

/v1/shipments/{shipmentId}?carrier=FEDEX
 

Retry a Label

GET

/v1/shipments?originalTransactionId={transaction_id}&carrier=FEDEX
 

Void a Label

DELETE

/v1/shipments/{shipmentId}
 

Get Tracking Information

GET

/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber&carrier=FedEx
 

Services

U.S. Domestic Services

The following are the supported domestic services for shipments within the U.S.

Service
ID
FedEx First Overnight® NDA_AM
FedEx Priority Overnight® NDA
FedEx Standard Overnight® NDA_SVR
FedEx 2Day® A.M. 2DA_AM
FedEx 2Day® 2DA
FedEx Express Saver® 3DA
FedEx Ground® GRD
FedEx Home Delivery® HOM
FedEx First Overnight® Freight NDA_AM_FREIGHT
FedEx 1Day® Freight NDA_FREIGHT
FedEx 2Day® Freight 2DA_FREIGHT
FedEx 3Day® Freight 3DA_FREIGHT
FedEx SmartPost parcel select lightweight SP_PRE_STD
FedEx SmartPost parcel select SP_PRCLSEL
FedEx SmartPost® Media SP_MEDIA
FedEx SmartPost® Bound Printed Matter SP_PRE_PRINT

Canadian Domestic Services

The following are the supported domestic services for shipments within Canada.

Service
ID
FedEx First Overnight® NDA_AM
FedEx Priority Overnight® NDA
FedEx Standard Overnight® NDA_SVR
FedEx 2Day® 2DA
FedEx Economy® 3DA
FedEx Ground® GRD

International Services

The following are the supported services for shipments from the U.S. or Canada to international destinations.

Service
ID
FedEx International First® XPP
FedEx International Priority® EXP
FedEx International Economy® XPD
FedEx International Ground® STD
FedEx International Priority® Freight EXP_FREIGHT
FedEx International Economy® Freight XPD_FREIGHT


Special Services

This section lists the available special services for FedEx shipments. For descriptions of special services, see your FedEx documentation. Shippers are responsible for understanding the special services they use and for adhering to requirements.

When creating a shipment, set special services in the rates object’s specialServices array. Each object in the array takes a specialServiceId and, if required, inputParameters. The following example shows two special services, the second of which takes input parameters:

"specialServices": [
    {
        "specialServiceId": "ADD_HDL"
    },
    {
        "specialServiceId": "COD",
        "inputParameters": [ {
            "name": "INPUT_VALUE",
            "value": "50"
        } ]
    }
]
Special Service
specialServiceId inputParameters
Ancillary Endorsements ANCILLARY_ENDORSEMENT
  • "name": "ENDORSEMENT_TYPE"
    "value": Enter one of the following:
    • "CHANGE_SERVICE" - Change Correction Request
    • "ADD_CORR" - Address Correction Request
    • "FWD_SERVICE" - Forwarding Correction Request
    • "RET_SERVICE" - Return Service Request
Additional Handling/Non Standard Container ADD_HDL Does not take input parameters
Adult Signature Required ADULT_SIG Does not take input parameters
Alcohol ALCOHOL
  • "name": "CONSUMER_TYPE"
    "value": Enter one of the following:
    • "Licensee"
    • "Consumer"
Carrier Leave If No Response CARRIER_LEAVE_IF_NO_RES Does not take input parameters
Declared Value INS
  • "name": "INPUT_VALUE"
    "value": Enter the declared value.
Direct Signature Required DIRECT_SIG Does not take input parameters
Dry Ice (non-Hazardous Material) DRY_ICE
  • "name": "WEIGHT_UOM"
    "value": Enter "LBS" or "KGS"
  • "name": WEIGHT
    "value": Enter the weight of the dry ice. The weight must be less than the package weight.
FedEx Appointment Home Delivery® APPOINTMENT
  • "name": "PHONE_NUMBER"
    "value": Enter a valid 10- to 15-digit phone number, including area code and optional extension.
FedEx Collect on Delivery (C.O.D.) COD
  • "name": "INPUT_VALUE"
    "value": Enter the COD amount.
  • "name": COD_TYPE
    "value": Enter one of the following:
    • "Guaranteed Funds"
    • "Any Funds"
FedEx Date Certain Home Delivery® DATE
  • "name": "PHONE_NUMBER"
    "value": Enter a valid 10- to 15-digit phone number, including area code and optional extension.
  • "name": "DATE"
    "value": Enter the date in the following format: YYYY-MM-DD
FedEx Evening Home Delivery® EVENING Does not take input parameters
FedEx Ground® C.O.D. GCOD
  • "name": "INPUT_VALUE"
    "value": Enter the COD amount.
  • "name": "COD_TYPE"
    "value": Enter one of the following:
    • "Guaranteed Funds"
    • "Any Funds"
FedEx Priority Alert® PAL
  • "name": "PKG_DESCRIPTION"
    "value": Enter the package description.
FedEx Priority Alert Plus™ PAL_PLUS
  • "name": "PKG_DESCRIPTION"
    "value": Enter the package description.
FedEx Saturday Service - Delivery SAT_DELIVERY Does not take input parameters
FedEx Saturday Service - Pickup SAT_PICKUP Does not take input parameters
Hold at Location HOLD
  • "name": "FEDEX_LOCATION_ID"
    "value": Enter a valid FedEx location.
  • "name": CONTACT_NUMBER
    "value": Enter a valid 10-digit phone number, including area code.

For an example, see Hold at Location Example.

Indirect Signature Required SIG Does not take input parameters
No Signature Required (Signature Release) NO_SIG
  • "name": "SIGNATURE_RELEASE_NUMBER"
    "value": Enter the signature release number provided by FedEx.
Print Return Label PRL
  • "name": "RMA_NUMBER"
    "value": Enter an RMA (Return Materials Authorization) number.

Hold at Location Example

The following is an example object for the Hold at Location special service. The object is passed in the specialServices array.

{
    "specialServiceId": "HOLD",
    "inputParameters": [ {
        "name": "FEDEX_LOCATION_ID",
        "value": "HC986"
    },{
        "name": "CONTACT_NUMBER",
        "value": "2035550000"
    } ]
}


Surcharges

The following surcharges can apply to FedEx shipments. Surcharges are returned in the response’s rates.surcharges array.

  • Additional Handling/Non Standard Container
  • Delivery Area Surcharge (see below)
  • Oversize
  • Residential Delivery
  • Minimum Billable Weight for FedEx Express Packaging
  • Third Party Billing Surcharge


Parcel Types

The following are the supported parcel types for FedEx.

Parcel Type
ID
FedEx Envelope LTR
FedEx Pak PACK
FedEx Box BOX
FedEx Small Box SMALL_EXP_BOX
FedEx Medium Box MED_EXP_BOX
FedEx Large Box LG_EXP_BOX
FedEx Extra Large Box EXTRA_LG_EXP_BOX
FedEx Tube TUBE
FedEx 25 KG Box 25KG
FedEx 10 KG Box 10KG
Customer Package PKG


Labels

Please read the following considerations before printing a FedEx label:

  • The label size, as specified in the documents.size field, uses an upper-case X. Using a lower-case x will result in an error.
  • Labels retrieved through URLs are available for 24 hours after label creation.

The following table describes label options. Set label options in the Documents Object.

Label Options
Label Size
(size)
File Format
(fileFormat)
Content Type
(contentType)
Destination
DOC_4X6 PDF URL U.S.
DOC_8X11 PDF URL U.S.
Puerto Rico,
International


Sample FedEx Label

The following is a sample FedEx Express label:

Sample FedEx Label