Consolidation API

The Consolidation API enables you to consolidate a collection of individual shipments for customs clearance at a single entry and after the custom clearance, the shipment is broken into smaller shipments within the destination country to distribute to individual recipients. This API is beneficial for shippers who wish to consolidate their FedEx Express^® and Ground^® international shipments.
The Consolidation Ground Shipment is specific to Canadian shipments and allows qualified U.S. shippers to consolidate FedEx Ground shipments for distribution within Canada via FedEx Logistics^® or a broker of your choice. Once the shipment clears Canadian customs as a single shipment, it is divided into individual smaller shipments in Canada. You will have access to the full range of FedEx services after your shipment has cleared customs.

Note:

• The account number should be enabled for Consolidation API services to perform any API transactions.
• The Consolidations and Consolidation shipments will be purged if they are not confirmed within the end of fifth day from the Consolidations creation.

Consolidation API offers to clear destination Customs as a single shipment. The entire shipment is consigned to (and entry is made) in the name of only one importer of record (IOR). The shipment must also come from a single exporter of record. Individual pieces within the shipment are delivered to the recipient indicated on each FedEx Express Shipping or Express Manifest label.
Consolidation shipment also offers Single Point of Clearance (SPOC), which permits you to send a consolidated shipment that includes packages to multiple countries in the European Union.
International Priority Freight (IPF) standards and restrictions for size, weight, and commodity types apply to individual packages in a Freight consolidation.
Note: You must have a service contract on file with FedEx before you can process your consolidation shipments. For more information, contact your FedEx account executives.

Consolidation API enables customers to use Direct Distribution when shipping more than 1 package internationally, with the condition that the destination country for all those packages is the same.
Direct Distribution service will improve delivery times, reduce clearance fees, and lower warehouse costs with for shippers. FedEx will consolidate customer's shipments traveling to the same location (foreign country) for customs clearance then deconsolidate them for direct delivery to your customers.
Customers can now also send shipments from Canada to U.S. through the International DirectDistribution (IDD) (formerly Transborder Distribution service). FedEx International DirectDistribution Surface Solutions (IDD Surface) provide customers from Canada and Mexico with a consolidated, cross-border delivery option to ship to multiple recipients in the U.S. International DirectDistribution (IDD) must be based in Canada or Mexico and a drop-off location ID must be setup for the specified account.

The consolidated commercial invoice (CCI) shipment detail reports, represent one of the minimum required Customs reports needed for the consolidated shipment to successfully cross the international border into the destination country.

CCI Shipment Details provides the following information:

• The CCI Shipment Detail report provides the shipment information for all Broker Entry Packages in the consolidation and groups/lists them by “Buyer” (i.e. “Sold to” party).
  Note: Child shipments are listed in the CCI under one of the following conditions:
  
  • Child shipments that do not qualify for Section 321 are listed in the CCI for Customs entry by the designated Broker.
  • The shipper specifies that all Child shipments in the consolidation are to be submitted for entry by the Broker.

The IDD Linehaul Report provides the following information:

• Which Buyers and associated shipments qualify for Section 321, and which qualify for PAPS.
• The drop off location and address.
• Third Party Drop off Location or facility information.

Note: This report is also known as Consolidated Customs Linehaul Report and is generated for US inbound shipments from either Canada or Mexico.

International DirectDistribution Services – FedEx Express and FedEx Ground Services table lists the FedEx U.S. services available to International DirectDistribution Service shipments after they enter the U.S.

FedEx Express Services - International Priority DirectDistribution (IPD)

FedEx Ground Services - International DirectDistribution (IDD) Surface Solutions

Following are the shipment services available for Consolidation API.

FedEx Express International DirectDistribution Services

• International Priority DirectDistribution (IPD) and International Economy DirectDistribution Service (IED) provides consolidated FedEx Express^® shipments clearing customs at a single entry, then deliver to individual recipients in the destination country. These are contract-only services.
• International DirectDistribution (IDD) service allows consolidated cross-border shipments from Canada and Mexico to several recipients in United States.

FedEx Express International DirectDistribution Freight Service

• You can consolidate and ship multiple-piece freight shipments (exceeding 150 pounds/68 kilograms) using FedEx International Priority DirectDistribution Freight (IDF). All pieces must be skidded to ship IDF. International Priority DirectDistribution Freight (IDF) allows using one FedEx^® International Air Waybill to consolidate shipments from a single origin location to several recipients in one destination country. After your shipment enters the U.S., the shipment can be managed by FedEx U.S. services, including FedEx Express, FedEx Ground and FedEx Home Delivery.

