Consolidation API

Introduction

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 Details

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.

International DirectDistribution Service

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.

International Paperwork

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)

Shipping Need	Service Provided
First thing the next-business-day morning.	FedEx First Overnight^®
Next-business-day morning.	FedEx Priority Overnight^®
Next-business-day afternoon.	FedEx Standard Overnight^®
2 business days.	FedEx 2Day^®
Second-business day by 10:30 a.m. to most business areas; for certain shipments to Alaska and Hawaii, delivery is in 3 business days.	FedEx 2Day^® A.M
3 business days.	FedEx Express Saver^®
In 1, 2 or 3 business days within the U.S. for packages over 150 pounds each.	FedEx 1Day^® Freight, FedEx 2Day^® Freight, FedEx 3Day^® Freight

FedEx Ground Services - International DirectDistribution (IDD) Surface Solutions

Shipping Need	Service Provided
Economical ground delivery to businesses.	FedEx Ground^®
Economical ground delivery to U.S. residences.	FedEx Home Delivery^®

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 Shipment Process

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 –

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.
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.
Consolidation Shipment Results: Use this endpoint with the generated jobID to get the shipment tracking number and labels.
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
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 –

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

How Consolidation API Works

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.

Business Rules

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.

JSON API Collection

ShipConsolidation (API)

Modify Consolidations

Modify Consolidation endpoint is intended to modify a new consolidation request with preliminary information ( Shipper, recipient, origin info etc.,) so that the customers can modify the consolidations.

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXXXX This is the confidential client token which authorize the user.
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.

Request Body schema: application/json

One of

Full_Schema_ModifyConsolidation
SamplePayload-ModifyConsolidation

consolidationKey required	object (ConsolidationKey) Identifies the consolidation to which this open shipment should be added after successful creation.
requestedConsolidation required	object (RequestedConsolidation) Specify the requested consolidation
accountNumber required	object (AccountNumber) This is the FedEx Account number. Example: 123456789

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/consolidations

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/consolidations

Production Server

https://apis.fedex.com/ship/v1/consolidations

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"consolidationKey":
{
- "date": "2019-11-28",
- "index": "2710",
- "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION"
},
"requestedConsolidation":
{
- "consolidationType": "INTERNATIONAL_ECONOMY_DISTRIBUTION",
- "shipDate": "2021-05-07",
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "1550 Union Blvd",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US"
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "FedEx"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "PERSONAL_STATE",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "origin":
  {
  - "address":
    {
    "streetLines":
    [
    "1550 Union Blvd",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US"
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "FedEx"
    }
  },
- "soldTo":
  {
  - "address":
    {
    "streetLines":
    [
    "1550 Union Blvd",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "companyName": "FedEx"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "PERSONAL_STATE",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "bookingNumber": "1234",
- "distributionLocation":
  {
  - "type": "CUSTOMER_SPECIFIED",
  - "locationNumber": 0,
  - "id": "123",
  - "locationId": "YBZA",
  - "locationContactAndAddress":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
  - "clearanceNumber": "123",
  - "inclusionSpecifications":
    [
    "freight"
    ]
  },
- "consolidationDataSources":
  [
  - {
    "consolidationDataType": "TOTAL_INSURED_VALUE",
    "consolidationDataSourceType": "ACCUMULATED"
    }
  ],
- "customerReferences":
  [
  - {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    }
  ],
- "labelSpecification":
  {
  - "labelFormatType": "COMMON2D",
  - "labelStockType": "PAPER_7X475",
  - "imageType": "PDF",
  - "processingOptionsRequested":
    {
    "options": "INCLUDE_DOC_TAB_ON_ALL_LABELS"
    },
  - "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THRID_PARTY"
    }
    ],
    "locale":
    {
    "country": "US",
    "language": "en"
    },
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED",
    "grouping": "CONSOLIDATED_BY_DOCUMENT_TYPE",
    "storageDetail":
    {
    "type": "ASYNC_SERVICE",
    "filePath": "string",
    "fileNaming": "FAST",
    "fileSuffix": "string"
    },
    "printDetail":
    {
    "printerId": "string"
    }
    }
    ],
  - "resolution": 300,
  - "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
  - "labelRotation": "UPSIDE_DOWN",
  - "labelOrder": "SHIPPING_LABEL_FIRST",
  - "printedLabelOrigin":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
  - "customerSpecifiedDetail":
    {
    "maskedData":
    [
    "[\"PACKAGE_SEQUENCE_AND_COUNT\",\"TOTAL_WEIGHT\"]"
    ],
    "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
    "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    }
    }
    }
  },
- "internationalDistributionDetail":
  {
  - "dropOffType": "DROP_BOX",
  - "totalDimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
  - "totalInsuredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "unitSystem": "ENGLISH",
  - "declaredCurrencies":
    {
    "currency": "USD",
    "value": "CUSTOMS_VALUE"
    },
  - "clearanceFacilityLocationId": "MEMI"
  },
