An update is scheduled to the FedEx Developer Portal on January 18, 2025, from 8:00PM to 10:00PM CST

and the portal will be unavailable during this time.

Fedex Logo
Developer Portal

Freight LTL API
DOWNLOAD JSON SCHEMA

Introduction

The Freight LTL API allows you to create shipments for less-than-truckload (LTL). LTL freight is too large to be shipped as a parcel but takes up less than an entire truck.

This allows you to get rate estimates, creates unique shipping labels for individual handling units and Bills of Lading (when required), schedule pickups and track statuses of the shipment, check availability of and schedule pickups. This results in increased efficiency for your larger, and heavier shipments.

LTL shipping at FedEx Freight offers handling unit-level tracking and visibility for your multiple-handling unit shipments as well as domestic shipping without a paper Bill of Lading (BOL) in most instances. A Bill of Lading can be created when required. Even though all handling units have a unique tracking number, the shipment moves on one Bill of Lading, Delivery Receipt, and Invoice Statement.

Freight LTL API Details

The Freight LTL API enables LTL shipping and creates necessary documents such as Bill of Lading (when requested), FedEx Freight shipping labels, and various other shipping documents. In the Freight LTL Shipment master label goes on the first handling unit and the child label that is applied to the second and subsequent handling units. The child labels have their own unique tracking number, but refers to the master tracking number. A single Bill of Lading per shipment can be created consists of all handling units and pieces.

Each handling unit can be associated with a tracking number and the label is similar to a FedEx Ground or Express Parcel label with the exception of an F, which represents a Freight shipment.

Maximums for handling units and pieces per handling Units:

  • The maximum pieces per handling unit limit – 9,999
  • Maximum handling unit – 200 (when printing Handling Unit Labels one at a time).
  • Maximum handling unit – 40 (when printing Handling Unit Labels at once) 

FedEx LTL Freight shipments are available to all 50 states as well as Puerto Rico, USVI, Canada and Mexico. Some shipments require a Bill of Lading in addition to shipping labels. An example of these shipments are ones containing hazardous materials.

FedEx Freight® is changing the LTL industry by making it easy to ship freight fast and economical within one streamlined LTL network.

Following are the features available with this API:

  • Manage Freight LTL Pickup

    This feature allows to get the freight LTL pickup locations, schedule a freight Pickup and cancel any already scheduled Pickup.

  • Get Freight LTL Rate Quotes

    This feature allows to get the rate quotes for a freight LTL shipment based on the locations and service options selected.

  • Ship Freight LTL Shipment

    This feature allows to create a freight LTL shipment.

The following are the features of the Freight LTL API:

  • Ship a single piece or MPS shipment for all service types thereby generating shipping label(s) or a Bill of Lading (if required).
  • Create a multi-handling unit shipment and track each handling unit individually.
  • Create LTL shipments for using FedEx Freight Priority and Freight Economy services.
    • Provide the recipient information such as account number, contact, and address.
    • Provide timestamp, packaging type, total weight and various other required details mentioned in the endpoint schema.
  • Provide FedEx Label with standard branding and support specified sizes for thermal labels.
  • Receive notifications via email or SMS text during the shipping transaction such as:
    • Shipping notification
    • Estimated delivery
    • Pickup notification
  • Generate Shipping Documents such as:
    • Individual Handling Unit Shipping Labels
    • Bill of Lading
    • Commercial Invoice
    • Canadian Customs Invoice
  • Create shipments and print labels one handling unit at a time or process all handling units at once.
  • Retrieve rates of a single piece or MPS shipment for all service types.
  • Check availability for pickup, schedule a freight pick up and cancel pick up.
  • Create and Schedule pickup with third party accounts for an alternate billing address.

Freight C.O.D: End of Support

Carrier does not provide C.O.D (Collect on Delivery) service to Customers. Carrier will not be liable for collection of C.O.D. amount as this is not a service provided by Carrier. All storage, reconsignment and freight charges will apply to shipments marked C.O.D.

Freight LTL Shipping Services

The following Freight LTL shipping services are available:

FedEx Freight® Priority

