Consolidation API

Introdução

A API de consolidação permite consolidar uma recolha de expedições individuais para desalfandegamento numa única entrada. Após o desalfandegamento, a expedição é dividida em expedições mais pequenas no país de destino para distribuição a destinatários individuais. Esta API é vantajosa para expedidores que pretendam consolidar as respetivas expedições internacionais FedEx Express^® e Ground^®.
A Expedição Ground de consolidação é específica a expedições no Canadá e permite que os expedidores americanos qualificados consolidem expedições FedEx Ground para distribuição no Canadá através do FedEx Logistics^® ou de um despachante à escolha. Após a expedição ser desalfandegada pela alfândega canadiana como uma única expedição, será dividida em expedições individuais mais pequenas no Canadá. Terá acesso a todos os serviços FedEx após a sua expedição ter sido desalfandegada.

Nota:

O número de conta deve ser ativado com os serviços da API de consolidação para executar transações da API.
As Consolidações e as expedições de Consolidação serão eliminadas se não forem confirmadas até ao final do quinto dia a partir da criação das Consolidações.

Detalhes da API de consolidação

A API de consolidação disponibiliza o desalfandegamento da expedição na alfândega de destino como uma única expedição. Toda a expedição é consignada a apenas um Importador registado (IOR) e é dada entrada em nome do mesmo. A expedição também tem de ser proveniente de apenas um exportador registado. As peças individuais da expedição são entregues ao destinatário indicado em cada etiqueta da expedição FedEx Express ou Manifesto Express.
A expedição de consolidação também disponibiliza um Ponto Único de Desalfandegamento (SPOC), o que permite enviar uma expedição consolidada que inclua volumes para vários países da União Europeia.
As normas e restrições relativas ao tamanho, peso e tipos de mercadoria do serviço International Priority Freight (IPF) aplicam-se a volumes individuais numa carga consolidada.
Nota: é necessário ter um contrato de serviço registado na FedEx antes de poder processar as suas expedições de consolidação. Para obter mais informações, contacte os seus Gerentes de conta FedEx.

Serviço International DirectDistribution

A API de consolidação permite aos clientes utilizar a Distribuição direta ao enviar mais do que um volume internacionalmente, mediante a condição de o país de destino desses volumes ser o mesmo.
O serviço de Distribuição direta melhora o tempo de entrega e reduz as taxas de desalfandegamento, assim como os custos de armazém para os expedidores. A FedEx consolida as suas expedições que vão para a mesma localização (país estrangeiro) para desalfandegamento e, em seguida, desconsolida-as para entrega direta aos seus clientes.
Os clientes também já podem enviar expedições do Canadá para os EUA através do serviço International DirectDistribution (IDD, anteriormente denominado serviço Transborder Distribution). As FedEx International DirectDistribution Surface Solutions (IDD Surface) fornecem aos clientes do Canadá e do México uma opção de entrega consolidada transfronteiriça para enviar para vários destinatários nos EUA. O International DirectDistribution (IDD) tem de estar sediado no Canadá ou no México e tem de ser configurada uma ID de estação de entrega na conta indicada.

Documentação internacional

Os relatórios de expedição detalhados da CCI (Fatura comercial consolidada) representam um dos relatórios alfandegários obrigatórios para que a expedição consolidada atravesse com sucesso a fronteira internacional para o país de destino.

Os Detalhes da expedição da CCI (Fatura comercial consolidada) fornecem as seguintes informações:

O relatório de Detalhes da expedição da CCI (Fatura comercial consolidada) fornece informações para todos os volumes de entradas de despachante na consolidação e agrupa ou lista os mesmos por "Comprador" (ou seja, "Emissor da ordem").
Nota: as expedições secundárias são listadas na CCI (Fatura comercial consolidada) tendo em conta uma das condições seguintes:
- As expedições secundárias que não se qualificam para a Secção 321 são listadas na entrada da CCI (Fatura comercial consolidada) para alfândega pelo Alfandegário designado.
- O expedidor especifica que todas as expedições secundárias na consolidação têm de ser enviadas para entrada pelo Alfandegário.

O relatório de Transporte entre terminais de IDD fornece as seguintes informações:

Quais os Compradores e as expedições associadas que se qualificam para a Secção 321 e a PAPS.
A estação de entrega e o endereço.
Informações sobre as instalações ou estação de entrega de terceiros.