- "transborderDistributionDetail":
  {
  - "specialServicesRequested":
    {
    "specialServiceTypes": "FEDEX_LTL",
    "transborderDistributionLtlDetail":
    {
    "payment":
    {
    "paymentType": "CREDIT_CARD",
    "payor":
    {
    "responsibleParty":
    {
    "accountNumber": "123456789",
    "tins":
    [
    {
    "tinType": "BUSINESS_STATE",
    "number": "123567",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "contact":
    {
    "contactId": "123",
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    },
    "associatedAccounts":
    [
    {
    "type": "FEDEX_EXPRESS",
    "accountNumber": "12345678"
    }
    ]
    },
    "ePaymentDetail":
    {
    "epaymentProcessor": "RETAIL_SINGLE_POINT_OF_SALE",
    "ePaymentMode": "GOOGLE_PAY",
    "creditCardType": "DISCOVER",
    "creditCardExpirationDate": "2022-23-01",
    "amount":
    {
    "currency": "USD",
    "amount": 11.5
    }
    },
    "creditCard":
    {
    "number": "1111222233334444",
    "creditCardType": "DISCOVER",
    "expirationDate": "2022-23-01",
    "lastAuthenticationByFedexDate": "12-05-2001",
    "verificationCode": "123",
    "creditCardHolder":
    {
    "contact":
    {
    "personName":
    {
    "prefix": "Mr",
    "title": "Mayor",
    "firstName": "John",
    "middleName": "Dean",
    "lastName": "Taylor",
    "suffix": "Jr"
    },
    "phoneNumberCountryCode": "61",
    "phoneNumberAreaCode": "901",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "pagerNumber": "6127812",
    "faxNumber": "1234567890",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    }
    },
    "creditCardTransactionDetail":
    {
    "authorizationId": null,
    "authorizationType": "VERIFY_WITH_ACCOUNT",
    "settlementScheduleType": "SETTLE_IMMEDIATELY",
    "fraudDetectionDetail":
    {
    "ipAddress": "192.158.1.38",
    "clientCookiesEnabled": false,
    "devicePrint": "<p style=\"background:url(https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=1)\"></p><img src=\"https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=2\" alt=\"\"/><object type=\"application/x-shockwave-flash\" data=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" width=\"1\" height=\"1\" id=\"thm_fp\"><param name=\"movie\" value=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\"/><div></div></object><script src=\"https://ccf.prod.fedex.com/fp/check.js?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" type=\"text/javascript\"></script>"
    },
    "payorAuthenticationCode": "1234ABCDE",
    "payorAuthenticationSessionId": "1234567",
    "attributesDetail":
    {
    "types": "ORIGINATED_BY_AUTHORIZED_PERSONNEL"
    }
    },
    "amount":
    {
    "currency": "USD",
    "amount": 11.11
    }
    },
    "ltlScacCode": "SAIA"
    }
    },
  - "routing": "CUSTOMER_SPECIFIED",
  - "summaryDetail":
    {
    "expressPacakgeCount": 5,
    "expressTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressFreightPackageCount": 7,
    "expressTotalFreightWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalFreightAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundPackageCount": 3,
    "groundTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "numberOfUnconsolidatedCommodities": 7
    }
  },
- "customsClearanceDetail":
  {
  - "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
  - "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "1550 Union Blvd",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US"
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "FedEx"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    },
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
  - "documentContent": "DOCUMENTS_ONLY",
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "insuranceCharges":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "declarationStatementDetail":
    {
    "types":
    [
    "USMCA_LOW_VALUE"
    ]
    },
  - "commercialInvoice":
    {
    "termsOfSale": "DDP",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "purpose": "CONSUMER",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "specialInstructions": "specialInstructions\"",
    "declarationStatement": "declarationStatement",
    "paymentTerms": "payment terms",
    "purposeOfShipmentDescription": "purpose Of Shipment Description",
    "customerReferences":
    [
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    }
    ],
    "originatorName": "originator Name"
    },
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "John Wick",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "AESX20220407123456",
    "permitNumber": "12345"
    },
  - "commodities":
    [
    {
    "name": "non-threaded rivets",
    "numberOfPieces": 12,
    "description": "AC parts",
    "countryOfManufacture": "US",
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "quantity": 125,
    "quantityUnits": "EA",
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "commodityId": "commodity Id"
    }
    ],
  - "brokers":
    [
    {
    "broker":
    {
    "address": null,
    "contact": null,
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "type": "string"
    }
    ],
  - "clearanceBrokerage": "BROKER_SELECT",
  - "freightOnValue": "OWN_RISK"
  },
- "consolidationDocumentSpecification":
  {
  - "consolidationDocumentTypes":
    [
    "CONSOLIDATED_COMMERCIAL_INVOICE",
    "CUSTOMS_PACKING_LIST",
    "CRN_REPORT",
    "COMMODITIES_BY_TRACKING_NUMBER_REPORT",
    "CONDENSED_CRN_REPORT",
    "CONSOLIDATED_CUSTOMS_LINEHAUL_REPORT",
    "CONSOLIDATED_PARTY_REPORT",
    "CONSOLIDATED_SOLD_TO_SUMMARY_REPORT",
    "CUSTOM_CONSOLIDATION_DOCUMENT"
    ],
  - "consolidatedCommercialInvoiceDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "customsPackingListDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "crnReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "condensedCrnReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "consolidatedCustomsLinehaulReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "consolidatedPartyReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "consolidatedSoldToSummaryReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "commoditiesByTrackingNumberDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "customDocumentDetails":
    [
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    ]
  },
- "shippingChargesPayment":
  {
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
  - "paymentType": "THIRD_PARTY"
  },
- "description": "Description",
- "specialServicesRequested":
  {
  - "specialServiceTypes": "PRIORITY_ALERT",
  - "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    }
  },
- "processingOption":
  {
  - "options":
    [
    "REQUIRE_PRE_EPIC_BARCODE"
    ]
  },
- "crnShippingDocumentTypes": "[\"RETURN_INSTRUCTIONS\",\"DANGEROUS_GOODS_SHIPPERS_DECLARATION\"]"
},
"accountNumber":
{
- "value": "123456789"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"customerTransactionId": "AnyCo_order123456789",
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "modifyConsolidation":
  {
  - "consolidationType": "INTERNATIONAL_ECONOMY_DISTRIBUTION",
  - "shipDate": "2021-05-07",
  - "trackingIds":
    [
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    }
    ],
  - "shipper":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "accountNumber":
    {
    "value": "123456789"
    }
    },
  - "origin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    }
    },
  - "soldTo":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "accountNumber":
    {
    "value": "123456789"
    }
    },
  - "bookingNumber": "1234",
  - "consolidationDataSources":
    {
    "consolidationDataType": "TOTAL_INSURED_VALUE",
    "consolidationDataSourceType": "ACCUMULATED"
    },
  - "customerReferences":
    [
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    }
    ],
  - "labelSpecification":
    {
    "labelFormatType": "COMMON2D",
    "labelStockType": "PAPER_7X475",
    "imageType": "PDF",
    "processingOptionsRequested":
    {
    "options": "INCLUDE_DOC_TAB_ON_ALL_LABELS"
    },
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THRID_PARTY"
    }
    ],
    "locale":
    {
    "country": "US",
    "language": "en"
    },
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED",
    "grouping": "CONSOLIDATED_BY_DOCUMENT_TYPE",
    "storageDetail":
    {
    "type": "ASYNC_SERVICE",
    "filePath": "string",
    "fileNaming": "FAST",
    "fileSuffix": "string"
    },
    "printDetail":
    {
    "printerId": "string"
    }
    }
    ],
    "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
    "labelRotation": "UPSIDE_DOWN",
    "labelOrder": "SHIPPING_LABEL_FIRST",
    "printedLabelOrigin":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
    "customerSpecifiedDetail":
    {
    "maskedData":
    [
    "[\"PACKAGE_SEQUENCE_AND_COUNT\",\"TOTAL_WEIGHT\"]"
    ],
    "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
    "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    }
    }
    },
    "resolution": 300
    },
  - "internationalDistributionDetail":
    {
    "dropOffType": "DROP_BOX",
    "totalDimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "totalInsuredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "unitSystem": "ENGLISH",
    "declaredCurrencies":
    {
    "currency": "USD",
    "value": "CUSTOMS_VALUE"
    },
    "clearanceFacilityLocationId": "MEMI"
    },
  - "transborderDistributionDetail":
    {
    "specialServicesRequested":
    {
    "specialServiceTypes": "FEDEX_LTL",
    "transborderDistributionLtlDetail":
    {
    "payment":
    {
    "paymentType": "CREDIT_CARD",
    "payor":
    {
    "responsibleParty":
    {
    "accountNumber": "123456789",
    "tins":
    [
    {
    "tinType": "BUSINESS_STATE",
    "number": "123567",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "contact":
    {
    "contactId": "123",
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    },
    "associatedAccounts":
    [
    {
    "type": "FEDEX_EXPRESS",
    "accountNumber": "12345678"
    }
    ]
    },
    "ePaymentDetail":
    {
    "epaymentProcessor": "RETAIL_SINGLE_POINT_OF_SALE",
    "ePaymentMode": "GOOGLE_PAY",
    "creditCardType": "DISCOVER",
    "creditCardExpirationDate": "2022-23-01",
    "amount":
    {
    "currency": "USD",
    "amount": 11.5
    }
    },
    "creditCard":
    {
    "number": "1111222233334444",
    "creditCardType": "DISCOVER",
    "expirationDate": "2022-23-01",
    "lastAuthenticationByFedexDate": "12-05-2001",
    "verificationCode": "123",
    "creditCardHolder":
    {
    "contact":
    {
    "personName":
    {
    "prefix": "Mr",
    "title": "Mayor",
    "firstName": "John",
    "middleName": "Dean",
    "lastName": "Taylor",
    "suffix": "Jr"
    },
    "phoneNumberCountryCode": "61",
    "phoneNumberAreaCode": "901",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "pagerNumber": "6127812",
    "faxNumber": "1234567890",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    }
    },
    "creditCardTransactionDetail":
    {
    "authorizationId": null,
    "authorizationType": "VERIFY_WITH_ACCOUNT",
    "settlementScheduleType": "SETTLE_IMMEDIATELY",
    "fraudDetectionDetail":
    {
    "ipAddress": "192.158.1.38",
    "clientCookiesEnabled": false,
    "devicePrint": "<p style=\"background:url(https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=1)\"></p><img src=\"https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=2\" alt=\"\"/><object type=\"application/x-shockwave-flash\" data=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" width=\"1\" height=\"1\" id=\"thm_fp\"><param name=\"movie\" value=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\"/><div></div></object><script src=\"https://ccf.prod.fedex.com/fp/check.js?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" type=\"text/javascript\"></script>"
    },
    "payorAuthenticationCode": "1234ABCDE",
    "payorAuthenticationSessionId": "1234567",
    "attributesDetail":
    {
    "types": "ORIGINATED_BY_AUTHORIZED_PERSONNEL"
    }
    },
    "amount":
    {
    "currency": "USD",
    "amount": 11.11
    }
    },
    "ltlScacCode": "SAIA"
    }
    },
    "routing": "CUSTOMER_SPECIFIED",
    "summaryDetail":
    {
    "expressPacakgeCount": 5,
    "expressTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressFreightPackageCount": 7,
    "expressTotalFreightWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalFreightAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundPackageCount": 3,
    "groundTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "numberOfUnconsolidatedCommodities": 7
    }
    },
  - "customsClearanceDetail":
    {
    "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
    "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "9612345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
    "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
    "documentContent": "DOCUMENTS_ONLY",
    "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
    "insuranceCharges":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatementDetail":
    {
    "types":
    [
    "USMCA_LOW_VALUE"
    ]
    },
    "commercialInvoice":
    {
    "termsOfSale": "DDP",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "purpose": "CONSUMER",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "specialInstructions": "specialInstructions\"",
    "declarationStatement": "declarationStatement",
    "paymentTerms": "payment terms",
    "purposeOfShipmentDescription": "REPAIR_AND_RETURN",
    "customerReferences":
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    },
    "originatorName": "originator Name"
    },
    "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "John Wick",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "AESX20220407123456",
    "permitNumber": "12345"
    },
    "commodities":
    [
    {
    "name": "non-threaded rivets",
    "numberOfPieces": 12,
    "description": "AC parts",
    "countryOfManufacture": "US",
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "quantity": 125,
    "quantityUnits": "EA",
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "commodityId": "commodity Id"
    }
    ],
    "brokers":
    [
    {
    "broker":
    {
    "address": null,
    "contact": null,
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "type": "string"
    }
    ],
    "clearanceBrokerage": "BROKER_SELECT",
    "freightOnValue": "OWN_RISK"
    },
  - "consolidationDocumentSpecification":
    {
    "consolidationDocumentTypes":
    [
    "CONSOLIDATED_COMMERCIAL_INVOICE",
    "CUSTOMS_PACKING_LIST",
    "CRN_REPORT",
    "COMMODITIES_BY_TRACKING_NUMBER_REPORT",
    "CONDENSED_CRN_REPORT",
    "CONSOLIDATED_CUSTOMS_LINEHAUL_REPORT",
    "CONSOLIDATED_PARTY_REPORT",
    "CONSOLIDATED_SOLD_TO_SUMMARY_REPORT",
    "CUSTOM_CONSOLIDATION_DOCUMENT"
    ],
    "consolidatedCommercialInvoiceDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "customsPackingListDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "crnReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "condensedCrnReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "consolidatedCustomsLinehaulReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "consolidatedPartyReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "consolidatedSoldToSummaryReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "commoditiesByTrackingNumberDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "customDocumentDetails":
    [
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    ]
    },
  - "distributionLocations":
    {
    "type": "CUSTOMER_SPECIFIED",
    "locationNumber": 0,
    "id": "123",
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
    "clearanceNumber": "123",
    "inclusionSpecifications":
    [
    "freight"
    ]
    },
  - "shippingChargesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
  - "specialServicesRequested":
    {
    "specialServiceTypes": "PRIORITY_ALERT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "internationalControlledExportDetail":
    {
    "type": "DEA_236",
    "foreignTradeZoneCode": "JFK",
    "entryNumber": "DP620438268",
    "licenseOrPermitNumber": "EB73447196",
    "licenseOrPermitExpirationDate": "2023-07-15"
    }
    }
  }
}

}

Create Consolidations

Create Consolidation endpoint is intended to create a new consolidation request with preliminary information ( Shipper, recipient, origin info etc.,) so that the customers can consolidate their shipment.

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXXXX This is the confidential client token which authorize the user.
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.

Request Body schema: application/json

One of

Full_Schema_CreateConsolidation
SamplePayload-CreateConsolidation_IPD
SamplePayload-CreateConsolidation_IED
SamplePayload-CreateConsolidation_IDF
SamplePayload-CreateConsolidation_IGD
SamplePayload-CreateConsolidation_TD

consolidationIndex	string Specifies the cosolidation index. Example: Key2710
requestedConsolidation required	object (RequestedConsolidation) Specify the requested consolidation
accountNumber required	object (AccountNumber) This is the FedEx Account number. Example: 123456789

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/consolidations

Production Server