With industry-leading on-time performance and fast transit times, FedEx Freight® Priority delivers your shipments quickly and reliably. Count on our regional service for extensive next-day and second-day delivery to your customers, all backed by a no-fee money-back guarantee. *

FedEx Freight® Priority service features:

  • Fast transit times with next-day service up to 600 miles and second-day service up to 1,600 miles
  • Direct delivery to virtually every ZIP code in the U.S., Canada and Mexico.
  • Consistent, on-time reliability
  • A no-fee money-back guarantee*
  • State-of-the art information technology with end-to-end shipment visibility
  • A dedicated team of professionals to assist with all your regional freight needs

*All services are subject to the terms and conditions of the FXFR 100 Series Rules Tariff.

FedEx Freight Economy

FedEx Freight® Economy provides economical LTL (less-than-truckload) delivery, focused on your basic freight shipping needs. With FedEx LTL delivery services, with the on-time reliability, and careful handling customer service is well attained.

FedEx Freight® Economy delivers:

  • Economical freight solutions
  • Increased savings for shipments that are less time-sensitive, yet need reliable delivery
  • Consistent, on-time reliability
  • Direct delivery to virtually every ZIP code in the U.S., Canada, Mexico and Puerto Rico.
  • State-of-the art information technology with end-to-end shipment visibility
  • Improved visibility with end-to-end shipment tracking

FedEx International Deferred Freight (FDF)

FedEx International Deferred Freight (FDF) is a global air freight shipping service for shipping international air freight shipments with extended delivery/transit times at economical rates. FDF is also available for Airport-to-Airport, Door-to-Airport, Airport-to-Door, and Door-to-Door delivery services

Note:

  • Currently, this service is only available for selected country to country lanes.
  • Dangerous Goods (DG) and Restricted Commodities are not allowed. Example: Dry Ice, lithium ion batteries. Please reach out to FedEx customer support for more information.
  • U.S. domestic shipments and non-U.S. domestic shipments are not allowed.

How Freight LTL API works

This section describes the endpoints and key elements required for FedEx Freight LTL API.

Note: Your FedEx Freight LTL account must be enabled to use the FedEx Freight LTL API. The key information required are the FedEx Freight account number(s) and the correct mailing address of the account to process the LTL shipments.

The following are the endpoints available with this API:

Ship Freight LTL

Use this endpoint for validating and creating the FedEx freight LTL shipment.

The required input information associated with this request are:

  • Freight Account Number
  • Mailing address of the account
  • Freight Requested Shipment
  • Label Response Options – Labels to be returned as encoded or as URL.
  • Master Tracking details – Only in case, the MPS shipment has to process and labels must be printed one at a time and not all at once (when element singleShotMPS is not provided or added with value false).

Successful response to this request creates LTL Shipment, provides Tracking details and alert details in the response. It also returns errors and the descriptions in case of any failures.

Note: The mailing address may be different than the actual shipping address.

Check Freight LTL Pickup Availability

Use this endpoint to request a list of all available freight pickup locations with the pickup schedule details, such as the carrier, latest available time of pickup, default latest available time, availability for pickup, time when the package is ready to be picked up, indication if the address is residential, cutoff time of the pickup, and driver's access to pick up the package.

The required input information associated with this request are:

  • Pickup address/postal details.
  • Pickup request type (ex: same day/future day).
  • Whether or not domestic/international pickup.

Note: Use correct and valid pickup address. 

Successful response to this request will provide list of all available freight pickup locations, delivery day, availability (flag), Pick up date, cut off time, access time, residential availability (flag), close time (flag), close time, and local time in the response. It also returns errors and the descriptions in case of any failures.

Create Freight LTL Pickup

Use this endpoint to create and schedule a freight LTL pickup.

The required input information associated with this request are:

  • Freight Account Number, which will be invoiced for the pickup.
  • Origin details (address, location and pickup address type such as account/shipper/other).
  • Address details for the associated account.

The successful pickup request will return a pickup confirmation number, pickup notification and location code for the pickup being scheduled. It also returns errors and the descriptions in case of any failures.

Note: Use correct and valid address for pickup and also provide correct account address of record to schedule the pickup. Past ready time or past date or a date which is too far in the future should not be entered to schedule a pickup. Anonymous pickups are not allowed. You can schedule pickup for third party accounts by providing alternate valid address details.

