ShipConsolidation

DOWNLOAD JSON SCHEMA

Inleiding

Met de consolidatie-API kunt u afzonderlijke zendingen consolideren voor douaneafhandeling bij een enkele invoer. Na de afhandeling wordt de zending opgesplitst in kleinere zendingen in het land van bestemming om te distribueren naar afzonderlijke ontvangers. Deze API is gunstig voor afzenders die hun FedEx Express^®- en International Ground^®-zendingen willen consolideren.
De Consolidation Ground-zending is specifiek voor Canadese zendingen en geeft gekwalificeerde Amerikaanse afzenders de mogelijkheid FedEx Ground-zendingen te consolideren voor distributie binnen Canada via FedEx Logistics^® of een inklaringsagent naar keuze. Zodra de zending als een enkele zending door de Canadese douane is ingeklaard, wordt deze in Canada in afzonderlijke kleinere zendingen verdeeld. U hebt toegang tot het alle FedEx-services nadat uw zending door de douane is ingeklaard.

Opmerking:

Het accountnummer moet zijn ingeschakeld voor de consolidatie-API-services om API-transacties uit te voeren.
De consolidaties en consolidatiezendingen worden verwijderd als ze niet binnen het einde van de vijfde dag na het aanmaken van de consolidatie worden bevestigd.

Details consolidatie-API

De consolidatie-API biedt de mogelijkheid om een enkele zending door de douane te laten inklaren op de plaats van bestemming. De hele zending wordt verzonden naar (en ingeschreven met) de naam van slechts één officiële importeur (IOR). De zending moet ook afkomstig zijn van één officiële exporteur. Individuele stukken binnen de zending worden afgeleverd aan de ontvanger die op elk FedEx Express Shipping- of Express Manifest-label staat aangegeven.
Consolidatiezending biedt ook Single Point of Clearance (SPOC), waarmee u een geconsolideerde zending kunt versturen die pakketten voor meerdere landen in de Europese Unie bevat.
Normen en beperkingen van International Priority Freight (IPF) voor grootte, gewicht en type artikelen zijn van toepassing op afzonderlijke pakketten in een vrachtconsolidatiezending.
Opmerking: U moet een servicecontract met FedEx hebben voordat u uw consolidatiezendingen kunt verwerken. Voor meer informatie neemt u contact op met uw FedEx accountmanager.

International DirectDistribution-service

De consolidatie-API stelt klanten in staat gebruik te maken van Direct Distribution wanneer zij meer dan één pakket internationaal verzenden, op voorwaarde dat het land van bestemming voor al deze pakketten hetzelfde is.
De service Direct Distribution verbetert de levertijden en vermindert de inklarings- en magazijnkosten voor afzenders. FedEx consolideert de zendingen van klanten die naar dezelfde locatie (het buitenland) worden vervoerd voor douaneafhandeling en heft de consolidatie vervolgens weer op voor rechtstreekse levering aan uw klanten.
Klanten kunnen nu ook zendingen vanuit Canada naar de VS sturen door middel van de service International DirectDistribution (IDD) (voorheen de service Transborder Distribution). FedEx International DirectDistribution Surface Solutions (IDD Surface) biedt klanten uit Canada en Mexico een geconsolideerde, grensoverschrijdende afleveroptie voor verzending naar meerdere ontvangers in de VS. International DirectDistribution (IDD) moet in Canada of Mexico zijn gevestigd en er moet een ID van de afleverlocatie voor het opgegeven account zijn ingesteld.

Internationale documenten

De geconsolideerde handelsfactuur (CCI) met zendingsgegevens is een van de minimaal vereiste douanedocumenten die nodig zijn om de geconsolideerde zending de internationale grens van het land van bestemming te laten passeren.

De zendingsgegevens van de geconsolideerde handelsfactuur bevatten de volgende informatie:

Het rapport met zendingsgegevens van de geconsolideerde handelsfactuur levert de verzendinformatie voor alle pakketten in de consolidatie die via een inklaringsagent lopen (PAPS) en groepeert/vermeldt de pakketten per 'koper' (d.w.z. de partij 'Verkocht aan').
Opmerking: onderliggende zendingen worden vermeld in de geconsolideerde handelsfactuur onder één van de volgende voorwaarden:
- Onderliggende zendingen die niet voldoen aan de voorwaarden van Sectie 321, worden vermeld in de geconsolideerde handelsfactuur voor douane-invoer door de aangewezen agent.
- De afzender geeft aan dat alle onderliggende zendingen in de consolidatie voor invoer moeten worden ingediend door de agent.