https://apis.fedex.com/ship/v1/consolidations

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"consolidationIndex": "Key2710",
"requestedConsolidation":
{
- "consolidationType": "INTERNATIONAL_ECONOMY_DISTRIBUTION",
- "shipDate": "2021-05-07",
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "1550 Union Blvd",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US"
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "FedEx"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "PERSONAL_STATE",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "origin":
  {
  - "address":
    {
    "streetLines":
    [
    "1550 Union Blvd",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US"
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "FedEx"
    }
  },
- "soldTo":
  {
  - "address":
    {
    "streetLines":
    [
    "1550 Union Blvd",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "companyName": "FedEx"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "PERSONAL_STATE",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "bookingNumber": "1234",
- "distributionLocation":
  {
  - "type": "CUSTOMER_SPECIFIED",
  - "locationNumber": 0,
  - "id": "123",
  - "locationId": "YBZA",
  - "locationContactAndAddress":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
  - "clearanceNumber": "123",
  - "inclusionSpecifications":
    [
    "freight"
    ]
  },
- "consolidationDataSources":
  [
  - {
    "consolidationDataType": "TOTAL_INSURED_VALUE",
    "consolidationDataSourceType": "ACCUMULATED"
    }
  ],
- "customerReferences":
  [
  - {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    }
  ],
- "labelSpecification":
  {
  - "labelFormatType": "COMMON2D",
  - "labelStockType": "PAPER_7X475",
  - "imageType": "PDF",
  - "processingOptionsRequested":
    {
    "options": "INCLUDE_DOC_TAB_ON_ALL_LABELS"
    },
  - "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THRID_PARTY"
    }
    ],
    "locale":
    {
    "country": "US",
    "language": "en"
    },
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED",
    "grouping": "CONSOLIDATED_BY_DOCUMENT_TYPE",
    "storageDetail":
    {
    "type": "ASYNC_SERVICE",
    "filePath": "string",
    "fileNaming": "FAST",
    "fileSuffix": "string"
    },
    "printDetail":
    {
    "printerId": "string"
    }
    }
    ],
  - "resolution": 300,
  - "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
  - "labelRotation": "UPSIDE_DOWN",
  - "labelOrder": "SHIPPING_LABEL_FIRST",
  - "printedLabelOrigin":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
  - "customerSpecifiedDetail":
    {
    "maskedData":
    [
    "[\"PACKAGE_SEQUENCE_AND_COUNT\",\"TOTAL_WEIGHT\"]"
    ],
    "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
    "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    }
    }
    }
  },
- "internationalDistributionDetail":
  {
  - "dropOffType": "DROP_BOX",
  - "totalDimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
  - "totalInsuredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "unitSystem": "ENGLISH",
  - "declaredCurrencies":
    {
    "currency": "USD",
    "value": "CUSTOMS_VALUE"
    },
  - "clearanceFacilityLocationId": "MEMI"
  },
- "transborderDistributionDetail":
  {
  - "specialServicesRequested":
    {
    "specialServiceTypes": "FEDEX_LTL",
    "transborderDistributionLtlDetail":
    {
    "payment":
    {
    "paymentType": "CREDIT_CARD",
    "payor":
    {
    "responsibleParty":
    {
    "accountNumber": "123456789",
    "tins":
    [
    {
    "tinType": "BUSINESS_STATE",
    "number": "123567",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "contact":
    {
    "contactId": "123",
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    },
    "associatedAccounts":
    [
    {
    "type": "FEDEX_EXPRESS",
    "accountNumber": "12345678"
    }
    ]
    },
    "ePaymentDetail":
    {
    "epaymentProcessor": "RETAIL_SINGLE_POINT_OF_SALE",
    "ePaymentMode": "GOOGLE_PAY",
    "creditCardType": "DISCOVER",
    "creditCardExpirationDate": "2022-23-01",
    "amount":
    {
    "currency": "USD",
    "amount": 11.5
    }
    },
    "creditCard":
    {
    "number": "1111222233334444",
    "creditCardType": "DISCOVER",
    "expirationDate": "2022-23-01",
    "lastAuthenticationByFedexDate": "12-05-2001",
    "verificationCode": "123",
    "creditCardHolder":
    {
    "contact":
    {
    "personName":
    {
    "prefix": "Mr",
    "title": "Mayor",
    "firstName": "John",
    "middleName": "Dean",
    "lastName": "Taylor",
    "suffix": "Jr"
    },
    "phoneNumberCountryCode": "61",
    "phoneNumberAreaCode": "901",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "pagerNumber": "6127812",
    "faxNumber": "1234567890",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    }
    },
    "creditCardTransactionDetail":
    {
    "authorizationId": null,
    "authorizationType": "VERIFY_WITH_ACCOUNT",
    "settlementScheduleType": "SETTLE_IMMEDIATELY",
    "fraudDetectionDetail":
    {
    "ipAddress": "192.158.1.38",
    "clientCookiesEnabled": false,
    "devicePrint": "<p style=\"background:url(https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=1)\"></p><img src=\"https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=2\" alt=\"\"/><object type=\"application/x-shockwave-flash\" data=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" width=\"1\" height=\"1\" id=\"thm_fp\"><param name=\"movie\" value=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\"/><div></div></object><script src=\"https://ccf.prod.fedex.com/fp/check.js?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" type=\"text/javascript\"></script>"
    },
    "payorAuthenticationCode": "1234ABCDE",
    "payorAuthenticationSessionId": "1234567",
    "attributesDetail":
    {
    "types": "ORIGINATED_BY_AUTHORIZED_PERSONNEL"
    }
    },
    "amount":
    {
    "currency": "USD",
    "amount": 11.11
    }
    },
    "ltlScacCode": "SAIA"
    }
    },
  - "routing": "CUSTOMER_SPECIFIED",
  - "summaryDetail":
    {
    "expressPacakgeCount": 5,
    "expressTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressFreightPackageCount": 7,
    "expressTotalFreightWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalFreightAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundPackageCount": 3,
    "groundTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "numberOfUnconsolidatedCommodities": 7
    }
  },
- "customsClearanceDetail":
  {
  - "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
  - "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "1550 Union Blvd",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US"
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "FedEx"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    },
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
  - "documentContent": "DOCUMENTS_ONLY",
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "insuranceCharges":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "declarationStatementDetail":
    {
    "types":
    [
    "USMCA_LOW_VALUE"
    ]
    },
  - "commercialInvoice":
    {
    "termsOfSale": "DDP",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "purpose": "CONSUMER",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "specialInstructions": "specialInstructions\"",
    "declarationStatement": "declarationStatement",
    "paymentTerms": "payment terms",
    "purposeOfShipmentDescription": "purpose Of Shipment Description",
    "customerReferences":
    [
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    }
    ],
    "originatorName": "originator Name"
    },
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "John Wick",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "AESX20220407123456",
    "permitNumber": "12345"
    },
  - "commodities":
    [
    {
    "name": "non-threaded rivets",
    "numberOfPieces": 12,
    "description": "AC parts",
    "countryOfManufacture": "US",
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "quantity": 125,
    "quantityUnits": "EA",
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "commodityId": "commodity Id"
    }
    ],
  - "brokers":
    [
    {
    "broker":
    {
    "address": null,
    "contact": null,
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "type": "string"
    }
    ],
  - "clearanceBrokerage": "BROKER_SELECT",
  - "freightOnValue": "OWN_RISK"
  },
- "consolidationDocumentSpecification":
  {
  - "consolidationDocumentTypes":
    [
    "CONSOLIDATED_COMMERCIAL_INVOICE",
    "CUSTOMS_PACKING_LIST",
    "CRN_REPORT",
    "COMMODITIES_BY_TRACKING_NUMBER_REPORT",
    "CONDENSED_CRN_REPORT",
    "CONSOLIDATED_CUSTOMS_LINEHAUL_REPORT",
    "CONSOLIDATED_PARTY_REPORT",
    "CONSOLIDATED_SOLD_TO_SUMMARY_REPORT",
    "CUSTOM_CONSOLIDATION_DOCUMENT"
    ],
  - "consolidatedCommercialInvoiceDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "customsPackingListDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "crnReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "condensedCrnReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "consolidatedCustomsLinehaulReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "consolidatedPartyReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "consolidatedSoldToSummaryReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "commoditiesByTrackingNumberDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
  - "customDocumentDetails":
    [
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    ]
  },
- "shippingChargesPayment":
  {
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
  - "paymentType": "THIRD_PARTY"
  },
- "description": "Description",
- "specialServicesRequested":
  {
  - "specialServiceTypes": "PRIORITY_ALERT",
  - "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    }
  },
- "processingOption":
  {
  - "options":
    [
    "REQUIRE_PRE_EPIC_BARCODE"
    ]
  },
- "crnShippingDocumentTypes": "[\"RETURN_INSTRUCTIONS\",\"DANGEROUS_GOODS_SHIPPERS_DECLARATION\"]"
},
"accountNumber":
{
- "value": "123456789"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"customerTransactionId": "AnyCo_order123456789",
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "trackingIds":
  [
  - {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    }
  ],
- "consolidationKey":
  {
  - "date": "2019-11-28",
  - "index": "2710",
  - "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION"
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Create Consolidation Shipment

Create Consolidation Shipment service would help the customer to create a shipment and confirm it with the required shipping information.

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_CreateConsolidationShipment
CreateConsolidationShipment_Sync_IPD
CreateConsolidationShipment_Async_IPD
CreateConsolidationShipment_Sync_IED
CreateConsolidationShipment_Async_IED
CreateConsolidationShipment_Sync_IDF
CreateConsolidationShipment_Sync_IGD
CreateConsolidationShipment_Sync_TD

accountNumber required	object This is the FedEx Account number.
consolidationKey required	object (ConsolidationKey) Identifies the consolidation to which this open shipment should be added after successful creation.
processingOptionType	string Value: "ALLOW_ASYNCHRONOUS" This is used to specify processing options related to synchronous or asynchronous processing.
index	string This is a unique value for the shipment (must be unique for stand-alone open shipments, or unique within consolidation if consolidation key is provide). 'Note: If index is not provided while create Consolidation then the master tracking id of create Consolidation will act as index for the shipment.
shipAction	string Enum: "CONFIRM" "TRANSFER" Indicates the optional actions that can be performed during create consolidation shipment
requestedShipment required	object (RequestedConsolidationShipment) The consolidation shipment details
labelResponseOptions	string (LableResponseOptions) Enum: "URL_ONLY" "LABEL" This is to specify whether the encoded bytecode or the Label URL to be returned in the response. Valid values: LABEL – Indicates request is for encoded bytecode. URL_ONLY – Indicates label URL request. Note: For asynchronous shipment (More than 40 packages) request only the value LABEL is suported. Note: With URL_ONLY option, the URL once created will be active for 12 hours.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/shipments

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"accountNumber": "XXXXX2842",
"consolidationKey":
{
- "date": "2019-11-28",
- "index": "2710",
- "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION"
},
"processingOptionType": "ALLOW_ASYNCHRONOUS",
"index": "Test1234",
"shipAction": "CONFIRM",
"requestedShipment":
{
- "specialServicesRequested":
  {
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA"
    }
  },
- "shipDatestamp": "2021-02-05T00:00:00-00:00",
- "dropOffType": "DROP_BOX",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
- "packagingType": null,
- "totalWeight":
  {
  - "units": "KG",
  - "value": 68
  },
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "recipients":
  [
  - {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    }
    }
  ],
- "shippingChargesPayment":
  {
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
  - "paymentType": "THIRD_PARTY"
  },
- "processingOption":
  {
  - "options": "BYPASS_REGULATORY_VALIDATION"
  },
- "customsClearanceDetail":
  {
  - "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
  - "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "9612345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
  - "documentContent": "DOCUMENTS_ONLY",
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "insuranceCharges":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "declarationStatementDetail":
    {
    "types":
    [
    "USMCA_LOW_VALUE"
    ]
    },
  - "commercialInvoice":
    {
    "termsOfSale": "DDP",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "purpose": "CONSUMER",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "specialInstructions": "specialInstructions\"",
    "declarationStatement": "declarationStatement",
    "paymentTerms": "payment terms",
    "purposeOfShipmentDescription": "REPAIR_AND_RETURN",
    "customerReferences":
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    },
    "originatorName": "originator Name"
    },
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "John Wick",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "AESX20220407123456",
    "permitNumber": "12345"
    },
  - "commodities":
    [
    {
    "name": "non-threaded rivets",
    "numberOfPieces": 12,
    "description": "AC parts",
    "countryOfManufacture": "US",
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "quantity": 125,
    "quantityUnits": "EA",
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "commodityId": "commodity Id"
    }
    ],
  - "brokers":
    [
    {
    "broker":
    {
    "address": null,
    "contact": null,
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "type": "string"
    }
    ],
  - "clearanceBrokerage": "BROKER_SELECT",
  - "freightOnValue": "OWN_RISK"
  },
- "labelSpecification":
  {
  - "labelFormatType": "COMMON2D",
  - "labelStockType": "PAPER_7X475",
  - "imageType": "PDF",
  - "processingOptionsRequested":
    {
    "options": "INCLUDE_DOC_TAB_ON_ALL_LABELS"
    },
  - "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THRID_PARTY"
    }
    ],
    "locale":
    {
    "country": "US",
    "language": "en"
    },
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED",
    "grouping": "CONSOLIDATED_BY_DOCUMENT_TYPE",
    "storageDetail":
    {
    "type": "ASYNC_SERVICE",
    "filePath": "string",
    "fileNaming": "FAST",
    "fileSuffix": "string"
    },
    "printDetail":
    {
    "printerId": "string"
    }
    }
    ],
  - "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
  - "labelRotation": "UPSIDE_DOWN",
  - "labelOrder": "SHIPPING_LABEL_FIRST",
  - "printedLabelOrigin":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
  - "customerSpecifiedDetail":
    {
    "maskedData":
    [
    "[\"PACKAGE_SEQUENCE_AND_COUNT\",\"TOTAL_WEIGHT\"]"
    ],
    "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
    "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    }
    }
    },
  - "resolution": 300
  },
