FedEx

Overview

The PB Shipping APIs integrate with FedEx® shipping services through the API operations listed on this page. FedEx shipments can originate from the U.S. and Canada. To print FedEx labels, a merchant must have an existing FedEx account.

This page contains the following:


Onboard a Merchant to Print FedEx Labels

To onboard a merchant to print FedEx labels through the Pitney Bowes Shipping APIs:

  • Enroll the merchant with your developer account using one of the Merchant Enrollment Models listed on the Merchant Accounts page.

  • Ensure the merchant has an existing account with FedEx.

  • Register the merchant’s FedEx account with the PB Shipping APIs, as described on the Add Carrier Accounts page.


API Operations for Shipping with FedEx

The PB Shipping APIs integrate with FedEx through the following operations:

Operation


Method

Endpoint


Add a 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}?carrier={carrier}&cancelInitiator=SHIPPER
 

Get Tracking Information

GET

/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber
 

Accounts APIs

——

See the Accounts APIs table on the Merchant Accounts page.
 


FedEx Services

The following tables list the services available for FedEx shipments.

U.S. Domestic Services

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

U.S. Domestic 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 Ground® Economy parcel select lightweight

SP_PRE_STD

FedEx Ground® Economy parcel select

SP_PRCLSEL

FedEx Ground® Economy Media

SP_MEDIA

FedEx Ground® Economy Bound Printed Matter

SP_PRE_PRINT

Canadian Domestic Services

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

Canadian Domestic 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 FedEx shipments from the U.S. or Canada to international destinations.

International 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


FedEx Special Services

This section lists the available special services for FedEx shipments. For descriptions of special services, see your FedEx documentation. Merchants are responsible for understanding the services they use and for adhering to service requirements. 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"
        } ]
    }
]

The following FedEx special services are available:

FedEx 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"
    } ]
}


FedEx 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


FedEx Labels

When printing a label, note the following:

  • 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.

FedEx shipments use the following label options:

Label Size


File Format


Content Type


DOC_4X6

PDF


ZPL2

URL


BASE64

DOC_8X11

PDF

URL


Sample FedEx Label

The following is a sample FedEx Express label:

Sample FedEx Label

Sample FedEx Commercial Invoice

The following is a sample FedEx Commercial Invoice:

Sample FedEx Commercial Invoice


FedEx 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

Trademark Notice

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