Nota: este relatório também é conhecido como Relatório de Transporte entre terminais da alfândega consolidado e é gerado para expedições nacionais nos EUA do Canadá ou do México.

Serviços International DirectDistribution: a tabela de serviços FedEx Express e FedEx Ground indica os serviços da FedEx U.S. disponíveis em expedições do serviço International DirectDistribution após darem entrada nos EUA.

Serviços FedEx Express ‑ FedEx International Priority DirectDistribution (IPD)

Necessidade de expedição	Serviço disponibilizado
Logo de manhã no Dia útil seguinte.	FedEx First Overnight^®
Manhã do Dia útil seguinte.	FedEx Priority Overnight^®
Tarde do Dia útil seguinte.	FedEx Standard Overnight^®
Dois dias úteis.	FedEx 2Day^®
Segundo dia útil às 10h30 na maioria das áreas comerciais. Em determinadas expedições para o Alasca e Havai, a entrega demora três dias úteis.	FedEx 2Day^® A.M
Três dias úteis.	FedEx Express Saver^®
Demora um, dois ou três dias úteis nos EUA para volumes com mais de 68 kg cada.	FedEx 1Day^® Freight FedEx 2Day^® Freight FedEx 3Day^® Freight

Serviços FedEx Ground ‑ International DirectDistribution (IDD) Surface Solutions

Necessidade de expedição	Serviço disponibilizado
Entrega por via terrestre económica para empresas.	FedEx Ground^®
Entrega por via terrestre económica para residências nos EUA.	FedEx Home Delivery^®

Seguem-se os serviços de expedições disponíveis para esta API de consolidação.

Serviços FedEx Express International DirectDistribution

Os serviços International Priority DirectDistribution (IPD) e International Economy DirectDistribution (IED) disponibilizam o desalfandegamento de expedições FedEx Express^® consolidadas numa única entrada e a entrega a destinatários individuais no país de destino. São serviços disponibilizados apenas mediante contrato.
O serviço International DirectDistribution (IDD) permite expedições consolidadas transfronteiriças do Canadá e México para vários destinatários nos Estados Unidos.

Serviço FedEx Express International DirectDistribution Freight

Pode consolidar e enviar expedições de carga multi-peças (com mais de 68 kg/150 libras) através do FedEx International Priority DirectDistribution Freight (IDF). Todas as peças têm de ser colocadas em paletes de face única para serem enviadas através do IDF. O International Priority DirectDistribution Freight (IDF) permite utilizar uma Carta de porte internacional FedEx^® para consolidar expedições de uma única localização de origem para vários destinatários num país de destino. Depois de a sua expedição entrar em território norte-americano, pode ser gerida pelos serviços FedEx U.S., como o FedEx Express, FedEx Ground e FedEx Home Delivery.

Processo da Expedição de consolidação

As Expedições de consolidação podem ser processadas de duas maneiras: de forma síncrona ou assíncrona, consoante o número de volumes por expedição ou as mercadorias ao nível de volume numa expedição.
Para um processamento de forma síncrona, uma transação só pode ter 40 volumes secundários por consolidação.
Se a transação for processada de forma síncrona, a resposta terá as etiquetas de volumes e os relatórios de expedições, como FC (Fatura comercial).
Se a transação for processada de forma assíncrona, a resposta a este pedido apenas confirma que o pedido foi colocado em fila com êxito para processamento assíncrono. A expedição pode não ser processada com êxito. Assim, terá de ser utilizado o método Resultados da Expedição de consolidação correspondente para verificar se as expedições foram processadas com êxito. Aguarde algum tempo para que a expedição seja processada com êxito antes de obter os resultados.

Pode seguir os passos seguintes para processar a expedição de forma assíncrona:

Criar consolidação: utilize este ponto final para criar uma nova consolidação com um índice único. A resposta bem-sucedida irá gerar um número de rastreio de consolidação.
Nota: se o índice não for fornecido no pedido, o número de rastreio será considerado como o índice.
Criar expedição de consolidação: utilize este ponto final para criar uma expedição assíncrona para mais de 40 volumes. A resposta bem-sucedida irá gerar um jobID de expedição de consolidação.
Resultados de expedição de consolidação: utilize este ponto final com o jobID gerado para obter o número de rastreio da expedição e as etiquetas.
Confirmar consolidação: utilize este ponto final com o tipo de consolidação e o Índice gerado para confirmar a sua consolidação criada. A resposta bem-sucedida irá gerar um jobID
Confirmar resultados de consolidação: utilize este ponto final com o jobID gerado a partir de Confirmar consolidação para obter os números de rastreio, as etiquetas e a documentação da sua consolidação.