- "rateRequestTypes": "NONE",
- "packageCount": 3,
- "requestedPackageLineItems":
  [
  - {
    "sequenceNumber": 1,
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "physicalPackaging": "class line",
    "groupPackageCount": 25,
    "itemDescriptionForClearance": "description",
    "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
    "itemDescription": "item description for the package",
    "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER",
    "DANGEROUS_GOODS"
    ],
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionType": "SERVICE_DEFAULT",
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "trackingNumber": "927489270024412",
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "PACKED_WITH_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_ION"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    }
    },
    "associatedFreightLineItems":
    [
    {
    "id": "98712345"
    }
    ],
    "commodities":
    [
    {
    "name": "non-threaded rivets",
    "numberOfPieces": 12,
    "description": "AC parts",
    "countryOfManufacture": "US",
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "quantity": 125,
    "quantityUnits": "EA",
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "commodityId": "commodity Id"
    }
    ]
    }
  ]
},
"labelResponseOptions": "LABEL"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"customerTransactionId": "AnyCo_order123456789",
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDateStamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "packageDocuments":
    [
    {
    "masterTrackingNumber": "794953535000",
    "trackingNumber": "794953535000",
    "additionalChargesDiscount": 621.45,
    "netRateAmount": 1.45,
    "netChargeAmount": 21.45,
    "netDiscountAmount": 121.45,
    "packageDocuments":
    [
    {
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "DEPARTMENT_NUMBER",
    "value": "3686"
    }
    ],
    "codcollectionAmount": 231.45,
    "baseRateAmount": 321.45
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value":
    [
    "value",
    "value"
    ]
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "OVERRIDE",
    "customerSuppliedLabelText": "Customer Supplied Label Text"
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "NonBulk",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "UN1234",
    "packingGroup": "I",
    "properShippingName": "paint",
    "hazardClass": "2.3"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "Packing Instructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "A99",
    "properShippingNameAndDescription": "Accumulators, pressurized, pneumatic or hydraulic (containing non-flamable gas), see Articles pressurized, pneumatic or hydraulic (containing non-flamable gas)",
    "technicalName": "Acetal",
    "symbols": "A",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "UN3516",
    "packingGroup": "III",
    "properShippingName": "paint",
    "hazardClass": "3"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "barrel",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "HKAA",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 253,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "USMCA_CERTIFICATION_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "export Compliance Statement",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    },
    "shipmentConsolidationDetail":
    {
    "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
    "role": "CRN_SHIPMENT",
    "associatedTrackingIds":
    [
    {
    "trackingIds":
    [
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "type": "CONSOLIDATION_MASTER"
    }
    ]
    },
    "completedCodDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ]
}

}

ConsolidationShipmentResults

This endpoint provides the ablity to find out if the asyncronous processing for open shipments is complete. If complete, the response returns the label buffers and any applicable documents.
Operating Companies - FedEx Express, FedEx Ground

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

ConsolidationShipmentResultsInputVO
MinimumSamplePayload-ConsolidationShipmentResults

jobId required	string Unique identification for a job
accountNumber required	object (PartyAccountNumber) This FedEx Account number details.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/results

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/consolidations/results

Production Server

https://apis.fedex.com/ship/v1/consolidations/results

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"jobId": "efj222ee23dc3200s0362377",
"accountNumber":
{
- "value": "123456789"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDateStamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "packageDocuments":
    [
    {
    "masterTrackingNumber": "794953535000",
    "trackingNumber": "794953535000",
    "additionalChargesDiscount": 621.45,
    "netRateAmount": 1.45,
    "netChargeAmount": 21.45,
    "netDiscountAmount": 121.45,
    "packageDocuments":
    [
    {
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "DEPARTMENT_NUMBER",
    "value": "3686"
    }
    ],
    "codcollectionAmount": 231.45,
    "baseRateAmount": 321.45
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value":
    [
    "value",
    "value"
    ]
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "OVERRIDE",
    "customerSuppliedLabelText": "Customer Supplied Label Text"
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "NonBulk",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "UN1234",
    "packingGroup": "I",
    "properShippingName": "paint",
    "hazardClass": "2.3"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "Packing Instructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "A99",
    "properShippingNameAndDescription": "Accumulators, pressurized, pneumatic or hydraulic (containing non-flamable gas), see Articles pressurized, pneumatic or hydraulic (containing non-flamable gas)",
    "technicalName": "Acetal",
    "symbols": "A",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "UN3516",
    "packingGroup": "III",
    "properShippingName": "paint",
    "hazardClass": "3"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "barrel",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "HKAA",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 253,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "USMCA_CERTIFICATION_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "export Compliance Statement",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    },
    "shipmentConsolidationDetail":
    {
    "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
    "role": "CRN_SHIPMENT",
    "associatedTrackingIds":
    [
    {
    "trackingIds":
    [
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "type": "CONSOLIDATION_MASTER"
    }
    ]
    },
    "completedCodDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Confirm Consolidations

Confirm Consolidation endpoint is intended to confirm a new consolidation request with preliminary information so that the customers can confirm the consolidation .

header Parameters

X-locale	string Example: en_US ISO locale
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXXXX This is the confidential client token which authorize the user.
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.

Request Body schema: application/json

One of

Full_Schema_ConfirmConsolidation
MinimumSamplePayload-confirmConsolidation

edtRequestType	string Enum: "ALL" "NONE" Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment.Only applies with shipments movinf under International Shipment
rateRequestType	string Enum: "ACCOUNT" "CUSTOM" "INCENTIVE" "LIST" "NONE" "PREFERRED" "RATED" "RETAIL" Specifies the rate request type for the consolidation
labelSpecification required	object (LabelSpecification) These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking data on the label. Mandatory as it is needed during confirming consolidation. If it is not passed while creating consolidation it will fail during confirming consolidation.
consolidationKey required	object (ConsolidationKey) Identifies the consolidation to which this open shipment should be added after successful creation.
processingOptionType required	string Value: "ALLOW_ASYNCHRONOUS" Specifying the processing option.
accountNumber required	object (AccountNumber) This is the FedEx Account number. Example: 123456789
consolidationDocumentSpecification	object (ConsolidationDocumentSpec) Details of consolidation document specification

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/confirmations

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/consolidations/confirmations

Production Server

https://apis.fedex.com/ship/v1/consolidations/confirmations

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"edtRequestType": "ALL",
"rateRequestType": "ACCOUNT",
"labelSpecification":
{
- "labelFormatType": "COMMON2D",
- "labelStockType": "PAPER_7X475",
- "imageType": "PDF",
- "processingOptionsRequested":
  {
  - "options": "INCLUDE_DOC_TAB_ON_ALL_LABELS"
  },
- "dispositions":
  [
  - {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THRID_PARTY"
    }
    ],
    "locale":
    {
    "country": "US",
    "language": "en"
    },
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED",
    "grouping": "CONSOLIDATED_BY_DOCUMENT_TYPE",
    "storageDetail":
    {
    "type": "ASYNC_SERVICE",
    "filePath": "string",
    "fileNaming": "FAST",
    "fileSuffix": "string"
    },
    "printDetail":
    {
    "printerId": "string"
    }
    }
  ],
- "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
- "labelRotation": "UPSIDE_DOWN",
- "labelOrder": "SHIPPING_LABEL_FIRST",
- "printedLabelOrigin":
  {
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
  - "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
  - "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
  },
- "customerSpecifiedDetail":
  {
  - "maskedData":
    [
    "[\"PACKAGE_SEQUENCE_AND_COUNT\",\"TOTAL_WEIGHT\"]"
    ],
  - "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
  - "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    }
    }
  },
- "resolution": 300
},
"consolidationKey":
{
- "date": "2019-11-28",
- "index": "2710",
- "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION"
},
"processingOptionType": "ALLOW_ASYNCHRONOUS",
"accountNumber":
{
- "value": "123456789"
},
"consolidationDocumentSpecification":
{
- "consolidationDocumentTypes":
  [
  - "CONSOLIDATED_COMMERCIAL_INVOICE",
  - "CUSTOMS_PACKING_LIST",
  - "CRN_REPORT",
  - "COMMODITIES_BY_TRACKING_NUMBER_REPORT",
  - "CONDENSED_CRN_REPORT",
  - "CONSOLIDATED_CUSTOMS_LINEHAUL_REPORT",
  - "CONSOLIDATED_PARTY_REPORT",
  - "CONSOLIDATED_SOLD_TO_SUMMARY_REPORT",
  - "CUSTOM_CONSOLIDATION_DOCUMENT"
  ],
- "consolidatedCommercialInvoiceDetail":
  {
  - "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  },
- "customsPackingListDetail":
  {
  - "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  },
- "crnReportDetail":
  {
  - "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  },
- "condensedCrnReportDetail":
  {
  - "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  },
- "consolidatedCustomsLinehaulReportDetail":
  {
  - "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  },
- "consolidatedPartyReportDetail":
  {
  - "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  },
- "consolidatedSoldToSummaryReportDetail":
  {
  - "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  },
- "commoditiesByTrackingNumberDetail":
  {
  - "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  },
- "customDocumentDetails":
  [
  - {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
  ]
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"output":
{
- "processingOptionType": "ASYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "completedConsolidationDetail":
  {
  - "consolidationShipments":
    {
    "shipmentRoleType": "CONSOLIDATION_DOCUMENTS_SHIPMENT",
    "consolidationRequestedShipments":
    {
    "shipDatestamp": "string",
    "dropOffType": "BUSINESS_SERVICE_CENTER",
    "recipientLocationNumber": "string",
    "serviceType": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
    "packagingType": "YOUR_PACKAGING",
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalDimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "shipper":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "accountNumber":
    {
    "value": "123456789"
    }
    },
    "origin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    }
    },
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "accountNumber":
    {
    "value": "123456789"
    }
    },
    "processingOptionsRequested":
    {
    "options": "BYPASS_REGULATORY_VALIDATION"
    },
    "consolidationDetail":
    {
    "relationshipTimeStamp": "string",
    "type": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
    "role": "CONSOLIDATION_DOCUMENTS_SHIPMENT",
    "internationalDistribtuionDetail":
    {
    "summaryDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": "string"
    },
    "totalPackageCount": 0,
    "totalUniqueAddressCount": 0,
    "totalCustomsValue":
    {
    "currency": "string",
    "amount": "string"
    }
    }
    },
    "transborderDistributionDetail":
    {
    "specialServicesRequested":
    {
    "specialServiceTypes": "FEDEX_LTL",
    "transborderDistributionLtlDetail":
    {
    "payment":
    {
    "paymentType": "CREDIT_CARD",
    "payor":
    {
    "responsibleParty":
    {
    "accountNumber": "123456789",
    "tins":
    [
    {
    "tinType": "BUSINESS_STATE",
    "number": "123567",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "contact":
    {
    "contactId": "123",
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    },
    "associatedAccounts":
    [
    {
    "type": "FEDEX_EXPRESS",
    "accountNumber": "12345678"
    }
    ]
    },
    "ePaymentDetail":
    {
    "epaymentProcessor": "RETAIL_SINGLE_POINT_OF_SALE",
    "ePaymentMode": "GOOGLE_PAY",
    "creditCardType": "DISCOVER",
    "creditCardExpirationDate": "2022-23-01",
    "amount":
    {
    "currency": "USD",
    "amount": 11.5
    }
    },
    "creditCard":
    {
    "number": "1111222233334444",
    "creditCardType": "DISCOVER",
    "expirationDate": "2022-23-01",
    "lastAuthenticationByFedexDate": "12-05-2001",
    "verificationCode": "123",
    "creditCardHolder":
    {
    "contact":
    {
    "personName":
    {
    "prefix": "Mr",
    "title": "Mayor",
    "firstName": "John",
    "middleName": "Dean",
    "lastName": "Taylor",
    "suffix": "Jr"
    },
    "phoneNumberCountryCode": "61",
    "phoneNumberAreaCode": "901",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "pagerNumber": "6127812",
    "faxNumber": "1234567890",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    }
    },
    "creditCardTransactionDetail":
    {
    "authorizationId": null,
    "authorizationType": "VERIFY_WITH_ACCOUNT",
    "settlementScheduleType": "SETTLE_IMMEDIATELY",
    "fraudDetectionDetail":
    {
    "ipAddress": "192.158.1.38",
    "clientCookiesEnabled": false,
    "devicePrint": "<p style=\"background:url(https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=1)\"></p><img src=\"https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=2\" alt=\"\"/><object type=\"application/x-shockwave-flash\" data=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" width=\"1\" height=\"1\" id=\"thm_fp\"><param name=\"movie\" value=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\"/><div></div></object><script src=\"https://ccf.prod.fedex.com/fp/check.js?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" type=\"text/javascript\"></script>"
    },
    "payorAuthenticationCode": "1234ABCDE",
    "payorAuthenticationSessionId": "1234567",
    "attributesDetail":
    {
    "types": "ORIGINATED_BY_AUTHORIZED_PERSONNEL"
    }
    },
    "amount":
    {
    "currency": "USD",
    "amount": 11.11
    }
    },
    "ltlScacCode": "SAIA"
    }
    },
    "routing": "CUSTOMER_SPECIFIED",
    "summaryDetail":
    {
    "expressPacakgeCount": 5,
    "expressTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressFreightPackageCount": 7,
    "expressTotalFreightWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalFreightAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundPackageCount": 3,
    "groundTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "numberOfUnconsolidatedCommodities": 7
    }
    }
    },
    "customsClearanceDetail":
    {
    "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
    "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "9612345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
    "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
    "documentContent": "DOCUMENTS_ONLY",
    "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
    "insuranceCharges":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatementDetail":
    {
    "types":
    [
    "USMCA_LOW_VALUE"
    ]
    },
    "commercialInvoice":
    {
    "termsOfSale": "DDP",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "purpose": "CONSUMER",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "specialInstructions": "specialInstructions\"",
    "declarationStatement": "declarationStatement",
    "paymentTerms": "payment terms",
    "purposeOfShipmentDescription": "REPAIR_AND_RETURN",
    "customerReferences":
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    },
    "originatorName": "originator Name"
    },
    "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "John Wick",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "AESX20220407123456",
    "permitNumber": "12345"
    },
    "commodities":
    [
    {
    "name": "non-threaded rivets",
    "numberOfPieces": 12,
    "description": "AC parts",
    "countryOfManufacture": "US",
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "quantity": 125,
    "quantityUnits": "EA",
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "commodityId": "commodity Id"
    }
    ],
    "brokers":
    [
    {
    "broker":
    {
    "address": null,
    "contact": null,
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "type": "string"
    }
    ],
    "clearanceBrokerage": "BROKER_SELECT",
    "freightOnValue": "OWN_RISK"
    },
    "blockinsightVisibility": false,
    "labelSpecification":
    {
    "labelFormatType": "COMMON2D",
    "labelStockType": "PAPER_7X475",
    "imageType": "PDF",
    "labelPrintingOrientation": "BOTTOM_EDGE_OF_TEXT_FIRST"
    },
    "rateRequestTypes": "ACCOUNT",
    "edtRequestTypes": "ALL",
    "requestedPackageLineItems":
    {
    "sequenceNumber": "string",
    "groupNumber": "string",
    "groupPackageCount": "string",
    "trackingId":
    {
    "trackindIdType": "EXPRESS",
    "formId": "string",
    "trackingNumber": "string"
    },
    "weights":
    {
    "units": "KG",
    "value": 68
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "customerReferences":
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "abcfdggalkewgr"
    }
    },
    "completedShipmentDetail":
    {
    "usDomestic": false,
    "carrierCode": "FDXC",
    "masterTrackingId":
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "packageDescription":
    {
    "packagingType": "YOUR_PACKAGING",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "astraDescription": "2 DAY FRT",
    "description": "Specifies the description"
    },
    "specialServiceDescription":
    {
    "identifier":
    {
    "id": "string",
    "type": "string",
    "code": "string"
    },
    "names":
    {
    "type": "medium",
    "encoding": "utf-8",
    "value": "Deliver Weekday"
    }
    },
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "consolidationDetail":
    {
    "type": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
    "role": "MASTER_AIRWAYBILL_SHIPMENT"
    },
    "exportComplianceStatement": "3037f",
    "documentRequirements":
    {
    "requiredDocuments": "AIR_WAYBILL",
    "generationDetails":
    {
    "type": "AIR_WAYBILL",
    "minimumCopiesRequired": 0
    }
    },
    "completedPackageDetail":
    {
    "sequenceNumber": 1,
    "trackingId":
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    },
    "groupNumber": 0,
    "operationalDetail":
    {
    "operationalInstructions":
    {
    "number": 17,
    "content": "content"
    },
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value":
    [
    "value",
    "value"
    ]
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    }
    },
    "label":
    {
    "type": "AUXILIARY_LABEL - CERTIFICATE_OF_ORIGIN - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - COD_RETURN_2_D_BARCODE - COD_RETURN_LABEL - COMMERCIAL_INVOICE - CUSTOM_PACKAGE_DOCUMENT - CUSTOM_SHIPMENT_DOCUMENT - DANGEROUS_GOODS_SHIPPERS_DECLARATION - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - ETD_LABEL - EXPORT_DECLARATION - FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING - FREIGHT_ADDRESS_LABEL - GENERAL_AGENCY_AGREEMENT - GROUND_BARCODE - OP_900 - OUTBOUND_2_D_BARCODE - OUTBOUND_LABEL - PENDING_SHIPMENT_EMAIL_NOTIFICATION - PRO_FORMA_INVOICE - RECIPIENT_ADDRESS_BARCODE - RECIPIENT_POSTAL_BARCODE - RETURN_INSTRUCTIONS - TERMS_AND_CONDITIONS - USMCA_CERTIFICATION_OF_ORIGIN - USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN - USPS_BARCODE - VICS_BILL_OF_LADING",
    "shippingDocumentDisposition": "RETURNED",
    "imageType": "DIB",
    "resolution": 0,
    "copiesToPrint": 0,
    "parts":
    {
    "documentPartSequenceNumber": 0,
    "image": null
    }
    },
    "packageDocuments":
    [
    {
    "type": "AUXILIARY_LABEL - CERTIFICATE_OF_ORIGIN - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - COD_RETURN_2_D_BARCODE - COD_RETURN_LABEL - COMMERCIAL_INVOICE - CUSTOM_PACKAGE_DOCUMENT - CUSTOM_SHIPMENT_DOCUMENT - DANGEROUS_GOODS_SHIPPERS_DECLARATION - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - ETD_LABEL - EXPORT_DECLARATION - FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING - FREIGHT_ADDRESS_LABEL - GENERAL_AGENCY_AGREEMENT - GROUND_BARCODE - OP_900 - OUTBOUND_2_D_BARCODE - OUTBOUND_LABEL - PENDING_SHIPMENT_EMAIL_NOTIFICATION - PRO_FORMA_INVOICE - RECIPIENT_ADDRESS_BARCODE - RECIPIENT_POSTAL_BARCODE - RETURN_INSTRUCTIONS - TERMS_AND_CONDITIONS - USMCA_CERTIFICATION_OF_ORIGIN - USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN - USPS_BARCODE - VICS_BILL_OF_LADING",
    "shippingDocumentDisposition": "RETURNED",
    "imageType": "DIB",
    "resolution": 0,
    "copiesToPrint": 0,
    "parts":
    [
    {
    "documentPartSequenceNumber": 0,
    "image": "string"
    }
    ]
    }
    ],
    "signatureOptions": "ADULT"
    }
    }
    },
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value":
    [
    "value",
    "value"
    ]
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "OVERRIDE",
    "customerSuppliedLabelText": "Customer Supplied Label Text"
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "NonBulk",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "UN1234",
    "packingGroup": "I",
    "properShippingName": "paint",
    "hazardClass": "2.3"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "Packing Instructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "A99",
    "properShippingNameAndDescription": "Accumulators, pressurized, pneumatic or hydraulic (containing non-flamable gas), see Articles pressurized, pneumatic or hydraulic (containing non-flamable gas)",
    "technicalName": "Acetal",
    "symbols": "A",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "UN3516",
    "packingGroup": "III",
    "properShippingName": "paint",
    "hazardClass": "3"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "barrel",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "HKAA",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 253,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "USMCA_CERTIFICATION_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "export Compliance Statement",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    },
    "shipmentConsolidationDetail":
    {
    "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
    "role": "CRN_SHIPMENT",
    "associatedTrackingIds":
    [
    {
    "trackingIds":
    [
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "type": "CONSOLIDATION_MASTER"
    }
    ]
    },
    "completedCodDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    }
    }
    }
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Confirm Consolidation Results

Confirm Consolidation Results endpoint is intended to confirm a new consolidation request with preliminary information so that the customers can confirm the consolidation.

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_ConfirmConsolidationResults
MinimumSamplePayload-confirmConsolidationResults

accountNumber required	object (AccountNumber) This is the FedEx Account number. Example: 123456789
jobId required	string When the confirm consolidation is processed asynchronously, job Id is generated which is passed in confirm consolidation results to get complete consolidation results

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/confirmationresults

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/consolidations/confirmationresults

Production Server

https://apis.fedex.com/ship/v1/consolidations/confirmationresults

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"accountNumber":
{
- "value": "123456789"
},
"jobId": "b8r763490cj7462n8907"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "jobId": "abc123456",
- "processingOptionType": "ASYNCHRONOUSLY_PROCESSED",
- "transactionConsolidations":
  [
  - {
    "completedConsolidationDetail":
    {
    "consolidationShipments":
    {
    "shipmentRoleType": "CONSOLIDATION_DOCUMENTS_SHIPMENT",
    "consolidationRequestedShipments":
    {
    "shipDatestamp": "string",
    "dropOffType": "BUSINESS_SERVICE_CENTER",
    "recipientLocationNumber": "string",
    "serviceType": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
    "packagingType": "YOUR_PACKAGING",
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalDimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "shipper":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "accountNumber":
    {
    "value": "123456789"
    }
    },
    "origin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    }
    },
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "accountNumber":
    {
    "value": "123456789"
    }
    },
    "processingOptionsRequested":
    {
    "options": "BYPASS_REGULATORY_VALIDATION"
    },
    "consolidationDetail":
    {
    "relationshipTimeStamp": "string",
    "type": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
    "role": "CONSOLIDATION_DOCUMENTS_SHIPMENT",
    "internationalDistribtuionDetail":
    {
    "summaryDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": "string"
    },
    "totalPackageCount": 0,
    "totalUniqueAddressCount": 0,
    "totalCustomsValue":
    {
    "currency": "string",
    "amount": "string"
    }
    }
    },
    "transborderDistributionDetail":
    {
    "specialServicesRequested":
    {
    "specialServiceTypes": "FEDEX_LTL",
    "transborderDistributionLtlDetail":
    {
    "payment":
    {
    "paymentType": "CREDIT_CARD",
    "payor":
    {
    "responsibleParty":
    {
    "accountNumber": "123456789",
    "tins":
    [
    {
    "tinType": "BUSINESS_STATE",
    "number": "123567",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "contact":
    {
    "contactId": "123",
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    },
    "associatedAccounts":
    [
    {
    "type": "FEDEX_EXPRESS",
    "accountNumber": "12345678"
    }
    ]
    },
    "ePaymentDetail":
    {
    "epaymentProcessor": "RETAIL_SINGLE_POINT_OF_SALE",
    "ePaymentMode": "GOOGLE_PAY",
    "creditCardType": "DISCOVER",
    "creditCardExpirationDate": "2022-23-01",
    "amount":
    {
    "currency": "USD",
    "amount": 11.5
    }
    },
    "creditCard":
    {
    "number": "1111222233334444",
    "creditCardType": "DISCOVER",
    "expirationDate": "2022-23-01",
    "lastAuthenticationByFedexDate": "12-05-2001",
    "verificationCode": "123",
    "creditCardHolder":
    {
    "contact":
    {
    "personName":
    {
    "prefix": "Mr",
    "title": "Mayor",
    "firstName": "John",
    "middleName": "Dean",
    "lastName": "Taylor",
    "suffix": "Jr"
    },
    "phoneNumberCountryCode": "61",
    "phoneNumberAreaCode": "901",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "pagerNumber": "6127812",
    "faxNumber": "1234567890",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    }
    },
    "creditCardTransactionDetail":
    {
    "authorizationId": null,
    "authorizationType": "VERIFY_WITH_ACCOUNT",
    "settlementScheduleType": "SETTLE_IMMEDIATELY",
    "fraudDetectionDetail":
    {
    "ipAddress": "192.158.1.38",
    "clientCookiesEnabled": false,
    "devicePrint": "<p style=\"background:url(https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=1)\"></p><img src=\"https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=2\" alt=\"\"/><object type=\"application/x-shockwave-flash\" data=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" width=\"1\" height=\"1\" id=\"thm_fp\"><param name=\"movie\" value=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\"/><div></div></object><script src=\"https://ccf.prod.fedex.com/fp/check.js?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" type=\"text/javascript\"></script>"
    },
    "payorAuthenticationCode": "1234ABCDE",
    "payorAuthenticationSessionId": "1234567",
    "attributesDetail":
    {
    "types": "ORIGINATED_BY_AUTHORIZED_PERSONNEL"
    }
    },
    "amount":
    {
    "currency": "USD",
    "amount": 11.11
    }
    },
    "ltlScacCode": "SAIA"
    }
    },
    "routing": "CUSTOMER_SPECIFIED",
    "summaryDetail":
    {
    "expressPacakgeCount": 5,
    "expressTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressFreightPackageCount": 7,
    "expressTotalFreightWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalFreightAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundPackageCount": 3,
    "groundTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "numberOfUnconsolidatedCommodities": 7
    }
    }
    },
    "customsClearanceDetail":
    {
    "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
    "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "9612345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
    "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
    "documentContent": "DOCUMENTS_ONLY",
    "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
    "insuranceCharges":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatementDetail":
    {
    "types":
    [
    "USMCA_LOW_VALUE"
    ]
    },
    "commercialInvoice":
    {
    "termsOfSale": "DDP",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "purpose": "CONSUMER",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "specialInstructions": "specialInstructions\"",
    "declarationStatement": "declarationStatement",
    "paymentTerms": "payment terms",
    "purposeOfShipmentDescription": "REPAIR_AND_RETURN",
    "customerReferences":
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    },
    "originatorName": "originator Name"
    },
    "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "John Wick",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "AESX20220407123456",
    "permitNumber": "12345"
    },
    "commodities":
    [
    {
    "name": "non-threaded rivets",
    "numberOfPieces": 12,
    "description": "AC parts",
    "countryOfManufacture": "US",
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "quantity": 125,
    "quantityUnits": "EA",
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "commodityId": "commodity Id"
    }
    ],
    "brokers":
    [
    {
    "broker":
    {
    "address": null,
    "contact": null,
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "type": "string"
    }
    ],
    "clearanceBrokerage": "BROKER_SELECT",
    "freightOnValue": "OWN_RISK"
    },
    "blockinsightVisibility": false,
    "labelSpecification":
    {
    "labelFormatType": "COMMON2D",
    "labelStockType": "PAPER_7X475",
    "imageType": "PDF",
    "labelPrintingOrientation": "BOTTOM_EDGE_OF_TEXT_FIRST"
    },
    "rateRequestTypes": "ACCOUNT",
    "edtRequestTypes": "ALL",
    "requestedPackageLineItems":
    {
    "sequenceNumber": "string",
    "groupNumber": "string",
    "groupPackageCount": "string",
    "trackingId":
    {
    "trackindIdType": "EXPRESS",
    "formId": "string",
    "trackingNumber": "string"
    },
    "weights":
    {
    "units": "KG",
    "value": 68
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "customerReferences":
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "abcfdggalkewgr"
    }
    },
    "completedShipmentDetail":
    {
    "usDomestic": false,
    "carrierCode": "FDXC",
    "masterTrackingId":
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "packageDescription":
    {
    "packagingType": "YOUR_PACKAGING",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "astraDescription": "2 DAY FRT",
    "description": "Specifies the description"
    },
    "specialServiceDescription":
    {
    "identifier":
    {
    "id": "string",
    "type": "string",
    "code": "string"
    },
    "names":
    {
    "type": "medium",
    "encoding": "utf-8",
    "value": "Deliver Weekday"
    }
    },
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "consolidationDetail":
    {
    "type": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
    "role": "MASTER_AIRWAYBILL_SHIPMENT"
    },
    "exportComplianceStatement": "3037f",
    "documentRequirements":
    {
    "requiredDocuments": "AIR_WAYBILL",
    "generationDetails":
    {
    "type": "AIR_WAYBILL",
    "minimumCopiesRequired": 0
    }
    },
    "completedPackageDetail":
    {
    "sequenceNumber": 1,
    "trackingId":
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    },
    "groupNumber": 0,
    "operationalDetail":
    {
    "operationalInstructions":
    {
    "number": 17,
    "content": "content"
    },
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value":
    [
    "value",
    "value"
    ]
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    }
    },
    "label":
    {
    "type": "AUXILIARY_LABEL - CERTIFICATE_OF_ORIGIN - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - COD_RETURN_2_D_BARCODE - COD_RETURN_LABEL - COMMERCIAL_INVOICE - CUSTOM_PACKAGE_DOCUMENT - CUSTOM_SHIPMENT_DOCUMENT - DANGEROUS_GOODS_SHIPPERS_DECLARATION - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - ETD_LABEL - EXPORT_DECLARATION - FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING - FREIGHT_ADDRESS_LABEL - GENERAL_AGENCY_AGREEMENT - GROUND_BARCODE - OP_900 - OUTBOUND_2_D_BARCODE - OUTBOUND_LABEL - PENDING_SHIPMENT_EMAIL_NOTIFICATION - PRO_FORMA_INVOICE - RECIPIENT_ADDRESS_BARCODE - RECIPIENT_POSTAL_BARCODE - RETURN_INSTRUCTIONS - TERMS_AND_CONDITIONS - USMCA_CERTIFICATION_OF_ORIGIN - USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN - USPS_BARCODE - VICS_BILL_OF_LADING",
    "shippingDocumentDisposition": "RETURNED",
    "imageType": "DIB",
    "resolution": 0,
    "copiesToPrint": 0,
    "parts":
    {
    "documentPartSequenceNumber": 0,
    "image": null
    }
    },
    "packageDocuments":
    [
    {
    "type": "AUXILIARY_LABEL - CERTIFICATE_OF_ORIGIN - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - COD_RETURN_2_D_BARCODE - COD_RETURN_LABEL - COMMERCIAL_INVOICE - CUSTOM_PACKAGE_DOCUMENT - CUSTOM_SHIPMENT_DOCUMENT - DANGEROUS_GOODS_SHIPPERS_DECLARATION - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - ETD_LABEL - EXPORT_DECLARATION - FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING - FREIGHT_ADDRESS_LABEL - GENERAL_AGENCY_AGREEMENT - GROUND_BARCODE - OP_900 - OUTBOUND_2_D_BARCODE - OUTBOUND_LABEL - PENDING_SHIPMENT_EMAIL_NOTIFICATION - PRO_FORMA_INVOICE - RECIPIENT_ADDRESS_BARCODE - RECIPIENT_POSTAL_BARCODE - RETURN_INSTRUCTIONS - TERMS_AND_CONDITIONS - USMCA_CERTIFICATION_OF_ORIGIN - USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN - USPS_BARCODE - VICS_BILL_OF_LADING",
    "shippingDocumentDisposition": "RETURNED",
    "imageType": "DIB",
    "resolution": 0,
    "copiesToPrint": 0,
    "parts":
    [
    {
    "documentPartSequenceNumber": 0,
    "image": "string"
    }
    ]
    }
    ],
    "signatureOptions": "ADULT"
    }
    }
    },
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value":
    [
    "value",
    "value"
    ]
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "OVERRIDE",
    "customerSuppliedLabelText": "Customer Supplied Label Text"
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "NonBulk",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "UN1234",
    "packingGroup": "I",
    "properShippingName": "paint",
    "hazardClass": "2.3"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "Packing Instructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "A99",
    "properShippingNameAndDescription": "Accumulators, pressurized, pneumatic or hydraulic (containing non-flamable gas), see Articles pressurized, pneumatic or hydraulic (containing non-flamable gas)",
    "technicalName": "Acetal",
    "symbols": "A",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "UN3516",
    "packingGroup": "III",
    "properShippingName": "paint",
    "hazardClass": "3"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "barrel",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "HKAA",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 253,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "Overweight package"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "USMCA_CERTIFICATION_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "export Compliance Statement",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    },
    "shipmentConsolidationDetail":
    {
    "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
    "role": "CRN_SHIPMENT",
    "associatedTrackingIds":
    [
    {
    "trackingIds":
    [
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "type": "CONSOLIDATION_MASTER"
    }
    ]
    },
    "completedCodDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    }
    }
    }
    },
    "pieceResponses":
    [
    {
    "packageDocuments":
    [
    {
    "masterTrackingNumber": "794953535000",
    "trackingNumber": "794953535000",
    "additionalChargesDiscount": 621.45,
    "netRateAmount": 1.45,
    "netChargeAmount": 21.45,
    "netDiscountAmount": 121.45,
    "packageDocuments":
    [
    {
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "DEPARTMENT_NUMBER",
    "value": "3686"
    }
    ],
    "codcollectionAmount": 231.45,
    "baseRateAmount": 321.45
    }
    ]
    }
    ],
    "shipmentDocuments":
    [
    {
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ]
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Retrieve Consolidation

Retrieve Consolidation service is intended to retrieve the consolidations which were created with the preliminary information ( Shipper, recipient, origin info etc.,) based on the Consolidation key.

header Parameters

X-locale	string Example: en_US ISO locale
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_RetrieveConsolidation
MinimumSamplePayload-RetrieveConsolidation

accountNumber required	object (AccountNumber_2) This is the FedEx Account number. Example: Your account number
consolidationKey required	object (ConsolidationKey) Identifies the consolidation to which this open shipment should be added after successful creation.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/consolidations/retrieve

Production Server

https://apis.fedex.com/ship/v1/consolidations/retrieve

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"accountNumber":
{
- "value": "123456789"
},
"consolidationKey":
{
- "date": "2019-11-28",
- "index": "2710",
- "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"customerTransactionId": "AnyCo_order123456789",
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "retrievedConsolidation":
  {
  - "consolidationType": "INTERNATIONAL_ECONOMY_DISTRIBUTION",
  - "shipDate": "2021-05-07",
  - "trackingIds":
    [
    {
    "trackingIdType": "EXPRESS",
    "formId": "0201",
    "trackingNumber": "49092000070120032835"
    }
    ],
  - "shipper":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "accountNumber":
    {
    "value": "123456789"
    }
    },
  - "origin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "918xxxxx890",
    "companyName": "Fedex"
    }
    },
  - "soldTo":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "accountNumber":
    {
    "value": "123456789"
    }
    },
  - "bookingNumber": "1234",
  - "consolidationDataSources":
    {
    "consolidationDataType": "TOTAL_INSURED_VALUE",
    "consolidationDataSourceType": "ACCUMULATED"
    },
  - "customerReferences":
    [
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    }
    ],
  - "labelSpecification":
    {
    "labelFormatType": "COMMON2D",
    "labelStockType": "PAPER_7X475",
    "imageType": "PDF",
    "processingOptionsRequested":
    {
    "options": "INCLUDE_DOC_TAB_ON_ALL_LABELS"
    },
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THRID_PARTY"
    }
    ],
    "locale":
    {
    "country": "US",
    "language": "en"
    },
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED",
    "grouping": "CONSOLIDATED_BY_DOCUMENT_TYPE",
    "storageDetail":
    {
    "type": "ASYNC_SERVICE",
    "filePath": "string",
    "fileNaming": "FAST",
    "fileSuffix": "string"
    },
    "printDetail":
    {
    "printerId": "string"
    }
    }
    ],
    "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
    "labelRotation": "UPSIDE_DOWN",
    "labelOrder": "SHIPPING_LABEL_FIRST",
    "printedLabelOrigin":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
    "customerSpecifiedDetail":
    {
    "maskedData":
    [
    "[\"PACKAGE_SEQUENCE_AND_COUNT\",\"TOTAL_WEIGHT\"]"
    ],
    "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
    "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "WHT",
    "dataField": "REQUEST/PACKAGE/weight/Value",
    "literalValue": "mytext",
    "justification": "RIGHT"
    }
    }
    }
    },
    "resolution": 300
    },
  - "internationalDistributionDetail":
    {
    "dropOffType": "DROP_BOX",
    "totalDimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "totalInsuredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "unitSystem": "ENGLISH",
    "declaredCurrencies":
    {
    "currency": "USD",
    "value": "CUSTOMS_VALUE"
    },
    "clearanceFacilityLocationId": "MEMI"
    },
  - "transborderDistributionDetail":
    {
    "specialServicesRequested":
    {
    "specialServiceTypes": "FEDEX_LTL",
    "transborderDistributionLtlDetail":
    {
    "payment":
    {
    "paymentType": "CREDIT_CARD",
    "payor":
    {
    "responsibleParty":
    {
    "accountNumber": "123456789",
    "tins":
    [
    {
    "tinType": "BUSINESS_STATE",
    "number": "123567",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "contact":
    {
    "contactId": "123",
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    },
    "associatedAccounts":
    [
    {
    "type": "FEDEX_EXPRESS",
    "accountNumber": "12345678"
    }
    ]
    },
    "ePaymentDetail":
    {
    "epaymentProcessor": "RETAIL_SINGLE_POINT_OF_SALE",
    "ePaymentMode": "GOOGLE_PAY",
    "creditCardType": "DISCOVER",
    "creditCardExpirationDate": "2022-23-01",
    "amount":
    {
    "currency": "USD",
    "amount": 11.5
    }
    },
    "creditCard":
    {
    "number": "1111222233334444",
    "creditCardType": "DISCOVER",
    "expirationDate": "2022-23-01",
    "lastAuthenticationByFedexDate": "12-05-2001",
    "verificationCode": "123",
    "creditCardHolder":
    {
    "contact":
    {
    "personName":
    {
    "prefix": "Mr",
    "title": "Mayor",
    "firstName": "John",
    "middleName": "Dean",
    "lastName": "Taylor",
    "suffix": "Jr"
    },
    "phoneNumberCountryCode": "61",
    "phoneNumberAreaCode": "901",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "FedEx",
    "pagerNumber": "6127812",
    "faxNumber": "1234567890",
    "title": "Mr"
    },
    "address":
    {
    "streetLines": "[10 FedEx Parkway, Suite 302]",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": true,
    "urbanizationCode": "CO",
    "countryName": "Canada",
    "geographicCoordinates": "+40.75-074.00",
    "classification": "BUSINESS"
    }
    }
    },
    "creditCardTransactionDetail":
    {
    "authorizationId": null,
    "authorizationType": "VERIFY_WITH_ACCOUNT",
    "settlementScheduleType": "SETTLE_IMMEDIATELY",
    "fraudDetectionDetail":
    {
    "ipAddress": "192.158.1.38",
    "clientCookiesEnabled": false,
    "devicePrint": "<p style=\"background:url(https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=1)\"></p><img src=\"https://ccf.prod.fedex.com/fp/clear.png?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95&m=2\" alt=\"\"/><object type=\"application/x-shockwave-flash\" data=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" width=\"1\" height=\"1\" id=\"thm_fp\"><param name=\"movie\" value=\"https://ccf.prod.fedex.com/fp/fp.swf?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\"/><div></div></object><script src=\"https://ccf.prod.fedex.com/fp/check.js?org_id=k8vif92e&session_id=fdx_us_dma3935ad4-358a-49c4-8b2c-165c7015db95\" type=\"text/javascript\"></script>"
    },
    "payorAuthenticationCode": "1234ABCDE",
    "payorAuthenticationSessionId": "1234567",
    "attributesDetail":
    {
    "types": "ORIGINATED_BY_AUTHORIZED_PERSONNEL"
    }
    },
    "amount":
    {
    "currency": "USD",
    "amount": 11.11
    }
    },
    "ltlScacCode": "SAIA"
    }
    },
    "routing": "CUSTOMER_SPECIFIED",
    "summaryDetail":
    {
    "expressPacakgeCount": 5,
    "expressTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressFreightPackageCount": 7,
    "expressTotalFreightWeight":
    {
    "units": "LB",
    "value": 0
    },
    "expressTotalFreightAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundPackageCount": 3,
    "groundTotalPackageWeight":
    {
    "units": "LB",
    "value": 0
    },
    "groundTotalPackageAdjustedWeight":
    {
    "units": "LB",
    "value": 0
    },
    "numberOfUnconsolidatedCommodities": 7
    }
    },
  - "customsClearanceDetail":
    {
    "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
    "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "9612345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
    "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
    "documentContent": "DOCUMENTS_ONLY",
    "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
    "insuranceCharges":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatementDetail":
    {
    "types":
    [
    "USMCA_LOW_VALUE"
    ]
    },
    "commercialInvoice":
    {
    "termsOfSale": "DDP",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "purpose": "CONSUMER",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "specialInstructions": "specialInstructions\"",
    "declarationStatement": "declarationStatement",
    "paymentTerms": "payment terms",
    "purposeOfShipmentDescription": "REPAIR_AND_RETURN",
    "customerReferences":
    {
    "customerReferenceType": "CUSTOMER_REFERENCE",
    "value": "USD"
    },
    "originatorName": "originator Name"
    },
    "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "John Wick",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "AESX20220407123456",
    "permitNumber": "12345"
    },
    "commodities":
    [
    {
    "name": "non-threaded rivets",
    "numberOfPieces": 12,
    "description": "AC parts",
    "countryOfManufacture": "US",
    "weight":
    {
    "units": "KG",
    "value": 68
    },
    "quantity": 125,
    "quantityUnits": "EA",
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "commodityId": "commodity Id"
    }
    ],
    "brokers":
    [
    {
    "broker":
    {
    "address": null,
    "contact": null,
    "accountNumber":
    {
    "value": "801472842"
    },
    "tins":
    {
    "description": "This is the tax identification number details.",
    "type": "array",
    "items":
    {
    "$ref": "#/components/schemas/TaxpayerIdentification"
    }
    }
    },
    "type": "string"
    }
    ],
    "clearanceBrokerage": "BROKER_SELECT",
    "freightOnValue": "OWN_RISK"
    },
  - "consolidationDocumentSpecification":
    {
    "consolidationDocumentTypes":
    [
    "CONSOLIDATED_COMMERCIAL_INVOICE",
    "CUSTOMS_PACKING_LIST",
    "CRN_REPORT",
    "COMMODITIES_BY_TRACKING_NUMBER_REPORT",
    "CONDENSED_CRN_REPORT",
    "CONSOLIDATED_CUSTOMS_LINEHAUL_REPORT",
    "CONSOLIDATED_PARTY_REPORT",
    "CONSOLIDATED_SOLD_TO_SUMMARY_REPORT",
    "CUSTOM_CONSOLIDATION_DOCUMENT"
    ],
    "consolidatedCommercialInvoiceDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "customsPackingListDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "crnReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "condensedCrnReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "consolidatedCustomsLinehaulReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "consolidatedPartyReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "consolidatedSoldToSummaryReportDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "commoditiesByTrackingNumberDetail":
    {
    "format":
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    },
    "customDocumentDetails":
    [
    {
    "docType": "PDF",
    "stockType": "PAPER_LETTER"
    }
    ]
    },
  - "distributionLocations":
    {
    "type": "CUSTOMER_SPECIFIED",
    "locationNumber": 0,
    "id": "123",
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "SMS_TEXT_MESSAGE",
    "address": "address",
    "permissions":
    {
    "key": "GRANT"
    }
    }
    ]
    },
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "Forester subdivision",
    "suite": "suite 201",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF",
    "locationInProperty": "south west of main office entrance",
    "addtionalDescriptions": "north door",
    "department": "Claims department",
    "roomFloor": "5th floor",
    "crossStreet": "Union and Main",
    "building": "Building 300",
    "apartment": "Apartment 1503",
    "room": "Room B-23"
    }
    },
    "clearanceNumber": "123",
    "inclusionSpecifications":
    [
    "freight"
    ]
    },
  - "shippingChargesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 1234,
    "faxNumber": "1234567890",
    "companyName": "FedEx",
    "stateTaxId": "11-N-1745",
    "fedralTaxId": "11-N-1745"
    },
    "accountNumber":
    {
    "value": "123456789"
    }
    }
    },
    "paymentType": "THIRD_PARTY"
    },
  - "specialServicesRequested":
    {
    "specialServiceTypes": "PRIORITY_ALERT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "internationalControlledExportDetail":
    {
    "type": "DEA_236",
    "foreignTradeZoneCode": "JFK",
    "entryNumber": "DP620438268",
    "licenseOrPermitNumber": "EB73447196",
    "licenseOrPermitExpirationDate": "2023-07-15"
    }
    }
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Delete Consolidation Shipments