Consolidation shipments can be processed in two ways – synchronously and asynchronously depending on the number of packages per shipment or package level commodities in a shipment.
For synchronous processing, a transaction should have less than 40 child packages per consolidation only.
If the transaction is synchronously processed, the reply will have the package labels and shipment reports such as CI.
If the transaction is asynchronously processed, the reply only confirms that the request is queued successfully for asynchronous processing. The shipment itself might not be successfully processed and so the corresponding Consolidation Shipment Results method will have to be used to check if the shipments were processed successfully. Please give some time for the shipments to be processed successfully before you retrieve the results.

The following steps can be followed to process the shipment asynchronously –

1. Create Consolidation: Use this endpoint to create a new consolidation with a unique index. The successful response will generate a consolidation tracking number.
   Note: If the index is not provided in the request then the tracking number will be considered as the index.
2. Create Consolidation Shipment: Use this endpoint to create a asynchronous shipment for more than 40 packages. The successful response will generate a consolidation shipment jobID.
3. Consolidation Shipment Results: Use this endpoint with the generated jobID to get the shipment tracking number and labels.
4. Confirm Consolidation: Use this endpoint with the consolidation type and the generated Index to confirm your created consolidation. The successful response will generate a jobID
5. Confirm Consolidation Results: Use this endpoint with the generated jobID from Confirm Consolidation to get the tracking numbers, labels and paperworks for your consolidation.

The following steps can be followed to process the shipment synchronously –

1. Create Consolidation: Use this endpoint to create a new consolidation with a unique index. The successful response will generate a consolidation tracking number.
   Note: If the index is not provided in the request then the tracking number will be considered as the index.
2. Create Consolidation Shipment: Use this endpoint to create a synchronous shipment with less then or equal to 40 packages. The successful response will generate the consolidation shipment tracking numbers and labels.
3. Confirm Consolidation: Use this endpoint with the consolidation type and the generated Index to confirm your created consolidation. The successful response will generate a jobID
4. Confirm Consolidation Results: Use this endpoint with the generated jobID from Confirm Consolidation to get the tracking numbers, labels and paperworks for your consolidation.

The following steps can be followed to modify or delete any created consolidation or consolidation shipment –

• Modify Consolidations: Use this endpoint to modify information of an existing Consolidation request before the consolidation is confirmed.
• Delete Consolidation Shipment: Use this endpoint to cancel FedEx Express, Express Freight and Ground shipments which have not been tendered to FedEx. The successful reponse will show the deleted shipment consolidation’s status and generate the "cancelledShipment": true.
• Delete Consolidation: Use this endpoint to delete a consolidation before it is confirmed.
  Note: This will also delete all the shipment packages that were processed as part of the consolidation.
• Retrieve Consolidation: Use this endpoint to retrieve the details of your consolidation.

The following are the key features associated with the Consolidation API:

Create Consolidations

Use this endpoint to create a consolidation with required consolidation information.
The key input information associated with this request are:

• Account Number - The FedEx shipping account number
• requestedConsolidation
  • consolidation Type - Specify the consolidation type.
  • Shipper – Provide Shipper information along with the Tax Identification Number (TIN)
  • Label Specification - Specify details about the image type, printer format, and label stock for label.
  • International Distribution Detail
    • Declared Currencies
    • Total Dimensions
    • Clearance Facility Location Id
  • Customs Clearance Detail – Specify the Importer of Record.
  • Consolidation Documents – Specify the paperwork required when the consolidation is confirmed.

The successful response for this request will create the consolidation and generate the Master Tracking ID and Consolidation Key. Note that no labels will be generated in the response.

Modify Consolidations

Use this endpoint to modify information of an existing Consolidation request before the consolidation is confirmed.
The key input information associated with this request are:

• Consolidation Key – Specify the Consolidation Type, Index and consolidation date from Create Consolidation Response.
• Account Number - The FedEx shipping account number.
• requestedConsolidation
  • Consolidation Type - Specify the consolidation type.
  • Shipper
  • Label Specification - Specify the details about the image type, printer format, and label stock for label. You can also specify customer specific details such as doc-tab content, regulatory labels, and mask data on the label
  • Customs Clearance – Specify the Customs clearance details with Importer of Record.

The successful request will update the intended information and return the updated consolidation details.

Retrieve Consolidation

Use this endpoint to retrieve the consolidation for the specified Consolidation key. The key input information associated with this request are:

• Account Number - The FedEx shipping account number.
• Consolidation Key – Specify the Consolidation Type, Index and consolidation date from Create Consolidation

The successful request will retrieve the consolidation details.

Delete Consolidation

Use this endpoint to delete the open consolidation before the consolidation is confirmed.
Note: If required, this endpoint should be used before Confirm Consolidation.

The key input information associated with this request are:

• Account Number - The FedEx shipping account number.
• Consolidation Key – Specify the Consolidation Type, Index and consolidation date.
• TrackingId – Specify the master tracking id generated in create consolidation response.

The successful request will delete the intended consolidation and will return the transactionID and the status for the element cancelledShipment as true in the output.

Create Consolidation Shipment

Use this endpoint to add the shipment packages under one consolidation key.
Note: Minimum 2 shipment are required to create consolidation shipment.

The key input information associated with this request are:

• Label Response Options – Should be URL_ONLY/LABEL
• Open Shipment Action - CONFIRM
• Account Number - The FedEx shipping account number.
• Consolidation Key – Specify the consolidation Type, Index and consolidation date from Create Consolidation
• requestedShipment
  • Consolidation Type - Specify the consolidation type
  • Shipper information
  • Recipients information
  • Pickup Type
  • Service Type – Provide Express/Ground service types
  • Packaging Type
  • Shipping Payment Type (SENDER/THIRD_PARTY and Payor ACCOUNT)
  • Customs Clearance Detail
  • Package Line Items
    • weight
    • commodities

The successful response for 40 or less child packages per consolidation in a shipment will upload shipment data to FedEx systems and generate tracking numbers and package labels. Successful confirmation response for more than 40 child packages per consolidation in a shipment confirms that the request is queued successfully and returns jobId to retrieve the result later using Consolidation Shipment Results.

Confirm Consolidation

Use this endpoint to confirm the Consolidation.
The key input information associated with this request are:

• Account Number
• processingOptionType - ALLOW_ASYNCHRONOUS
• Consolidation Key
• Label Specification

The successful response to this request will provide asynchronous processing results, jobID and completed consolidation details which include shipmentRoleType, requestedShipments details, and other shipping information.

Confirm Consolidation Results

Use this endpoint to complete a consolidation. If consolidation is completed, the response returns the label buffers and any applicable documents.

The key input information associated with this request are:

• jobId
• Account Number

Successful response for this request will return the confirmed Consolidation Shipment results which include tracking number, shipping document or label specific information.

Consolidation Shipment Results

Use this endpoint to validate and upload the Consolidation shipment data to FedEx Systems once all packages are added in the Shipment request. This endpoint provides the option to check if the asynchronous processing of open shipments is complete. If yes, then the labels and applicable documents are returned in response. The operating companies for this request are FedEx Express and FedEx Ground.
The key input information associated with this request are:

• jobId
• Account Number

The successful response to this request will provide Shipments details which includes the shipment tracking number and Labels.

Delete Consolidation Shipments

Use this endpoint to cancel FedEx Express, Express Freight and Ground shipments which are not tendered to FedEx.
The key input information associated with this request are:

• Account Number
• Tracking Number
• deletionControl - DELETE_ALL_PACKAGES

The successful response to this request will show deleted shipment consolidation’s status and generate the "cancelledShipment": true.

• A maximum of 300 packages are allowed in a single shipment.
• A combined total of 400 packages in a single consolidation is allowed currently for a FedEx Consolidation.
• A maximum of 999 unique commodities (FedEx Express and FedEx Ground, as appropriate) per consolidation. Usually there are far less commodities in a consolidation.
• Only Bill Sender and Bill Third Party are allowed for transportation charges and for duties and taxes.
• You cannot ship an individual piece for an International Priority DirectDistribution Freight shipment that is less than 68 kg or 151 lbs.
• Small parcel size and weight data that does not exceed the current intra-U.S. FedEx Express, FedEx Ground and FedEx Home Delivery size and weight restrictions.
• Collect on Delivery is not available with FedEx Consolidation API.
• You can select a single currency for the customs value of the entire transaction. After the FedEx Consolidation shipment is opened, the currency you selected for the first package in the shipment remains the same for the other packages in the consolidation.
• If you ship packages using FedEx Ground or FedEx Home Delivery, then you must code measurements in pounds (LB) and inches (IN).
• The Consolidations and Consolidation shipments will be purged if they are not confirmed within the end of fifth day from the Consolidations creation.