Pode seguir estes passos para processar a expedição de forma síncrona –

Criar consolidação: utilize este ponto final para criar uma nova consolidação com um índice único. A resposta bem-sucedida irá gerar um número de rastreio de consolidação.
Nota: se o índice não for fornecido no pedido, o número de rastreio será considerado como o índice.
Criar expedição de consolidação: utilize este ponto final para criar uma expedição síncrona inferior ou igual a 40 volumes. A resposta bem-sucedida irá gerar números de rastreio da expedição de consolidação e etiquetas.
Confirmar consolidação: utilize este ponto final com o tipo de consolidação e o Índice gerado para confirmar a sua consolidação criada. A resposta bem-sucedida irá gerar um jobID
Confirmar resultados de consolidação: utilize este ponto final com o jobID gerado a partir de Confirmar consolidação para obter os números de rastreio, as etiquetas e a documentação da sua consolidação.

Pode seguir estes passos para modificar ou eliminar quaisquer consolidações ou expedições de consolidação criadas –

Modificar consolidações: utilize este ponto final para modificar informações de um pedido de Consolidação existente antes de a consolidação ser confirmada.
Eliminar expedição de consolidação: utilize este ponto final para cancelar expedições FedEx Express, Express Freight e Ground que não tenham sido apresentadas à FedEx. A resposta bem-sucedida irá mostrar o estado Eliminado da expedição de consolidação e gerar o elemento "cancelledShipment": true.
Eliminar consolidação: utilize este ponto final para eliminar uma consolidação antes de ser confirmada.
Nota: isto também irá eliminar todos os volumes de expedição que foram processados como parte da consolidação.
Obter consolidação: utilize este ponto final para obter os detalhes da sua consolidação.

Como funciona a API de consolidação

Seguem-se as funcionalidades principais associadas à API de consolidação:

Criar consolidações

Utilize este ponto final para criar uma consolidação com as informações de consolidação necessárias.
As informações de introdução principais associadas a este pedido são:

Número de conta – o número de conta da expedição FedEx
requestedConsolidation
- Tipo de consolidação – especifique o tipo de consolidação.
- Expedidor – forneça as informações do expedidor juntamente com o Número de identificação fiscal (TIN)
- Especificação da etiqueta – indique todos os detalhes de tipo de imagem, formato de impressora e stock de etiquetas.
- Detalhes de distribuição international
  - Moedas declaradas
  - Dimensões totais
  - ID de estação da instalação de desalfandegamento
- Detalhes de desalfandegamento – indique o Importador registado.
- Documentos de consolidação – especifique a documentação necessária quando a consolidação for confirmada.

A resposta bem-sucedida a este pedido irá criar a consolidação e gerar a Identificação de rastreio principal e a Chave de consolidação. Tenha em atenção que não serão geradas etiquetas na resposta.

Modificar consolidações

Utilize este ponto final para modificar informações de um pedido de Consolidação existente antes de a consolidação ser confirmada.
As informações de introdução principais associadas a este pedido são:

Chave de consolidação – especifique o Tipo de consolidação, Índice e data de consolidação a partir de Criar resposta de consolidação.
Número de conta – o número de conta da expedição FedEx.
requestedConsolidation
- Tipo de consolidação – indique o tipo de consolidação.
- Expedidor
- Especificação da etiqueta – especifique detalhes sobre o tipo de imagem, formato de impressora e stock de etiquetas. Também pode especificar detalhes específicos do cliente, como conteúdo do separador de documentos, etiquetas regulamentares e dados dissimulados na etiqueta
- Desalfandegamento – especifique os detalhes de desalfandegamento com o Importador registado.

O pedido bem-sucedido irá atualizar as informações pretendidas e devolver os detalhes de consolidação atualizados.

Obter consolidação

Utilize este ponto final para obter a consolidação da Chave de consolidação indicada. As informações de introdução principais associadas a este pedido são:

Número de conta – o número de conta da expedição FedEx.
Chave de consolidação – especifique o Tipo de consolidação, Índice e data de consolidação a partir de Criar consolidação.