Use this endpoint to delete the Express or Ground consolidations shipments that have not been tendered to FedEx. The request would cancel one/all packages within the shipment.

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-DeleteShipment
MinimumSamplePayload-DeleteShipment

accountNumber required	object The account number (account value) associated with the shipment.
deletionControl	string Enum: "DELETE_ALL_PACKAGES" "DELETE_ONE_PACKAGE" Specifies which packages in a shipment to be canceled. Valid Values are DELETE_ONE_PACKAGE which will cancel only the single package indicated in the trackingNumber element below. DELETE_ALL_PACKAGESwhich will cancel all tracking numbers associated to the shipment.
trackingNumber required	string This is an unique number assigned by FedEx to the packages for tracking. Example: "794953555571"
resourceKey	string This is a unique number assigned by FedEx to the packages for tracking. This will help in the identification of the dangerous goods shipments to mark it for removal on the manifest report.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

put /ship/v1/consolidations/shipments/delete

Sandbox Server

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

Production Server

https://apis.fedex.com/ship/v1/consolidations/shipments/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"accountNumber":
{
- "value": "123456789"
},
"deletionControl": "DELETE_ONE_PACKAGE",
"trackingNumber": "794953555571",
"resourceKey": "86ea9b69e068191a59f0e2721b8fbfee"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "cancelledShipment": true,
- "message": "Success",
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Delete Consolidation