Het IDD-linehaulrapport bevat de volgende informatie:

Welke kopers en bijbehorende zendingen in aanmerking komen voor Sectie 321 en welke voor PAPS.
De afleverlocatie en het afleveradres.
Informatie over de afleverlocatie of -faciliteit van derden.

Opmerking: Dit rapport wordt ook wel een geconsolideerd douane-linehaulrapport genoemd en wordt gegenereerd voor inkomende zendingen uit Canada of Mexico.

In de tabel International DirectDistribution-services – FedEx Express- en FedEx Ground-services vindt u een overzicht van de services van FedEx in de VS die beschikbaar zijn voor Internationale DirectDistribution-zendingen nadat ze de VS zijn binnengekomen.

FedEx Express Services - International Priority DirectDistribution (IPD)

Verzendbehoefte	Aangeboden service
Vroegste aflevering 's ochtends op de volgende werkdag.	FedEx First Overnight^®
's Ochtends op de volgende werkdag.	FedEx Priority Overnight^®
's Middags op de volgende werkdag.	FedEx Standard Overnight^®
2 werkdagen.	FedEx 2Day^®
Binnen 2 werkdagen om 10:30 uur naar de meeste zakelijke gebieden; voor bepaalde zendingen naar Alaska en Hawaï is de levertijd 3 werkdagen.	FedEx 2Day^® A.M.
3 werkdagen.	FedEx Express Saver^®
Binnen 1, 2 of 3 werkdagen binnen de VS voor pakketten van meer dan 68 kg per stuk.	FedEx 1Day^® Freight, FedEx 2Day^® Freight, FedEx 3Day^® Freight

FedEx Ground Services - International Priority DirectDistribution (IPD) Surface-oplossingen

Verzendbehoefte	Aangeboden service
Betaalbare levering over land naar zakelijke adressen.	FedEx Ground^®
Betaalbare levering over land naar woonadressen in de VS.	FedEx Home Delivery^®

Hieronder volgen de services voor zendingen die beschikbaar zijn voor de consolidatie-API.

FedEx Express International DirectDistribution-services

De International Priority DirectDistribution- (IPD) en de International Economy DirectDistribution-service (IED) bieden geconsolideerde FedEx Express^®-zendingen die bij de douane in één keer worden ingeklaard en daarna worden afgeleverd bij individuele ontvangers in het land van bestemming. Deze services worden enkel op contractuele basis aangeboden.
International DirectDistribution (IDD) maakt geconsolideerde, internationale zendingen vanuit Canada en Mexico naar verschillende ontvangers in de Verenigde Staten mogelijk.

FedEx Express International DirectDistribution Freight-service

U kunt vrachtzendingen met meerdere delen (meer dan 68 kg) consolideren en verzenden met FedEx International Priority DirectDistribution Freight (IDF). Alle stukken moeten op een pallet worden geplaatst om als IDF te verzenden. International Priority DirectDistribution Freight (IDF) maakt het mogelijk om met één internationale luchtvrachtbrief van FedEx^® zendingen te consolideren van één locatie van herkomst naar verschillende ontvangers in één land van bestemming. Nadat uw zending de VS is binnengekomen, kan deze worden beheerd door FedEx U.S.-services, waaronder FedEx Express, FedEx Ground en FedEx Home Delivery.

Proces van consolidatiezending

Consolidatiezendingen kunnen op twee manieren worden verwerkt, synchroon en asynchroon, afhankelijk van het aantal pakketten per zending of het pakketniveau van de artikelen in een zending.
Voor een synchrone verwerking mag een transactie maximaal 39 onderliggende pakketten per consolidatie bevatten.
Als de transactie synchroon wordt verwerkt, bevat het antwoord de pakketlabels en verzendrapporten, zoals de handelsfactuur (CI).
Als de transactie asynchroon wordt verwerkt, bevestigt het antwoord alleen dat het verzoek in een wachtrij is geplaatst voor asynchrone verwerking. Mogelijk is de zending zelf niet verwerkt, waardoor de overeenkomstige methode Resultaten van consolidatiezending moet worden gebruikt om te controleren of de zendingen zijn verwerkt. Geef de zendingen wat tijd om te worden verwerkt, voordat u de resultaten ophaalt.

De volgende stappen kunnen worden gevolgd om de zending asynchroon te verwerken:

Consolidatie maken: gebruik dit eindpunt om een nieuwe consolidatie met een unieke index te maken. De succesvolle respons genereert de trackingnummers van de consolidatie.
Opmerking: indien de index niet in het verzoek wordt vermeld, wordt het trackingnummer als index beschouwd.
Consolidatiezending maken: gebruik dit eindpunt voor het maken van een asynchrone zending voor meer dan 40 pakketten. De succesvolle respons genereert een jobID van de consolidatiezending.
Resultaten consolidatiezending: gebruik dit eindpunt met de gegenereerde jobID om het trackingnummer en de labels van de zending te verkrijgen.
Consolidatie bevestigen: gebruik dit eindpunt met het consolidatietype en de gegenereerde index om uw gemaakte consolidatie te bevestigen. De succesvolle respons genereert een jobID
Consolidatieresultaten bevestigen: gebruik dit eindpunt met de gegenereerde jobID uit Consolidatie bevestigen om de trackingnummers, labels en documenten voor uw consolidatie te verkrijgen.

Volg de volgende stappen om de zending synchroon te verwerken:

Consolidatie maken: gebruik dit eindpunt om een nieuwe consolidatie met een unieke index te maken. De succesvolle respons genereert de trackingnummers van de consolidatie.
Opmerking: indien de index niet in het verzoek wordt vermeld, wordt het trackingnummer als index beschouwd.
Consolidatiezending maken: gebruik dit eindpunt om een synchrone zending te maken voor maximaal 40 pakketten. De succesvolle respons genereert de trackingnummers en labels van de consolidatiezending.
Consolidatie bevestigen: gebruik dit eindpunt met het consolidatietype en de gegenereerde index om uw gemaakte consolidatie te bevestigen. De succesvolle respons genereert een jobID
Consolidatie bevestigen: gebruik dit eindpunt met de gegenereerde jobID uit Consolidatie bevestigen om de trackingnummers, labels en documenten voor uw consolidatie te verkrijgen.

De volgende stappen kunnen worden gevolgd om een gemaakte consolidatie of consolidatiezending te wijzigen of te verwijderen:

Consolidaties wijzigen: gebruik dit eindpunt om de gegevens van een bestaand consolidatieverzoek te wijzigen voordat de consolidatie wordt bevestigd.
Consolidatiezending verwijderen: gebruik dit eindpunt om FedEx Express-, Express Freight- en Ground-zendingen te annuleren die niet aan FedEx zijn aangeboden. De succesvolle respons toont de status van de verwijderde consolidatiezending en genereert "cancelledShipment": true.
Consolidatie verwijderen: gebruik dit eindpunt om een consolidatie te verwijderen voordat deze is bevestigd.
Opmerking: hierdoor worden ook alle zendingspakketten verwijderd die als onderdeel van de consolidatie zijn verwerkt.
Consolidatie ophalen: gebruik dit eindpunt om de gegevens van uw consolidatie op te halen.

De consolidatie-API gebruiken

De belangrijkste kenmerken van de consolidatie-API zijn:

Consolidaties maken

Gebruik dit eindpunt om een consolidatie te maken met de vereiste consolidatiegegevens.
De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

Accountnummer - Het FedEx-accountnummer voor verzenden
requestedConsolidation
- consolidatietype - Geef het consolidatietype op
- Afzender: verstrek de gegevens van de afzender en het btw-nummer
- Labelspecificatie - Verstrek de gegevens over het type afbeelding, afdrukformaat en briefhoofd voor het label.
- Gegevens International Distribution
  - Aangegeven valuta
  - Totale afmetingen
  - ID van afhandelingslocatie
- Douaneafhandelingsgegevens: geef de officiële importeur op.
- Consolidatiedocumenten - Geef de documenten op die zijn vereist wanneer de consolidatie is bevestigd.

De succesvolle respons op dit verzoek brengt de consolidatie tot stand en genereert de mastertracking-id en consolidatiesleutel. Houd er rekening mee dat er geen labels worden gegenereerd in de respons.

Consolidaties wijzigen

Gebruik dit eindpunt om informatie te wijzigen van een bestaand consolidatieverzoek, voordat de consolidatie wordt bevestigd.
De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

Consolidatiesleutel - Geef het consolidatietype, de index en de consolidatiedatum op in de respons op Consolidatie maken.
Accountnummer - Het FedEx-accountnummer voor verzenden.
requestedConsolidation
- Consolidatietype: geef het consolidatietype op.
- Verzender
- Labelspecificatie - Verstrek de gegevens over het type afbeelding, afdrukformaat en briefhoofd voor het label. U kunt hier ook klantspecifieke gegevens specificeren zoals documenttekst, wettelijke labels en maskeergegevens op het label
- Douaneafhandeling - Geef de gegevens van de douaneafhandeling met de officiële importeur op.