Cancel Freight LTL Pickup

Use this endpoint to cancel an already scheduled pickup request for an LTL package. The successful pickup cancellation will return a confirmation number and a pickup cancellation confirmation message.

The required input information associated with this request are:

  • Pickup Confirmation Code (obtained while submitting a pickup request)
  • Scheduled Date (Date the pickup dispatch occurs)
  • Location (FedEx Express location responsible for processing the pickup request)

The successful request will return a pickup confirmation number, pickup notification and location code for the pickup being scheduled. It also returns errors and the descriptions in case of any failures.

Note: Submit the pickup confirmation number and the corresponding location code (only applies to FDXE) to cancel the pickup that was scheduled. Pickup confirmation number and the corresponding location code (only applies to FDXE) information are obtained while submitting a pickup request. Also use correct account address of record to cancel the pickup. A failure notification will be sent if you attempt to cancel a pickup after the FedEx courier has been dispatched to the pickup location

Rate Freight LTL

Use this endpoint to request list of all possible Freight rates quotes and optional transit information based on input details. Rates retrieved are based on the origin, destination and various other inputs in the shipment. Additional information such as carrier code, service type, or service option can be used to get more accurate results.

The required input information associated with this request are:

  • Freight Account Number
  • Freight Requested Shipment.

The successful response to this request will return list of all possible rates and location code for the pickup being scheduled. It also returns errors and the descriptions in case of any failures.

Freight LTL Multi-piece Shipment (MPS)

A multiple-piece shipment (MPS) consists of two or more handling units shipped to the same recipient addresses. The first handling unit in the shipment request is considered the master.

To create a multiple-piece shipment:

  • Include the shipment level information such as serviceType, packagingType, totalWeight, totalPackageCount, freightShipmentDetail and requestedPackageLineItems details. [Note: The sequenceNumber for master package must be equal to 1.]
  • For printing label per handling unit, include Master tracking details in element masterTrackingId for all subsequent handling units.

Following are the Multiple-Piece Shipping Processing options available with this API:

Print Handling Unit Label One at a Time

This API allows you to process MPS shipments and get labels one at a time.

When you need this capability for your shipments, along with all necessary MPS elements, provide element oneLabelAtATime as true in the request.

The output of the first request should generate label and tracking number which is master tracking number. Provide this master tracking number in the element masterTrackingId to process subsequent ship request and generate labels with tracking numbers (child tracking numbers) for the defined total package count (totalPackageCount).

Note: The maximum handling units allowed is 200.

Print all Handling Unit labels at Once

This API allows you to process MPS shipments and get labels in one shot. This is one of the ideal processing method, which is used when a shipment has either 40 or less handling units (totalPackageCount<=40) destined to the same recipient address in the shipment.

Set oneLabelAtATime as false in the Shipment request with 40 or less handling units and generate the labels instantaneously.

Note: The maximum handling unit limit 40 is indicative and is not a fixed limit. The limit is also dependent on the combination of number of handling units and the commodities. Contact your FedEx executive for more information on this.

Example: Your shipment request consists of 10 handling units, when submitted will generate 10 labels and either label URLs or encoded labels as requested is provided in the response.

FedEx Freight Direct

This service provides a superior customer experience for delivery of large and palletized goods, including delivery of heavy, bulky shipments inside customers' homes or businesses.

The service offers options like proactive communications, flexible delivery options and bundled pricing that includes several surcharges.

The following are some of the features included in this service:

  • Enables creation of FedEx Freight Direct basic, basic by appointment, standard and premium delivery shipments and basic return shipments/pickups within the continental United States, Alaska, and Hawaii.
  • Includes the ability to obtain a complete rate estimate for a FedEx Freight Direct shipment using a FedEx Freight Direct account number and the ability to cancel a FedEx Freight Direct pickup.
    • Rate estimates will not be returned for Alaska and Hawaii. Customers should call FedEx customer service to request a quote for these states.
    • To cancel pickup scheduled for the same day, customer has to call FedEx customer service.
  • Enables you to send email notifications to the original shipper/consignee so customer can:
    • Schedule a delivery
    • Receive delivery and/or pickup confirmation
    • Receive out for delivery and/or pickup notification
    • Receive en-route notifications
    • Customer survey for delivered shipments
  • The business rules of zip code validation, dimensions, piece weight and handling unit weight will be applicable to FedEx Freight Direct to determine the correct combination of line haul and first/last miles services.