O pedido bem-sucedido irá obter os detalhes de consolidação.

Eliminar consolidação

Utilize este ponto final para eliminar a consolidação aberta antes de a consolidação ser confirmada.
Nota: se necessário, este ponto final deve ser utilizado antes de Confirmar consolidação.

As informações de introdução principais associadas a este pedido são:

Número de conta – o número de conta da expedição FedEx.
Chave de consolidação – especifique o Tipo de consolidação, Índice e data de consolidação.
TrackingId – especifique a Identificação de rastreio principal gerada em Criar resposta de consolidação.

O pedido bem-sucedido irá eliminar a consolidação pretendida e devolver o transactionID e o estado do elemento cancelledShipment como true no resultado.

Criar uma Expedição de consolidação

Utilize este ponto final para adicionar os volumes de expedição sob uma chave de consolidação.
Nota: são necessárias um mínimo de 2 expedições para criar a expedição de consolidação.

As informações de introdução principais associadas a este pedido são:

Opções de resposta de etiqueta – deve ser URL_ONLY/LABEL
Ação de expedição aberta – CONFIRMAR
Número de conta – o número de conta da expedição FedEx.
Chave de consolidação – especifique o Tipo de consolidação, Índice e data de consolidação a partir de Criar consolidação.
requestedShipment
- Tipo de consolidação – especifique o tipo de consolidação
- Informações do expedidor
- Informações dos destinatários
- Tipo de Recolha
- Tipo de serviço – forneça tipos de serviço Express/Ground
- Tipo de Embalagem
- Tipo de pagamento da expedição (SENDER/THIRD_PARTY e Payor ACCOUNT)
- Detalhes de desalfandegamento
- Itens de linha do volume
  - peso
  - mercadorias

A resposta bem-sucedida para 40 ou menos volumes secundários por consolidação numa expedição irá carregar os dados da expedição dos sistemas da FedEx e gerar números de rastreio e etiquetas de volume. A resposta de confirmação bem-sucedida para mais de 40 volumes secundários por consolidação numa expedição confirma que o pedido foi colocado em fila com sucesso e devolve o jobId para obter o resultado mais tarde ao utilizar Resultados da expedição de consolidação.

Confirmar consolidação

Utilize este ponto final para confirmar a consolidação.
As informações de introdução principais associadas a este pedido são:

Número da Conta
processingOptionType – ALLOW_ASYNCHRONOUS
Chave de consolidação
Especificação da etiqueta

A resposta bem-sucedida a este pedido irá disponibilizar resultados de processamento assíncrono, o jobID e os detalhes da consolidação concluída, que incluem detalhes dos elementos shipmentRoleType e requestedShipments, assim como outras informações da expedição.

Confirmar resultados de consolidação

Utilize este ponto final para concluir uma consolidação. Se a consolidação for concluída, a resposta devolve a memória intermédia da etiqueta e quaisquer documentos aplicáveis.

As informações de introdução principais associadas a este pedido são:

jobId
Número da Conta

A resposta bem-sucedida a este pedido irá devolver os resultados da Expedição de consolidação confirmada, que incluem informações específicas da etiqueta, documentos de expedição ou o número de rastreio.

Resultados da Expedição de consolidação

Utilize este ponto final para validar e carregar os dados da Expedição de consolidação para os Sistemas da FedEx assim que todos os volumes forem adicionados no pedido de Expedição. Este ponto final disponibiliza a opção de verificar se o processamento assíncrono de expedições em aberto foi concluído. Caso se verifique, as etiquetas e os documentos aplicáveis serão devolvidos na resposta. As empresas de operações deste pedido são a FedEx Express e a FedEx Ground.
As informações de introdução principais associadas a este pedido são:

jobId
Número da Conta

A resposta bem-sucedida a este pedido irá disponibilizar os detalhes de expedições, que inclui o número de rastreio da expedição e as Etiquetas.

Eliminar Expedições de consolidação

Utilize este ponto final para cancelar expedições FedEx Express, Express Freight e Ground não apresentadas à FedEx.
As informações de introdução principais associadas a este pedido são:

Número da Conta
Número de rastreio
deletionControl – DELETE_ALL_PACKAGES

A resposta bem-sucedida a este pedido irá mostrar o estado Eliminado da expedição de consolidação e gerar o elemento "cancelledShipment": true.