Na een succesvol verzoek werken we de beoogde informatie bij en worden de bijgewerkte consolidatiegegevens weergegeven.

Consolidaties ophalen

Gebruik dit eindpunt om de consolidatie voor de opgegeven consolidatiesleutel op te halen. De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

Accountnummer - Het FedEx-accountnummer voor verzenden.
Consolidatiesleutel - Geef het consolidatietype, de index en de consolidatiedatum vanuit Consolidatie maken op

Bij een succesvol verzoek worden de consolidatiegegevens opgevraagd.

Consolidaties verwijderen

Gebruik dit eindpunt om de openstaande consolidatie te verwijderen voordat de consolidatie is bevestigd.
Opmerking: indien nodig, moet dit eindpunt worden gebruikt vóór Consolidatie bevestigen.

De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

Accountnummer - Het FedEx-accountnummer voor verzenden.
Consolidatiesleutel - Geef het consolidatietype, de index en de consolidatiedatum op.
TrackingId - Geef de mastertracking-id op die wordt gegenereerd in de respons op Consolidatie maken.

Na een succesvol verzoek wordt de beoogde consolidatie verwijderd en wordt in de uitvoer de transactionID en de status voor het element cancelledShipment als waar geretourneerd.

Consolidatiezending maken

Gebruik dit eindpunt om de pakketten van een zending toe te voegen onder één consolidatiesleutel.
Opmerking: er zijn minimaal twee zendingen nodig om een consolidatiezending te maken.

De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

Labelresponsopties - Moet URL_ONLY/LABEL zijn
Open verzendactie - BEVESTIGEN
Accountnummer - Het FedEx-accountnummer voor verzenden.
Consolidatiesleutel - Geef het consolidatietype, de index en de consolidatiedatum vanuit Consolidatie maken op
requestedShipment
- Consolidatietype - Geef het consolidatietype op
- Gegevens afzender
- Gegevens geadresseerden
- Type ophaling
- Servicetype - Geef de Express-/Ground-servicetypen op
- Type verpakking
- Betaalmethode voor zending (SENDER/THIRD_PARTY en Payor ACCOUNT)
- Douaneafhandelingsgegevens
- Pakket-lijnartikelen
  - gewicht
  - artikelen

Bij een succesvolle respons voor 40 of minder onderliggende pakketten per consolidatie in een zending, worden de verzendgegevens in de FedEx-systemen geüpload en worden trackingnummers en pakketlabels gegenereerd. Een succesvolle bevestigingsrespons voor meer dan 40 onderliggende pakketten per consolidatie in een zending bevestigt dat het verzoek in de wachtrij is geplaatst en retourneert de jobId om het resultaat later op te halen met behulp van Resultaten van de consolidatiezending.

Consolidatie bevestigen

Gebruik dit eindpunt om de consolidatie te bevestigen.
De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

Accountnummer
processingOptionType - ALLOW_ASYNCHRONOUS
Consolidatiesleutel
Labelspecificatie

Na het antwoord op dit verzoek worden asynchrone verwerkingsresultaten, een job-id en gegevens van een voltooide consolidatie weergegeven, waaronder shipmentRoleType, requestedShipments-gegevens en andere zendingsinformatie.

Consolidatie resultaten bevestigen

Gebruik dit eindpunt om een consolidatie te voltooien. Als de consolidatie is voltooid, retourneert de respons de labelbuffers en alle toepasselijke documenten.

De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

jobId
Accountnummer

Bij een succesvol antwoord op dit verzoek worden de bevestigde resultaten van de consolidatiezending geretourneerd, waaronder het trackingnummer en specifieke informatie over het verzenddocument of het etiket.

Resultaten van consolidatieverzoek

Gebruik dit eindpunt om de verzendgegevens van de consolidatiezending te valideren en te uploaden naar de FedEx-systemen zodra alle pakketten zijn toegevoegd aan het verzendverzoek. Dit eindpunt biedt de mogelijkheid om te controleren of de asynchrone verwerking van openstaande zendingen is voltooid. Zo ja, dan worden de etiketten en toepasselijke documenten als antwoord teruggezonden. De werkmaatschappijen voor dit verzoek zijn FedEx Express en FedEx Ground.
De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

jobId
Accountnummer

De succesvolle respons op dit verzoek levert de verzendgegevens, waaronder het trackingnummer en de labels.

Consolidatiezendingen verwijderen

Gebruik dit eindpunt om FedEx Express-, Express Freight- en Ground-zendingen te annuleren die niet aan FedEx zijn aangeboden.
De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:

Accountnummer
Trackingnummer
deletionControl - DELETE_ALL_PACKAGES

De succesvolle respons op dit verzoek toont de status van de verwijderde consolidatiezending en genereert de "cancelledShipment": true.

Bedrijfsregels

Er is een maximum van 300 pakketten per zending toegestaan.
Momenteel is een gecombineerd totaal van 400 pakketten in één consolidatie toegestaan voor een FedEx-consolidatie.
Maximaal 999 unieke artikelen (FedEx Express en FedEx Ground, indien van toepassing) per consolidatie. Meestal bevat een consolidatie veel minder artikelen.
Alleen 'Rekening afzender' en 'Rekening aan derden' zijn toegestaan voor transportkosten en voor btw en invoerrechten.
U kunt voor een Internationale Priority DirectDistribution-vrachtzending geen afzonderlijk stuk verzenden dat minder dan 68 kg weegt.
Gegevens over kleine formaten en het gewicht van een pakket, die de geldende afmetingen en het geldend gewicht binnen de Verenigde Staten van FedEx Express, FedEx Ground en FedEx Home Delivery niet overschrijden.
Rembourszending (COD, Collect on delivery) is niet beschikbaar met de consolidatie-API van FedEx.
U kunt een enkele valuta kiezen voor de opgegeven waarde voor de douane van de hele transactie. Nadat de consolidatiezending van FedEx is geopend, blijft de door u geselecteerde valuta voor het eerste pakket in de zending dezelfde voor alle andere pakketten in de consolidatie.
Als u pakketten verzendt met FedEx Ground of FedEx Home Delivery dan moet u de afmetingen in pond (LB) en inch (IN) coderen.
De consolidaties en consolidatiezendingen worden verwijderd als ze niet binnen het einde van de vijfde dag na het aanmaken van de consolidatie worden bevestigd.

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.

EXPAND ALL COLLAPSE ALL

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

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 - Modify Consolidations

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 - Modify Consolidations

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.

EXPAND ALL COLLAPSE ALL

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

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 - Create Consolidations

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 - Create Consolidations

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.

EXPAND ALL COLLAPSE ALL

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

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 - Create Consolidation Shipment

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 - Create Consolidation Shipment

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

EXPAND ALL COLLAPSE ALL

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

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

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples - ConsolidationShipmentResults

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 .

EXPAND ALL COLLAPSE ALL

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

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 - Confirm Consolidations

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 - Confirm Consolidations

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.

EXPAND ALL COLLAPSE ALL

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

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 - Confirm Consolidation Results

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples - Confirm Consolidation Results

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.

EXPAND ALL COLLAPSE ALL

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

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 - Retrieve Consolidation

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 - Retrieve Consolidation

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.

EXPAND ALL COLLAPSE ALL

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

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 - Delete Consolidation Shipments

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples - Delete Consolidation Shipments

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.

EXPAND ALL COLLAPSE ALL

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

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 - Delete Consolidation

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 - Delete Consolidation

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

ShipConsolidation DOWNLOAD JSON SCHEMA

Inleiding

Details consolidatie-API

International DirectDistribution-service

Internationale documenten

Proces van consolidatiezending

De consolidatie-API gebruiken

Bedrijfsregels

JSON API-verzameling

ShipConsolidation (API)

Modify Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples - Modify Consolidations

Response samples - Modify Consolidations

Create Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples - Create Consolidations

Response samples - Create Consolidations

Create Consolidation Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples - Create Consolidation Shipment

Response samples - Create Consolidation Shipment

ConsolidationShipmentResults

header Parameters

Request Body schema: application/json

Responses

Request samples - ConsolidationShipmentResults

Response samples - ConsolidationShipmentResults

Confirm Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples - Confirm Consolidations

Response samples - Confirm Consolidations

Confirm Consolidation Results

header Parameters

Request Body schema: application/json

Responses

Request samples - Confirm Consolidation Results

Response samples - Confirm Consolidation Results

Retrieve Consolidation

header Parameters

Request Body schema: application/json

Responses

Request samples - Retrieve Consolidation

Response samples - Retrieve Consolidation

Delete Consolidation Shipments

header Parameters

Request Body schema: application/json

Responses

Request samples - Delete Consolidation Shipments

Response samples - Delete Consolidation Shipments

Delete Consolidation

header Parameters

Request Body schema: application/json

Responses

Request samples - Delete Consolidation

Response samples - Delete Consolidation

Enter your user ID and password to log in

ShipConsolidation

DOWNLOAD JSON SCHEMA