The FedEx Freight Direct offers different service types to choose from.

This API offers following features with the Freight Direct service:

Get Freight Direct Rates

Use this endpoint to get Freight Direct Rates and surcharges for the following special Freight Direct service options: Basic Service, Basic Service by appt., Standard Service, Premium Service.

Following are the required details to be accompanied with the Rate request using endpoint Rate Freight LTL:

  • Freight Direct Type (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
  • Freight Direct Transportation Type (DELIVERY, PICKUP)
  • Phone Number Type if phone number is provided (HOME, MOBILE, WORK)
  • Weight
  • Dimensions (Non-Negative Length, Width and Height)

Create Freight Direct Shipment

Use this endpoint to ship a single piece or MPS shipment for the following special Freight Direct service options: Basic Service, Basic Service by appt., Standard Service, Premium Service, and get a shipping label or BOL, including the required documentation for processing a Freight Priority shipments.

Following are the required details to be accompanied with the shipment request via endpoint Ship Freight LTL:

  • Freight Direct Type (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
  • Freight Direct Transportation Type (DELIVERY, PICKUP)
  • Email Address, Phone Number and Phone Type
  • Weight
  • Dimensions (Non-Negative Length, Width and Height)

The output BOL will have the new Freight Direct service names printed. The following are the values printed on BOL depending on the service selection:

  • DIRECT BASIC DELIVERY
  • DIRECT BASIC BY APPOINTMENT DELIVERY
  • DIRECT PREMIUM DELIVERY
  • DIRECT STANDARD DELIVERY
  • DIRECT BASIC PICKUP
  • DIRECT BASIC BY APPOINTMENT PICKUP
  • DIRECT PREMIUM PICKUP
  • DIRECT STANDARD PICKUP

Freight Direct Pickup

Use this endpoint to check the availability of Freight LTL Freight Direct pickup service, create a pickup request for package to be picked up or cancel an existing pickup requested.

Following are the required details to be accompanied with the Pickup request using endpoint Check Freight LTL Pickup Availability, Create Freight LTL Pickup, and Cancel Freight LTL Pickup.

  • Freight Direct Type (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
  • Freight Direct Transportation Type (DELIVERY, PICKUP)
  • Email Address (Creating Pickup Request)
  • Phone Number and Phone Type (Creating Pickup Request)
  • Weight

Business Rules

  • A master tracking (Pro) number is assigned to a Freight LTL shipment’s first handling unit and child tracking numbers are assigned to each subsequent handling unit.
  • Each handling unit in the shipment can be tracked individually or as part of the entire shipment.
  • Other documents may apply to specific shipments (e.g., Freight Hazardous Materials [HazMat] and international shipments).
  • LTL Freight only and Bill to LTL Freight accounts cannot be added to the FedEx Developer portal.
  • Customer can use either the long term single LTL account number or FedEx Freight Direct account number to use Freight Direct services.
  • FedEx Freight Direct rating capabilities are only available in regular LTL API.
  • All the new errors/messaging will be in English only.
  • Email address and phone are required as part of FedEx Freight Direct service option request while creating shipments.
Documentation Powered by ReDoc

Freight LTL API (1.0.0)

Rate Freight LTL

This endpoint providess the ability to retrieve rate quotes and optionall transitt informationnnn. The rate is calculated based on the origin and destination of the shipment. Additional information such as carrier code, service type, or service option can be used to filter the results. Applicable operating company is FedEx Freight.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema
  • MinimumSamplePayload
accountNumber
required
object (LTLRootAccountNumber)

This is the Account number details.
Note:

  • In case if this is shipping account number, do use the account number used for creating Auth Token.

rateRequestControlParameters
object (LTLRateRequestControlParameters)

These are various parameters you can provide for filtering and sorting capability in the response, such as transit time and commit data, rate sort order etc.

freightRequestedShipment
required
object (LTLRequestedShipment)

This contains shipment data describing the shipment for which a freight rate quote (or rate-shopping comparison) is desired.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /rate/v1/freight/rates/quotes

Sandbox Server

https://apis-sandbox.fedex.com/rate/v1/freight/rates/quotes

Production Server

https://apis.fedex.com/rate/v1/freight/rates/quotes

Request samples - Rate Freight LTL

Content type
application/json
Example
FullSchema
Copy
 Expand all Collapse all
{
  • "accountNumber":
    {
    },
  • "rateRequestControlParameters":
    {
    },
  • "freightRequestedShipment":
    {
    }
}

Response samples - Rate Freight LTL

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Ship Freight LTL

This endpoint helps you to create a Freight LTL Shipment request with the required Freight LTL Shipment information, and to retrieve information for an already in process shipment. It also allows you to confirm and validate your shipment.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-FreightShipment
  • FreightShipment_ShipTo_Freight_Account
  • FreightShipment_BillTo_Freight_Account
  • FreightShipment_International_SingleShot_MPS_ShipTo_Freight_Account
  • FreightShipment_OneLabelAtATime_MPS_Master_ShipTo_Freight_Account
  • FreightShipment_OneLabelAtATime_MPS_Child_ShipTo_Freight_Account
freightRequestedShipment
required
object (FreightRequestedShipment_Freight2020)

The descriptive data for the FreightShipment being tendered to FedEx.

labelResponseOptions
required
string
Enum: "URL_ONLY" "LABEL"

If the value is LABEL, the encoded label will be included in the response and if the value is URL_ONLY, the response will include the URLs.

Note: With URL_ONLY option, the URL once created will be active for 24 hours.

accountNumber
required
object (ShipperAccountNumber)

The account number associated with the shipment.

oneLabelAtATime
boolean

If the value is false, it uses single shot MPS shipments where in all the packages are processed in the same transaction and can generate number of labels for the handling units all at once. If the value is true, the MPS shipment processes packages and labels one at a time. Default value is false.
Example: true or false

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/freight/shipments

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/freight/shipments

Production Server

https://apis.fedex.com/ship/v1/freight/shipments

Request samples - Ship Freight LTL

Content type
application/json
Example
FullSchema-FreightShipment
Copy
 Expand all Collapse all
{
  • "freightRequestedShipment":
    {
    },
  • "labelResponseOptions": "LABEL",
  • "accountNumber":
    {
    },
  • "oneLabelAtATime": true
}

Response samples - Ship Freight LTL

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b55xxxxx492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Check Freight LTL Pickup Availability

This endpoint allows you to check the availability of an Freight LTL pickup service. The pickup availability depends on two factors, the cut off time and the access time.

Cut off time - The latest time allowed for a pickup to be scheduled. The time is local to the pickup postal code.

Access time - The time between the pickup ready time (when the package is ready to be picked) and the time when the driver is ready to pick up the package.

Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-FreightPickupAvailability
  • MinimumSamplePayload-FreightPickupAvailability
pickupAddress
required
object (PickupAddress)

The address for which pickup availability inquiry is made.

packageReadyTime
string

The time that the package will be ready for pickup. The time format is HH:MM:SS and it refers to the local timezone. The driver should pick up the package/shipment by the given pickup time.

customerCloseTime
string

The latest time the driver gets access to pick up the package. The time format is in HH:MM:SS and it refers to the local timezone. The driver should pick up the package by the given pickup time.

shipmentAttributes
object (ShipmentAttributes)

Indicates the shipment details such as service type, packaging type, weight and dimensions.

freightPickupSpecialServiceDetail
object (FullSchemaFreightPickupAvailability_freightPickupSpecialServiceDetail)
dispatchDate
string

Indicates the date, the package is to be picked up. The format is YYYY-MM-DD. If the field is left blank, the system considers current date as dispatch date.

numberOfBusinessDays
integer <int32>

Number of business days to consider when checking availability.
For example if you are indicating pickupDate as Saturday and you indicate 3, Saturday, Sunday and Monday will be considered.
Example: 3

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/freight/pickups/availabilities

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/availabilities

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/availabilities

Request samples - Check Freight LTL Pickup Availability

Content type
application/json
Example
FullSchema-FreightPickupAvailability
Copy
 Expand all Collapse all
{
  • "pickupAddress":
    {
    },
  • "packageReadyTime": "15:30:00",
  • "customerCloseTime": "18:00:00",
  • "shipmentAttributes":
    {
    },
  • "freightPickupSpecialServiceDetail":
    {
    },
  • "dispatchDate": "2019-10-14",
  • "numberOfBusinessDays": 1
}

Response samples - Check Freight LTL Pickup Availability

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Create Freight LTL Pickup

This endpoint helps you to create a freight pickup request for a package to be picked up.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-CreatePickup
  • MinimumSamplePayload-CreateFreightPickup
  • MinimumSamplePayload-FreightBillToPickup
associatedAccountNumber
required
object

The associated account number, which is invoiced for the freight pickup.

originDetail
required
object

The origin address if different than the one associated with the shipper account. This element value is required when the package is to be picked up from an address other than the shipper account address.

totalWeight
Array of objects (TotalWeight)

The total weight of the packages for the pickup. Unit of measure is LB and KG.

packageCount
integer <int32>

The total number of packages for the pickup.
Example: 5

remarks
string

This is a placeholder for any message to be passed to the FedEx pickup. courier.
Example: Please ring bell at loading dock.

countryRelationships
string
Enum: "DOMESTIC" "INTERNATIONAL"

Describes the country relationship among the shipments being picked up.
'DOMESTIC' indicates intra-country shipping; origin and destination country are the same.
'INTERNATIONAL' indicates inter-country shipping; origin and destination countries are different.
Not applicable for FedEx Ground shipments
Example: DOMESTIC

trackingNumber
string

This is a tracking number for FedEx packages used for tracking a single package or group of packages.
Example: XXXX0365XXXX

commodityDescription
string

Description of the commodity being shipped.
Example:This field contains CommodityDescription

freightPickupDetail
required
object

This provides the Freight LTL pickup detailed information.

oversizePackageCount
integer <int32>

The number of oversize packages that are tendered to FedEx Ground.

pickupNotificationDetail
object

This object allows user to request for pickup confirmation email. User can specify upto 5 email addresses.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/freight/pickups/

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/

Request samples - Create Freight LTL Pickup

Content type
application/json
Example
FullSchema-CreatePickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "originDetail":
    {
    },
  • "totalWeight":
    [
    ],
  • "packageCount": 5,
  • "remarks": "Please ring bell at loading dock.",
  • "countryRelationships": "DOMESTIC",
  • "trackingNumber": "795803657326",
  • "commodityDescription": "This field contains CommodityDescription",
  • "freightPickupDetail":
    {
    },
  • "oversizePackageCount": 2,
  • "pickupNotificationDetail":
    {
    }
}

Response samples - Create Freight LTL Pickup

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Cancel Freight LTL Pickup

Use this endpoint to cancel the already scheduled freight pickup request. Note a failure notification will be sent if you attempt to cancel a pickup after the FedEx courier has been dispatched to the pickup location.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-CancelFreightPickup
  • MinimumSamplePayload-FreightCancel
associatedAccountNumber
required
object (AccountNumber_2)

Specify the FedEx Account number.
Example: Your account number

pickupConfirmationCode
required
string

The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested.
Example: XXXX1007MEM62XXXX.

remarks
string

Specify the additional information to be passed on the pickup courier.

reason
required
string

Specify the reason for cancellation of pickup.

contactName
required
string

Specify the contact name.

scheduledDate
string

Specifies the date when pickup dispatch occurs.
Format YYYY-MM-DD
Example: 2019-10-15

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /pickup/v1/freight/pickups/cancel/

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/cancel/

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/cancel/

Request samples - Cancel Freight LTL Pickup

Content type
application/json
Example
FullSchema-CancelFreightPickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "pickupConfirmationCode": "20201007MEM628005",
  • "remarks": "This is my remarks",
  • "reason": "This is my reason",
  • "contactName": "This is my contactName",
  • "scheduledDate": "2019-10-15"
}

Response samples - Cancel Freight LTL Pickup

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}
CLOSE

Response

Copy