Regras Empresariais

É permitido um máximo de 300 volumes numa expedição única.
Atualmente, é permitido um total combinado de 400 volumes numa consolidação única para uma consolidação da FedEx.
É permitido um máximo de 999 mercadorias únicas (FedEx Express e FedEx Ground, conforme adequado) por consolidação. Normalmente, existem menos mercadorias numa consolidação.
Só são permitidas as taxas de transporte e direitos e taxas Cobrança ao remetente e Cobrança a terceiros.
Não pode enviar uma peça individual numa expedição International Priority DirectDistribution Freight com menos de 68 kg (ou 151 lb).
Introduza dados de tamanho e peso de pacote pequeno que não excedam as restrições atuais de peso e tamanho do FedEx Express, FedEx Ground e FedEx Home Delivery dentro dos EUA.
O Pagamento contra entrega não está disponível na API de consolidação da FedEx.
Pode selecionar uma única moeda para o Valor alfandegário de toda a transação. Após a Expedição de consolidação da FedEx ser aberta, a moeda selecionada para o primeiro volume na expedição permanece o mesmo para os restantes volumes na consolidação.
Se enviar volumes através do FedEx Ground ou FedEx Home Delivery, terá de introduzir as medidas em libras (LB) e polegadas (IN).
As Consolidações e as expedições de Consolidação serão eliminadas se não forem confirmadas até ao final do quinto dia a partir da criação das Consolidações.

Recolha da API JSON

ShipConsolidation (API)

Modify Consolidations

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

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
authorization required	string Example: Bearer XXXXX This is the confidential client token which authorize the user.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

Request Body schema: application/json

One of

Full_Schema_ModifyConsolidation
SamplePayload-ModifyConsolidation

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/consolidations

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Create Consolidations

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

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
authorization required	string Example: Bearer XXXXX This is the confidential client token which authorize the user.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

Request Body schema: application/json

One of

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

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations

Sandbox Server

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

Production Server

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

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Create Consolidation Shipment

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

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_CreateConsolidationShipment
CreateConsolidationShipment_Sync_IPD
CreateConsolidationShipment_Async_IPD
CreateConsolidationShipment_Sync_IED
CreateConsolidationShipment_Async_IED
CreateConsolidationShipment_Sync_IDF
CreateConsolidationShipment_Sync_IGD
CreateConsolidationShipment_Sync_TD

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/shipments

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

ConsolidationShipmentResults

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

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

ConsolidationShipmentResultsInputVO
MinimumSamplePayload-ConsolidationShipmentResults

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/results

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Confirm Consolidations

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

header Parameters

X-locale	string Example: en_US ISO locale
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
authorization required	string Example: Bearer XXXXX This is the confidential client token which authorize the user.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

Request Body schema: application/json

One of

Full_Schema_ConfirmConsolidation
MinimumSamplePayload-confirmConsolidation

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/confirmations

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Confirm Consolidation Results

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

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_ConfirmConsolidationResults
MinimumSamplePayload-confirmConsolidationResults

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/confirmationresults

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Retrieve Consolidation

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

header Parameters

X-locale	string Example: en_US ISO locale
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_RetrieveConsolidation
MinimumSamplePayload-RetrieveConsolidation

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/consolidations/retrieve

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Delete Consolidation Shipments

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

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-DeleteShipment
MinimumSamplePayload-DeleteShipment

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

put /ship/v1/consolidations/shipments/delete

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Delete Consolidation

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

header Parameters

X-locale	string Example: en_US These are locale details. Example: 'en_US' click here to see locales Note: If the locale is left blank or an invalid locale is entered, an error message is returned in response.
X-customer-transaction-id	string Example: AnyCo_order123456789 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_deleteConsolidation
MinimumSamplePayload-deleteConsolidation

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/consolidations/delete

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

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

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Request
Response

Response

Copy

Developer Portal

Consolidation API

Introdução

Detalhes da API de consolidação

Serviço International DirectDistribution

Documentação internacional

Processo da Expedição de consolidação

Como funciona a API de consolidação

Regras Empresariais

Recolha da API JSON

ShipConsolidation (API)

Modify Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Create Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Create Consolidation Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

ConsolidationShipmentResults

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm Consolidations

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm Consolidation Results

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Consolidation

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Consolidation Shipments

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Consolidation

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in