Delete Consolidation endpoint is intended to delete a new consolidation request with preliminary information ( Shipper, recipient, origin info etc.,) so that the customers can consolidate their shipments.

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 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.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_deleteConsolidation
MinimumSamplePayload-deleteConsolidation

accountNumber required	object (AccountNumber) This is the FedEx Account number. Example: 123456789
consolidationKey required	object (ConsolidationKey) Identifies the consolidation to which this open shipment should be added after successful creation.
trackingId required	object (TrackingIds) The field is present to allow use of preassigned Master Airway Bill tracking number.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/consolidations/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/consolidations/delete

Production Server

https://apis.fedex.com/ship/v1/consolidations/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"accountNumber":
{
- "value": "123456789"
},
"consolidationKey":
{
- "date": "2019-11-28",
- "index": "2710",
- "type": "INTERNATIONAL_PRIORITY_DISTRIBUTION"
},
"trackingId":
{
- "trackingIdType": "EXPRESS",
- "formId": "0201",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"customerTransactionId": "AnyCo_order123456789",
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"output":
{
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Consolidation API

Introduction

Consolidation API Details

International DirectDistribution Service

International Paperwork

Consolidation Shipment Process

How Consolidation API Works

Business Rules

JSON API Collection

ShipConsolidation (API)

Modify Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Create Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Create Consolidation Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

ConsolidationShipmentResults

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm Consolidation Results

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Consolidation

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Consolidation Shipments

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Consolidation

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in