Open Ship API

Introdução

Esta API permite que você crie uma remessa aberta e permite adicionar pacotes à remessa durante um determinado período, em vez de inserir todas as informações da remessa e do pacote de uma vez. A remessa permanece aberta por um período de cinco dias e permite acréscimos e modificações no pacote durante esse período. Assim que a remessa for confirmada, a documentação de envio, como etiquetas, AWB ou relatórios, poderá ser gerada. No final do quinto dia, a remessa deverá ser confirmada, caso contrário, ela será eliminada.

Observação: as remessas abertas serão eliminadas se não forem confirmadas no final do quinto dia a partir da criação da remessa.

Detalhes da API Open Ship

A API Open Ship é usada quando você deseja adicionar vários pacotes a uma remessa durante um determinado período e não tem certeza de quantos pacotes planeja adicionar ou quando a remessa será concluída. Isso oferece uma maneira flexível de preparar sua remessa ao longo do dia, até que você esteja pronto para enviá-la.

Geralmente, as remessas Open Ship têm vários volumes, mas também podem ter um único pacote, que são as chamadas remessas de volume único.

Para enviar uma remessa com vários volumes (MPS) para um único consignatário, use a API Open Ship e adicione pacotes individuais à remessa ou adicione vários pacotes se eles forem para o mesmo destinatário.

A seguir estão os serviços associados à remessa aberta:

FedEx Express^® dentro dos EUA e do Canadá
FedEx Ground^® dentro dos EUA e do Canadá
FedEx Home Delivery^®
FedEx International Priority^®
FedEx International Priority^® Express (IPE)
FedEx International Economy^®
FedEx Priority Overnight^TM
FedEx® Regional Economy
FedEx® Regional Economy Freight
FedEx International Connect Plus®
FedEx® First
FedEx Priority Express
FedEx Priority
FedEx Priority Express Freight
FedEx Priority Freight
FedEx Economy (Apenas Reino Unido)

A seguir estão os recursos associados à API Open Ship:

Gerenciar remessas abertas

Este recurso permite que os remetentes criem, modifiquem, excluam remessas abertas e possam recuperar a remessa aberta já criada para fins de revisão ou verificação. Ele permite confirmar a remessa completa para transferir seus dados à FedEx e gerar a documentação de remessa apropriada. Ele também identifica e relata os erros, se houver, na transação e apresenta o status apropriado.

As principais informações neste recurso são accountNumber, Shipment Data, groupPackageCount, index para indicar o pacote principal na remessa. O resultado desse recurso garantirá que os dados da remessa sejam carregados nos sistemas FedEx e que os números de rastreamento, as etiquetas e os relatórios de remessa sejam devidamente gerados.

Gerenciar pacotes de remessa aberta

Esse recurso permite que você adicione, modifique e exclua pacotes da remessa aberta já criada. Também é possível recuperar o pacote existente de uma remessa aberta existente.

Obter resultados da remessa aberta (assíncrono)

Este recurso permite recuperar os resultados da remessa confirmada de forma assíncrona. Quando uma remessa aberta com 40 ou mais pacotes é confirmada, a API processa a remessa de forma assíncrona.

Quando a remessa é processada de forma assíncrona, a resposta a esta solicitação apenas confirma que a solicitação foi enviada para a fila, mas a remessa pode ou não ser processada com êxito. Como resposta, ele retorna jobId para recuperar o resultado mais tarde. Esse recurso usa o jobId para recuperar os resultados da remessa (CRIAR, MODIFICAR E CONFIRAR), que podem ser etiquetas ou relatórios de remessa. Ele também identifica e relata os erros, se houver, na remessa e apresenta o status apropriado.

Observação: se houver erros na resposta da remessa assíncrona, corrija-os e envie uma nova solicitação de remessa.

Fluxo de trabalho da API Open Ship

Esta seção descreve em detalhes o fluxo de trabalho da API Open Ship. O fluxo de trabalho da Open Ship é gerenciado de duas maneiras ou usando duas opções de processamento:

Fluxo de trabalho para 40 pacotes ou menos

Use o endpoint Criar remessa aberta para criar uma remessa aberta com todas as informações de envio e embalagem necessárias, accountNumber e index.
Use o endpoint Adicionar pacotes à remessa aberta para adicionar um ou mais (não mais de 40) pacotes à remessa aberta já criada. As principais entradas são index e accountNumber da remessa aberta a qual os pacotes são adicionados.
Use o endpoint Confirmar remessa aberta para finalmente confirmar se todos os pacotes foram adicionados e a remessa foi concluída. As principais entradas são index e accountNumber da remessa a ser confirmada.

Confirmar remessa aberta é o endpoint final neste fluxo que valida a remessa e as informações do pacote e gera as etiquetas e todos os outros relatórios para a remessa. Ele também apresenta os detalhes dos erros retornados durante a validação. Esses erros podem ser corrigidos usando os endpoints Modificar remessa aberta ou Modificar pacotes da remessa aberta e confirmando a remessa novamente para que a solicitação seja bem-sucedida.

Fluxo de trabalho para mais de 40 pacotes

Use o endpoint Criar remessa aberta para criar uma remessa aberta com todas as informações de envio e embalagem necessárias, accountNumber e index.
Use o endpoint Adicionar pacotes à remessa aberta para adicionar um ou mais (não mais de 40) pacotes à remessa aberta já criada. As principais entradas são index e accountNumber da Remessa aberta a qual os pacotes são adicionados..
Use o endpoint Confirmar remessa aberta para confirmar se todos os pacotes foram adicionados e a remessa foi concluída. As principais entradas são index e accountNumber da remessa a ser confirmada. Neste caso, como há mais de 40 pacotes, a API processa a remessa de forma assíncrona e retorna jobId, que será usado mais tarde para recuperar os resultados da remessa. Se a resposta tiver erros, esses erros deverão ser corrigidos usando os endpoints Modificar remessa aberta ou Modificar pacotes da remessa aberta. Na sequência, confirme a remessa usando o endpoint Confirmar remessa aberta.
Use o endpoint Obter resultados da remessa aberta para recuperar os resultados da criação, modificação ou confirmação da remessa aberta, como etiquetas e documentação de envio. As principais entradas são jobId e accountNumber da remessa confirmada.

Obter resultados da remessa aberta é o endpoint final neste fluxo que recupera os resultados da remessa aberta confirmada, como etiquetas e todos os outros relatórios da remessa aberta confirmada. Se os detalhes dos erros forem retornados na resposta, esses erros poderão ser corrigidos usando os endpoints Modificar remessa aberta ou Modificar pacotes da remessa aberta. Na sequência, confirme a remessa usando o endpoint Confirmar remessa aberta e, por fim, use o endpoint Obter resultados da remessa aberta para recuperar os resultados da remessa aberta confirmada para a solicitação bem-sucedida.

Como funciona a API Open Ship

A seguir estão as funções associadas à API Open Ship:

Criar remessa aberta

Use esse endpoint para criar uma remessa aberta com as informações de remessa exigidas e definir, pelo menos, um pacote na remessa.

A seguir estão as informações de entrada necessárias para criar a remessa aberta:

openShipmentAction – Essa é a ação da remessa aberta e, neste caso, use o valor como CREATE_PACKAGE.
accountNumber – Esse é o número de conta FedEx.
requestedShipment – Os detalhes da remessa aberta.
index – Valor único para a remessa aberta, que é útil para modificar a remessa ou o pacote. Esse valor é opcional e, se não for fornecido, o número de rastreamento principal poderá ser usado para identificar exclusivamente a remessa.

A resposta bem-sucedida a essa solicitação processará a remessa e gerará um número de rastreamento, que é um número de rastreamento principal para o primeiro pacote. Observe que nenhuma etiqueta será gerada na resposta.

Adicionar pacotes à remessa aberta

Use esse endpoint para adicionar um ou mais pacotes à solicitação de remessa aberta existente antes que a remessa seja confirmada. Você pode enviar uma solicitação Adicionar pacote separada para cada um dos seus pacotes enquanto prepara sua remessa ao longo do dia. Você também pode enviar vários volumes na solicitação Adicionar pacote.

Observação: o número total de pacotes da remessa não deve exceder o limite de pacotes de Remessa aberta.

A seguir estão as informações de entrada necessárias para adicionar pacotes à remessa aberta:

index – Esse é um valor exclusivo atribuído à remessa aberta já criada. Se não estiver disponível, insira o número de rastreamento principal.
requestedPackageLineItem – Informações detalhadas do(s) pacote(s) que será(ão) adicionado(s).
accountNumber – Esse é o número de conta FedEx.

A resposta bem-sucedida a esta solicitação gera um número de rastreamento para o pacote recém-adicionado.

Modificar pacotes da remessa aberta

Use esse endpoint para modificar os detalhes de um ou mais pacotes de uma remessa Open Ship existente antes que ela seja confirmada. Isso também inclui o pacote principal, que é o primeiro pacote adicionado à remessa aberta.

A seguir estão as informações de entrada obrigatórias associadas a esta solicitação:

index – Esse é um valor exclusivo atribuído à remessa aberta já criada. Se não estiver disponível, insira o número de rastreamento principal.
accountNumber – Esse é o número de conta FedEx.
trackingId – O ID de rastreamento de um ou mais pacotes Open Ship que serão modificados.
requestedPackageLineItem – Informações detalhadas sobre o(s) pacote(s) que será(ão) modificado(s).

A solicitação bem-sucedida atualizará os pacotes desejados e retornará os detalhes atualizados da remessa.

Excluir pacotes da remessa aberta

Use esse endpoint para excluir um ou mais pacotes da remessa aberta já criada antes que ela seja confirmada.

A seguir estão as informações de entrada obrigatórias associadas a esta solicitação:

index – Esse é um valor exclusivo atribuído à remessa aberta já criada. Se não estiver disponível, insira o número de rastreamento principal.
accountNumber – Esse é o número de conta FedEx.
trackingId – ID de rastreamento de um ou mais pacotes Open Ship para os quais a solicitação de exclusão foi recebida.

A solicitação bem-sucedida excluirá os pacotes desejados e retornará o status do elemento deletedPackagesFromOpenshipment como true na saída.

Observação: se o pacote principal for excluído da remessa, o próximo pacote na sequência se tornará o principal e o número de rastreamento principal será reatribuído a ele. A sequência de números será diminuída de acordo com o número de pacotes excluídos.

Recuperar pacote da remessa aberta

Use esse endpoint para recuperar um ou mais pacotes da remessa aberta já criada para revisar ou verificar.

A seguir estão as informações de entrada obrigatórias associadas a esta solicitação:

index – Esse é um valor exclusivo atribuído à remessa aberta já criada. Se não estiver disponível, insira o número de rastreamento principal.
accountNumber – Esse é o número de conta FedEx.
trackingId – ID de rastreamento de um ou mais pacotes da remessa aberta para os quais os detalhes devem ser recuperados.

A solicitação bem-sucedida recuperará os pacotes desejados.

Modificar remessa aberta

Use esse endpoint para modificar uma solicitação de remessa aberta com as informações de remessa necessárias antes que ela seja confirmada.

A seguir estão as informações de entrada obrigatórias associadas a esta solicitação:

index – Esse é um valor exclusivo atribuído à remessa aberta já criada. Se não estiver disponível, insira o número de rastreamento principal.
accountNumber – Esse é o número de conta FedEx.
requestedShipment – Os detalhes da remessa para os quais uma remessa aberta é modificada.

A solicitação bem-sucedida atualizará os detalhes da remessa aberta já criada e retornará o número de rastreamento do(s) pacote(s) modificado(s) e os detalhes de remessa da transação atualizados como saída.

Recuperar remessa aberta

Use esse endpoint para recuperar a remessa aberta já criada para revisar ou verificar.

A seguir estão as informações de entrada obrigatórias associadas a esta solicitação:

index – Esse é um valor exclusivo atribuído à remessa aberta já criada. Se não estiver disponível, insira o número de rastreamento principal.
accountNumber – Esse é o número de conta FedEx.

A solicitação bem-sucedida recuperará os detalhes desejados da remessa aberta.

Excluir remessa aberta

Use esse endpoint para excluir a solicitação de remessa aberta antes que a remessa seja confirmada.

A seguir estão as informações de entrada obrigatórias associadas a esta solicitação:

index – Esse é um valor exclusivo atribuído à remessa aberta já criada. Se não estiver disponível, insira o número de rastreamento principal.
accountNumber – Esse é o número de conta FedEx.

A solicitação bem-sucedida excluirá a remessa aberta e todos os pacotes associados e retornará o status no elemento deletedOpenshipment como true na saída.

Confirmar remessa aberta

Use esse endpoint para validar e carregar os dados da remessa Open Ship nos sistemas FedEx assim que todos os pacotes forem adicionados à solicitação de remessa.

A seguir estão as informações de entrada obrigatórias associadas a esta solicitação:

index – Esse é um valor exclusivo atribuído à remessa aberta já criada. Se não estiver disponível, insira o número de rastreamento principal.
accountNumber – Esse é o número de conta FedEx.
labelResponseOptions: especifique se o bytecode codificado ou o URL da etiqueta deve ser retornado na resposta.
Observação: o elemento labelResponseOptions só está disponível na solicitação de confirmação de remessa aberta e as etiquetas serão geradas após a confirmação da remessa.

A resposta de confirmação bem-sucedida para 40 ou menos pacotes carregará os dados da remessa nos sistemas FedEx e gerará etiquetas de pacote e todos os outros relatórios de remessa.

A resposta de confirmação bem-sucedida para mais de 40 pacotes confirma que a solicitação foi colocada na fila com sucesso e retorna jobId para recuperar o resultado mais tarde.

Observação: é necessário incluir no mínimo um pacote na remessa aberta antes de poder confirmá-la.

Obter resultados da remessa aberta

Use esse endpoint para obter os dados da remessa Open Ship confirmada. Esse endpoint só deve ser usado quando a remessa tiver mais de 40 pacotes e o jobId for retornado na confirmação da remessa aberta.

A seguir estão as informações de entrada obrigatórias associadas a esta solicitação:

resultMethodType – Especifique o valor como CREATE.
accountNumber – Esse é o número de conta FedEx.
jobId – Esse é o jobId recebido durante a confirmação da remessa aberta.

Uma resposta bem-sucedida para esta solicitação retornará os resultados da remessa aberta confirmada, como etiquetas de pacote e todos os outros relatórios referentes à remessa aberta confirmada. Se os detalhes dos erros forem retornados na resposta, esses erros poderão ser corrigidos usando os endpoints Modificar remessa aberta ou Modificar pacote da remessa aberta. Na sequência, confirme a remessa usando o endpoint Confirmar remessa aberta e, por fim, use o endpoint Obter resultados da remessa aberta para recuperar os resultados da remessa aberta confirmada para a solicitação bem-sucedida.

Remessa aberta com vários volumes (MPS)

Uma remessa aberta com vários volumes (MPS) consiste em dois ou mais pacotes enviados para o mesmo endereço de destinatário. O primeiro pacote da remessa é considerado o principal.

Para criar uma remessa de vários volumes:

Inclua as informações da remessa, como serviceType, packagingType, totalWeight, totalPackageCount, e requestedPackageLineItemsdo pacote principal.
Observação: o sequenceNumber do pacote principal deve ser igual a 1.
Adicione todos os pacotes à remessa.
Confirme a remessa.

Após a confirmação da remessa, uma das opções de processamento abaixo será usada:

Processamento síncrono de remessa

O processamento síncrono é o método de processamento ideal, usado internamente quando uma remessa tem até 40 pacotes (contagem total de pacotes/grouppackagecount<=40) com mercadorias limitadas na remessa.

A solicitação de remessa com 40 pacotes ou menos quando confirmada será processada de forma síncrona, e as etiquetas e os documentos/relatórios de remessa serão gerados imediatamente. Esse processo será ideal para os remetentes se houver uma restrição de tempo e se as etiquetas tiverem que ser impressas logo após a confirmação da remessa.

Observação: o limite máximo de 40 pacotes é indicativo e não fixo. O limite também depende da combinação de pacotes e mercadorias na remessa. Para obter mais informações, entre em contato com a equipe de suporte da FedEx.

Exemplo: sua solicitação de remessa aberta consiste em 10 pacotes. Quando você confirma a remessa após adicionar todos os 10 pacotes, a remessa será processada de forma síncrona. Na resposta, 10 etiquetas serão criadas e os URLs ou as etiquetas codificadas, como solicitado, serão retornados.

O seguinte fluxo de trabalho de alto nível demonstra o processamento síncrono da remessa aberta:

Use o endpoint Criar remessa aberta.
Adicione de 1 a 40 pacotes usando o endpoint Adicionar pacotes à remessa aberta
Use o endpoint Confirmar remessa aberta para confirmá-la.
A solicitação bem-sucedida deverá gerar etiquetas e a resposta de saída terá URLs de etiquetas ou etiquetas codificadas, conforme solicitado.
Se a remessa tiver erros, os detalhes do erro serão fornecidos na resposta.
Depois de corrigir todos os erros, use o endpoint Confirmar remessa aberta para obter uma resposta bem-sucedida.

Observação:

Usando este método, você só pode adicionar pacotes até o total de 40 pacotes em uma remessa existente.

Processamento assíncrono de remessa

A API processa internamente a remessa de forma assíncrona, quando o número total de pacotes excede 40 (ou seja, totalPackageCount>40). Esse é um método muito conveniente quando o volume do pacote é grande e você deseja enviar remessas em massa periodicamente. Esse envio de remessas em massa usa vários recursos e operações caros da FedEx quando enviados de uma só vez. Com essa opção de processamento, a FedEx garante que essas remessas em massa sejam processadas internamente e com facilidade, e você também pode obter os dados da etiqueta periodicamente.

Quando a remessa é processada de forma assíncrona, a resposta a esta solicitação apenas confirma que a solicitação foi enfileirada com sucesso, mas a remessa pode não ter sido processada com êxito e retorna jobId para recuperar o resultado posteriormente.

Observação: leva algum tempo para processar a remessa com sucesso até você poder recuperar o resultado.

Para recuperar os resultados da remessa assíncrona, use o endpoint Obter resultados da remessa aberta e forneça os detalhes do jobId e accountNumber na solicitação. A resposta a esta solicitação retornará os dados do resultado da remessa com os detalhes da etiqueta ou do erro da remessa.

Exemplo: sua remessa tem 45 pacotes e, quando confirmada, eles serão processados de forma assíncrona. Na resposta, um jobId será retornado. Você deverá usar o endpoint Obter resultados da remessa aberta para recuperar os resultados e os dados da etiqueta da remessa.

O seguinte fluxo de trabalho de alto nível demonstra o processamento assíncrono de remessas:

Use o endpoint Criar remessa aberta.
Adicione 40 ou mais pacotes usando o endpoint Adicionar pacotes à remessa aberta.
Use o endpoint Confirmar remessa aberta para confirmá-la.
O envio bem-sucedido resultará em jobId.
Use jobId e accountNumber para recuperar os resultados de saída usando o endpoint Obter resultados da remessa aberta.
A saída bem-sucedida incluirá os dados do resultado da remessa com os detalhes da etiqueta.
Se o resultado tiver erros, os detalhes do erro serão fornecidos na resposta.

Observação:

Usando este método, o número máximo total de pacotes permitido em uma única solicitação é de 300, ou até 999 mercadorias.
Usando este método, você não poderá adicionar, modificar ou excluir pacotes em uma solicitação original depois de enviá-la. Se houver erros na resposta, corrija-os usando o endpoint Modificar pacotes da remessa aberta, confirme a remessa usando Confirmar remessa aberta e obtenha os resultados da saída bem-sucedida usando o endpoint Obter resultados da remessa aberta.

Etiquetas de remessa FedEx

A API FedEx é compatível com uma grande variedade de etiquetas. A API FedEx oferece três opções de tipo de etiqueta, incluindo térmica, papel comum e personalizável. É possível usar os endpoints da API Open Ship para produzir uma grande variedade de etiquetas.

A FedEx oferece 2 formatos de etiqueta para os serviços de remessa:

Etiquetas térmicas
Etiquetas laser

Etiquetas térmicas

A API FedEx permite que você imprima etiquetas de envio para todos os tipos de envio, como FedEx Express^®, FedEx Ground^® e FedEx International Ground^® usando uma variedade de impressoras de etiquetas térmicas.

Os seguintes tamanhos de etiqueta térmica são compatíveis com a API FedEx:

10,16 cm x 15,24 cm – sem uma guia de documento configurável (Doc-Tab)
10,16 cm x 17,14 cm – com ou sem um Doc-Tab
10,16 cm x 20,32 cm – oferece espaço para incluir um arquivo gráfico ou de texto de sua escolha
10,16 cm x 21,59 cm – com uma guia de documento configurável (especificamente incluída para etiqueta de identificação de pneu)
10,16 cm x 22,86 cm – oferece espaço para incluir gráficos ou de texto, assim como um Doc-Tab
10,16 cm x 26,67 cm – com uma guia de documento configurável (especificamente incluída para etiqueta de identificação de pneu)

Os tipos de etiqueta de 10,16 cm X 21,59 cm e 10,16 cm X 26,67 cm incluem uma guia de documentos adicional com código de barras idênticos. Um código de barras é exibido na etiqueta principal, e o outro, na guia de documentos. Esse tipo de etiqueta é útil para pacotes de pneu, pois uma etiqueta pode ser posicionada na banda de rodagem do pneu, e a etiqueta da guia de documentos adicional (com uma cópia do código de barras e instruções operacionais) pode ser colocada na lateral do pneu. O uso desses tipos de etiqueta reduz a reetiquetagem dos pneus, e o aumento das varreduras dimensionais otimiza a recuperação. Para obter mais informações sobre o estoque de etiquetas, consulte Tipos de estoque de etiqueta.

Observação: Doc-Tab é uma guia adesiva removível com informações de envio adicionais que podem ser selecionadas para um estoque de etiquetas ao imprimir etiquetas de envio usando uma impressora térmica.

Elementos de etiquetas térmicas

As etiquetas de envio térmicas contêm três elementos básicos:

Conteúdo legível: esta parte da etiqueta contém as informações de envio.
O código de barras Ground legível será criptografado por padrão.
Código de barras bidimensional (2D): o código de barras alfanumérico dimensional armazena dados para remessas FedEx Express e FedEx Ground usando o padrão MH10.8.3 do American National Standards Institute (ANSI). O código de barras 2D é criado usando a simbologia Portable Data File (PDF) 417.
Código de barras específico da FedEx:
- ASTRA (Advanced Sorting Tracking Routing Assistance) para remessas FedEx Express até que o código de barras FDX 1D tenha sido totalmente implementado; código de barras "96" para remessas FedEx Ground e FedEx Home Delivery. A FedEx Ground também permite o uso do código de barras SSCC-18 "00".
- O código de barras FedEx 1D (FDX1D) para remessas FedEx Express é criado usando ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C).

Informações importantes para gerar uma etiqueta térmica

Veja abaixo as principais informações necessárias para gerar uma etiqueta térmica:

LabelFormatType: necessário para receber a imagem correta da etiqueta na API Open Ship Reply:
- COMMON2D: tipo de formato de etiqueta para receber uma etiqueta.
- LABEL_DATA_ONLY: valor usado para receber os dados do código de barras se você criar uma etiqueta personalizada.

Valores válidos:

ImageType: necessário para formatar a etiqueta térmica da impressora que você usa; fornece o tipo de fluxo de dados ou bitmap a ser retornado.
- EPL2 – Eltron (tipos de estoque de etiquetas)
- ZPLII – Zebra (tipos de estoque de etiquetas)

Valores válidos:

Observação: todas as etiquetas necessárias para uma remessa são geradas e entregues em um único buffer.

Impressoras térmicas compatíveis

As seguintes impressoras térmicas são compatíveis com a API FedEx:

Unimark
Eltron
- Orion (EPL2)
- Eclipse (EPL2)
Zebra
- LP2443 (EPL2)
- LP2844 (EPL2)
- Gk420 (ZPL)
- LP2348 Plus (EPL2/ZPL)
- Z4M Plus (ZPL ou EPL)
- ZP500/ZP505 (EPL2/ZPL)
- Z4M/Z4M+ (EPL2/ZPL)
- ZM400 (EPL2/ZPL)
- ZT410 (EPL2/ZPL)
- Outras impressoras da série ZT4xx (EPL2/ZPL)

Observação: todas essas impressoras são compatíveis com o modo de página ASCII Eltron Programming Language (EPL2). As impressoras térmicas funcionam com gravação direta na impressora conectada a uma porta serial do sistema e como uma impressora nativa do Windows instalada para conexões LPT, Serial ou USB. As versões de firmware das impressoras fornecidas pela FedEx podem variar de acordo com a região.

Quantidade de etiquetas térmicas impressas por serviço

A tabela a seguir indica a quantidade de cada tipo de etiqueta necessária para um serviço especial específico. Todas as etiquetas necessárias são geradas por uma chamada ao FedEx Common Label Server (CLS), e o CLS retorna um único buffer com exceção das etiquetas de devolução C.O.D.

Quantidade de etiquetas térmicas impressas pelo U.S. Service

Tipo de serviço	Etiquetas térmicas (o FedEx CLS retornará o número apropriado de etiquetas na resposta)
FedEx Express U.S.	1 etiqueta de envio
FedEx Ground U.S./FedEx Home Delivery	1 etiqueta de envio

Quantidade de etiquetas térmicas impressas pelo U.S. Export International Service

Tipo de serviço	Etiquetas térmicas (o FedEx CLS retornará o número apropriado de etiquetas na resposta)
FedEx Express U.S. Export International	1 etiqueta de envio 2 etiquetas de destinatário
Opção de seleção de despachante FedEx Express U.S. Export International	1 etiqueta de envio 2 etiquetas de destinatário
FedEx Ground U.S. Export International	1 etiqueta de envio
FedEx Ground U.S. Export International C.O.D.	1 etiqueta de envio 2 etiquetas de devolução C.O.D.

Quantidade de etiquetas térmicas impressas pelo Intra-Canada Service

Tipo de serviço	Etiquetas térmicas (o FedEx CLS retornará o número apropriado de etiquetas na resposta)
FedEx Express dentro do Canadá	Remessa não DG (carga perigosa)/gelo seco: 1 etiqueta de envio
FedEx Ground dentro do Canadá	1 etiqueta de envio
FedEx Ground C.O.D. dentro do Canadá	1 etiqueta de envio 2 etiquetas de devolução C.O.D.

Quantidade de etiquetas térmicas impressas pelo Canada Export International Service

Tipo de serviço	Etiquetas térmicas (o FedEx CLS retornará o número apropriado de etiquetas na resposta)
FedEx Express Canada Export International	Remessas sem DG/gelo seco: 1 etiqueta de envio 2 etiquetas de destinatário
FedEx Express Canada Export International Broker Select	Remessas sem DG/gelo seco: 1 etiqueta de envio 2 etiquetas de destinatário
FedEx Ground Canada (CA) Export International	1 etiqueta de envio

Quantidade de etiquetas térmicas impressas por remessas de entrada nas Filipinas e na Tailândia

Tipo de serviço	Etiquetas térmicas (o FedEx CLS retornará o número apropriado de etiquetas na resposta)
Remessa de entrada nas Filipinas	2 etiquetas de envio com número de conta impresso 1 etiqueta de destinatário sem número da conta impresso 3 Cópias da fatura comercial
Remessas de mercadorias de entrada da Tailândia	3 etiquetas de envio com número de conta impresso 1 etiqueta de destinatário sem número da conta impresso
Remessas de documentos de entrada da Tailândia	2 etiquetas de envio com número de conta impresso 1 etiqueta de destinatário sem número da conta impresso

Doc-Tab

Se você imprimir etiquetas de remessa usando uma impressora térmica, poderá escolher um estoque de etiquetas que inclua um Doc-Tab, uma guia adesiva removível com informações adicionais sobre a remessa. É possível configurar essas informações de envio a partir de seus dados de envio ou optar por imprimir dados configuráveis específicos para suas necessidades de envio.

Etiquetas laser

A API FedEx oferece suporte à impressão de etiquetas com uma impressora a laser. Essas etiquetas são geralmente impressas em papel Carta ou A4 e dobradas ao meio para caber na embalagem padrão da FedEx. As etiquetas impressas com uma impressora a laser são geradas no formato PDF e não precisam ser dimensionadas ou redimensionadas. Para obter mais informações sobre o estoque de etiquetas, consulte Tipo de Estoque de Etiqueta.

Pré-requisitos

Os seguintes requisitos se aplicam às etiquetas em PDF:

O Adobe Reader 6.0 ou superior é necessário para processar a etiqueta.
A configuração do driver da impressora deve ter o dimensionamento da impressora definido como nenhum.
O uso de um HTML wrapper não é necessário para exibir uma etiqueta em PDF de papel comum em um navegador.
O Acrobat recomenda os seguintes navegadores para a visualização de documentos PDF:
- Microsoft Internet Explorer 10 ou versão mais recente
- Firefox 1.0 ou versão mais recente
- Mozilla 1.7 ou versão mais recente

A opção de etiqueta em PDF elimina a necessidade de especificar o parâmetro de orientação da imagem (largura e altura) ou a resolução da tela para exibir a etiqueta corretamente no navegador.

Elementos de etiquetas a laser

As etiquetas de envio a laser contêm três elementos básicos:

Conteúdo legível: esta parte da etiqueta contém as informações de envio.
O código de barras Ground legível será criptografado por padrão.
Código de barras bidimensional (2D): o código de barras alfanumérico dimensional armazena dados para remessas FedEx Express e FedEx Ground usando o padrão MH10.8.3 do American National Standards Institute (ANSI). O código de barras 2D é criado usando o formato Portable Data File (PDF) 417.
Código de barras específico da FedEx:
- ASTRA (Advanced Sorting Tracking Routing Assistance) para remessas FedEx Express até que o código de barras FDX 1D tenha sido totalmente implementado; código de barras "96" para remessas FedEx Ground e FedEx Home Delivery. A FedEx Ground também permite o uso do código de barras SSCC-18 "00".
- O código de barras FedEx 1D (FDX1D) para remessas FedEx Express é criado usando ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C).

Informações importantes para gerar uma etiqueta a laser

Os seguintes elementos da API FedEx são necessários para gerar uma etiqueta a laser:

LabelSpecification/LabelFormatType: necessário para receber a imagem correta da etiqueta na API Open Ship Reply: os valores válidos são:
- COMMON2D: tipo de formato de etiqueta para receber uma etiqueta.
- LABEL_DATA_ONLY: valor usado para receber os dados do código de barras se você criar uma etiqueta personalizada.

LabelSpecification/ImageType: necessário para indicar a formatação da etiqueta. Tipo de fluxo de dados ou bitmap a ser retornado:
Os valores válidos são:
- PDF – papel comum
- PNG – papel comum

LabelSpecification/LabelStockType: necessário para todos os tipos de etiqueta. Especifica se o estoque de etiqueta tem Doc-Tab na extremidade inicial ou final das etiquetas ou se não tem Doc-Tab. Ao usar um ImageType de PDF ou PNG, esses valores exibem uma etiqueta de formato a laser:
- PAPER_4X6
- PAPER_4X8
- PAPER_4X9
- PAPER_4X675
  Esses valores exibem uma etiqueta de envio em papel comum:
- PAPER_7X47
- PAPER_85X11_BOTTOM_HALF_LABEL
- PAPER_85X11_TOP_HALF_LABEL
- PAPER_LETTER

Observação: se você solicitar uma etiqueta de papel comum, os dados retornados serão uma imagem da etiqueta codificada em Base64, que deve ser decodificada da Base64 antes de exibir o arquivo de etiqueta.

Impressoras a laser compatíveis

A maioria das impressoras a laser é compatível com esse tipo de etiqueta; entretanto, as etiquetas não serão aceitas se forem impressas em uma impressora jato de tinta.
Observação: se você estiver usando uma impressora a laser colorida, a configuração de cor deverá ser definida como preto, mesmo se a impressora tiver apenas um cartucho preto instalado.

Quantidade de etiquetas a laser impressas por serviço

Quantidade de etiquetas a laser impressas pelo U.S. Service

Tipo de serviço	Etiqueta a laser – Formato PDF
FedEx Ground/FedEx Home Delivery U.S.	1 etiqueta de envio

Quantidade de etiquetas a laser impressas pelo U.S. Export International Service

Tipo de serviço	Etiqueta a laser – Formato PDF
FedEx Express U.S. Export International	1 etiqueta de envio na resposta; o mínimo de 3 etiquetas devem ser impressas – 1 etiqueta na embalagem e 2 na bolsa para documentação.
FedEx Express U.S. Export International Broker Select	1 etiqueta de envio na resposta; o mínimo de 3 etiquetas devem ser impressas – 1 etiqueta na embalagem e 2 na bolsa para documentação.
FedEx Ground U.S. Export International	1 etiqueta de envio
FedEx Ground U.S. Export International C.O.D.	1 etiqueta de envio 2 etiquetas de devolução C.O.D.

Quantidade de etiquetas a laser impressas pelo Intra-Mexico Service

Tipo de serviço

Etiqueta a laser – Formato PDF

FedEx Express dentro do México

Remessa não DG (carga perigosa)/gelo seco:

1 etiqueta de envio

Quantidade de etiquetas a laser impressas pelo Intra-Canada Service

Tipo de serviço	Etiqueta a laser – Formato PDF
FedEx Express dentro do Canadá	FedEx Express dentro do Canadá Remessa não DG (carga perigosa)/gelo seco: 1 etiqueta de envio
FedEx Ground dentro do Canadá	1 etiqueta de envio
FedEx Ground C.O.D. dentro do Canadá	1 etiqueta de envio 2 etiquetas de devolução C.O.D.

Quantidade de etiquetas a laser impressas pelo Canada Export Int'l Service

Tipo de serviço	Etiqueta a laser – Formato PDF
FedEx Express Canada Export International	FedEx Express Canada Export International Remessas sem DG/gelo seco: 1 etiqueta de envio 2 etiquetas de destinatário
FedEx Express Canada Export International Broker Select	FedEx Express Canada Export International Broker Select Remessas sem DG/gelo seco: 1 etiqueta de envio 2 etiquetas de destinatário
FedEx Ground Canada (CA) Export International	1 etiqueta de envio

Quantidade de etiquetas a laser impressas pelo Canada Export Int'l Service

Tipo de serviço	Etiqueta a laser – Formato PDF
FedEx Express Canada Export International	FedEx Express Canada Export International Remessas sem DG/gelo seco: 1 etiqueta de envio 2 etiquetas de destinatário
FedEx Express Canada Export International Broker Select	FedEx Express Canada Export International Broker Select Remessas sem DG/gelo seco: 1 etiqueta de envio 2 etiquetas de destinatário
FedEx Ground Canada (CA) Export International	1 etiqueta de envio

Quantidade de etiquetas a laser impressas por remessas de entrada nas Filipinas e na Tailândia

Tipo de serviço	Etiquetas térmicas (o FedEx CLS retornará o número apropriado de etiquetas na resposta)
Remessa de entrada nas Filipinas	2 etiquetas de envio com número de conta impresso 1 etiqueta de destinatário sem número da conta impresso 3 Cópias da fatura comercial
Remessas de mercadorias de entrada da Tailândia	3 etiquetas de envio com número de conta impresso 1 etiqueta de destinatário sem número da conta impresso
Remessas de documentos de entrada da Tailândia	2 etiquetas de envio com número de conta impresso 1 etiqueta de destinatário sem número da conta impresso

Etiqueta personalizada

A FedEx permite a personalização da etiqueta gerada por ela. É possível adicionar texto relacionado ao seu negócio e escolher o tipo de código de barras (simbologia) usado nos documentos e etiquetas da FedEx na parte personalizada das etiquetas térmicas.

Para oferecer suporte ao seu aplicativo de remessa, a API FedEx Open Ship fornece duas opções para personalizar sua etiqueta de envio:

Colocar o gráfico PNG PAPER 17,78 cm x 12,06 cm no seu estoque de etiquetas. Por exemplo, você pode criar uma lista de embalagens em um formulário de 21,59 cm x 27,94 cm. Como parte desse formulário, você pode ainda usar o gráfico PNG PAPER 17,78 cm x 12,06 cm em vez de criar sua própria etiqueta personalizada.
Adicionar um arquivo gráfico ou de texto à etiqueta térmica de 10,16 cm x 20,32 cm ou 10,16 cm x 22,86 cm. Esse tamanho de etiqueta oferece 5,08 centímetros de espaço para seu gráfico ou texto.

Observação: o conteúdo legível por humanos e o código de barras da etiqueta na parte comum da etiqueta não podem ser alterados.

Etiqueta de validador personalizada

É possível criar etiquetas personalizadas que não sejam para remessa, tanto no nível do pacote quanto no nível da remessa, especificando quais informações personalizadas são desejadas, como formatar essas informações e onde colocá-las na etiqueta personalizada. As etiquetas personalizadas são limitadas ao formato da etiqueta térmica.

Personalizar uma etiqueta térmica

A API da FedEx fornece dois formatos de etiqueta térmica que você pode personalizar com um arquivo gráfico ou de texto para evitar a necessidade de criar uma etiqueta personalizada. Essas etiquetas são compatíveis com todos os serviços de remessa FedEx. Esses formatos são:

Etiqueta térmica de 10,16 cm x 20,32 cm sem Doc-Tab
Etiqueta térmica de 10,16 cm x 22,86 cm com Doc-Tab

Esses tipos de etiqueta fornecem uma seção personalizável de 5,08 centímetros. Esse recurso se aplica a etiquetas térmicas impressas em impressoras térmicas com configuração de 203 DPI ou 300 DPI.

Regras para etiquetas personalizadas

As regras para usar os formatos de etiqueta são:

Apenas a etiqueta de envio pode ser personalizada. Por exemplo, se você imprimir uma etiqueta de envio expresso de 10,16 cm x 20,32 cm com seu logotipo, as etiquetas do destinatário secundário não o exibirão.
O gráfico ou texto personalizável não deve exceder 5,08 cm de altura e 12,19 cm de largura.
A FedEx não faz correções. O gráfico e/ou texto é impresso da forma que é enviado no serviço de remessa.
Se não forem fornecidos todos os dados necessários para a impressão do gráfico e/ou texto (por exemplo: coordenadas X e Y), o resultado será uma etiqueta de envio válida sem os dados personalizados. Você deverá cancelar a remessa representada por esta etiqueta se tentar recriar outra etiqueta com o gráfico e/ou texto.
Para resolução da impressora de 203 DPI (8 pontos/mm) com relação ao posicionamento nas coordenadas X e Y, o ponto de inserção da coordenada é a interseção das bordas superior e esquerda da etiqueta térmica de 10,16 cm x 17,14 cm com doc-tab inferior. Para etiquetas térmicas de 10,16 cm x 15,24 cm com doc-tab superior, incremente os valores das coordenadas Y do ponto de inserção em 164 pontos. Para etiquetas de 10,16 cm x 15,24 cm sem doc-tab, incremente os valores das coordenadas Y do ponto de inserção em 8 pontos. Os atributos do elemento da etiqueta térmica são baseados na resolução da impressora de 203 DPI (8 pontos/mm).
Para resolução da impressora de 300 DPI (12 pontos/mm) com relação ao posicionamento nas coordenadas X e Y, o ponto de inserção da coordenada é a interseção das bordas superior e esquerda da etiqueta térmica de 10,16 cm x 17,14 cm com doc-tab inferior. Para etiquetas térmicas de 10,16 cm x 15,24 cm com doc-tab superior, incremente os valores das coordenadas Y do ponto de inserção em 246 pontos. Para etiquetas de 10,16 cm x 15,24 cm sem doc-tab, incremente os valores das coordenadas Y do ponto de inserção em 12 pontos. Os atributos do elemento da etiqueta térmica são baseados na resolução da impressora de 300 DPI (12 pontos/mm).
Observação:
- Para o código de barras FXD1D, a dimensão X (largura da barra mais estreita do símbolo) é de 15 mil (3 pontos) para uma impressora de 203 DPI e de 13,3 mil (4 pontos) para uma impressora de 300 DPI.
- Para o código de barras 2D PDF-417, a dimensão X é de 10 mil (2 pontos) para uma impressora de 203 DPI. Para obter a dimensão X equivalente mais próxima para uma impressora de 300 DPI, devem ser usados 9,99 mil (3 pontos).
- No caso do bloco Remetente/Misc, na parte superior da etiqueta, e do bloco Referência do remetente, abaixo das informações do destinatário, em que são usadas fontes muito pequenas, os desenvolvedores de etiquetas precisam consultar o guia de programação ZPL para fazer referência cruzada às características do conjunto de fontes e selecionar um conjunto de fontes de desempenho equivalente para várias outras resoluções de cabeçote de impressão.
O ponto de inserção do caractere é o canto superior esquerdo do primeiro caractere da string da linha superior.
As restrições da impressora exigem a origem da posição no quadrante superior esquerdo da frente. Portanto, é possível que os dados comecem na seção personalizável da etiqueta e sejam anotados na parte da FedEx da etiqueta (dados reais da etiqueta térmica). Se isso ocorrer, o seu logotipo ou texto serão sobrescritos com as informações da etiqueta da FedEx. Para usar a etiqueta de envio, você deverá corrigir esse posicionamento.
A adição de informações Doc-Tab à etiqueta de 10,16 cm x 22,86 cm deve ser configurada usando o mesmo processo que você usaria para uma etiqueta térmica Doc-Tab padrão de 10,16 cm x 15,24 cm.

Observação: somente imagens de um único bit de cor devem ser adicionadas, pois as etiquetas serão impressas em preto e branco.

Elementos de entrada de gráficos para etiquetas personalizadas

A API fornece imagens PNG (Portable Network Graphic) para etiquetas FedEx Express e FedEx Ground. O gráfico da etiqueta PNG é uma réplica das etiquetas térmicas ou de papel comum compatíveis com a API. Esta opção de etiqueta permite colocar o gráfico da etiqueta PNG em seu estoque de etiquetas para evitar a necessidade de criar uma etiqueta personalizada.

Os seguintes requisitos se aplicam à utilização de imagens PNG de 10,16 cm x 15,2 cm incorporadas ao documento de envio:

Estoque de etiquetas
Impressora
Dimensionamento

Estoque de etiquetas

As etiquetas PNG de 10,16 cm x 15,2 cm devem ser usadas apenas com estoque de etiquetas autoadesivas. As equipes de certificação de etiquetas do FedEx Ground e FedEx Express rejeitarão etiquetas PNG de 10,16 cm x 15,2 cm que não sejam autoadesivas, incluindo quaisquer etiquetas impressas em papel comum.

Impressora

As impressoras a laser são recomendadas para a impressão de etiquetas. As impressoras a jato de tinta não devem ser usadas devido à inconsistência na criação de códigos de barras digitalizáveis. Não é possível imprimir a etiqueta PNG de 10,16 cm x 15,24 cm em uma impressora colorida, a menos que a configuração de cor seja definida como preto, mesmo que a impressora tenha apenas um cartucho preto instalado. Essa configuração é necessária para obter a definição correta do código de barras para digitalização nos hubs FedEx.

Dimensionamento

A imagem retornada pela transação de envio é de 200 pontos por polegada (DPI) e mede 10,16 cm (L) x 15,24 cm (A) ou 800 x 1200 pixels. Essa etiqueta tem orientação vertical e foi criada para ser impressa em uma área de etiqueta de 10,16 cm x 15,24 cm. Quando impressa, a etiqueta deverá medir 10,16 cm x 15,24 cm.

Para produzir a etiqueta e os códigos de barras com o DPI necessário, você deverá dimensionar (ou redimensionar) a imagem antes de imprimir. A maneira como você dimensiona a imagem depende do aplicativo que está usando para visualizar e imprimir a etiqueta. Para dimensionar uma imagem PNG para uma etiqueta de 10,16 cm x 15,24 cm: use exatamente 10,16 cm de largura e 15,24 cm de comprimento.

Lista de verificação de revisão de etiquetas

Todos os códigos de barras

Necessário para validação:

Zona silenciosa: deve haver sempre 0,25 cm de espaço em branco acima e abaixo do código de barras, no mínimo.
Zona silenciosa: deve haver sempre 0,5 cm de espaço em branco à esquerda e à direita do código de barras, no mínimo.
Verifique se todos os códigos de barras atendem aos requisitos de altura mínima.

Qualidade da impressão

Problemas comuns que fazem com que as etiquetas sejam rejeitadas:

Barras divididas
Impressão desbotada/espaços em branco
Espaços em branco repetidos (problema de rolamento)
Manchas (transferência térmica)
Descamação (laser) indica problema de fusão do toner
Impressão enrugada (transferência térmica)
O contraste de impressão para etiquetas térmicas diretas deve ser de pelo menos 90%

Detalhes legíveis por humanos para etiquetas Ground

Veja abaixo o que é necessário para validação de etiquetas legíveis por humanos do FedEx Ground:

Os dados correspondem ao código de barras
Logotipo do FedEx Ground: os logotipos estão disponíveis para download no site FedEx Identity (fedex.com)
Logotipo do FedEx Home Delivery: as etiquetas devem ter um grande “H” em uma caixa a 2,5 cm do endereço para envio. O “H” deve medir pelo menos 0,6 cm x 1,7 cm.
Descrição do serviço
Informações do remetente
Informações do destinatário
Código postal e definição de rotas
Data da remessa
Peso real
Informações do dispositivo de automação do cliente (medidor, aplicativo/sistema, versão)
Dimensões
Informações gerais de referência
Número de rastreamento e ID do formulário (o número de rastreamento deve ter 14 dígitos)
ID da rampa do aeroporto
Código postal

Detalhes legíveis por humanos para etiquetas Express

Os seguintes elementos devem ser impressos na etiqueta para a aprovação da certificação:

Logotipo do FedEx Express: os logotipos estão disponíveis para download no site FedEx Identity (fedex.com)
Descrição do serviço
Tipo de pacote, se for Internacional
Dia da semana de entrega (exemplo: SEG para segunda-feira)
Data limite de entrega
Número do medidor
Data da remessa
Formato de contagem de volumes, texto da etiqueta principal, texto da etiqueta CRN em todas as MPS
ID da rampa do aeroporto
Código postal e definição de rotas
Prefixo e sufixo de roteamento URSA
Códigos de manuseio
Comprometimento de área de serviço
Números de telefone do destinatário e remetente
dimensional
Dimensões, se aplicável
Campo de referência se for uma remessa de álcool
Número de rastreamento e ID do formulário (o número de rastreamento deve ter 14 dígitos)
Na etiqueta ASTRA, o número de rastreamento de 12 dígitos está localizado nas posições 17 a 28 do código de barras de 32 caracteres. No novo código de barras FDX 1D, o número de rastreamento ocupa as posições 21 a 34. O número de rastreamento FedEx Express continuará a ter 12 dígitos. Os zeros ocuparão as duas primeiras posições.

Regras do negócio

As seguintes regras se aplicam à API Open Ship:

Remessa aberta também pode ser criada e confirmada com um pacote.
As remessas abertas serão eliminadas se não forem confirmadas no final do quinto dia a partir da criação da remessa.
Assim que a remessa for confirmada, nenhum outro pacote poderá ser adicionado à remessa aberta.

Coleção JSON API

Open Ship API (1.0)

Create Open Shipment

This endpoint helps you to create an openn shipment request with the required shipping information.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-createOpenShipment
MinimumSamplePayload-CreateOpenshipment
MinimumSamplePayload-CreateOpenshipmentAsynchronous

requestedShipment required	object (OpenshipmentRequestedShipment) The detailed transaction data for the requested Open Shipment.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
openShipmentAction	string (OpenShipAction) Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Indicates the optional actions that can be performed during the modification of packages in Open Shipment. Here are the values: CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment. STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed). WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.
index	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Note: If index is not provided while create open shipment then the master tracking id of create open ship will act as index for the shipment. Example: Test1234

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/create

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/create

Production Server

https://apis.fedex.com/ship/v1/openshipments/create

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "PRIORITY_OVERNIGHT",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20.6,
- "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": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
  },
- "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": "000",
    "phoneNumber": "XXXX345671",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
  ],
- "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": "Your account number"
    }
  },
- "origin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "shippingChargesPayment":
  {
  - "paymentType": "SENDER",
  - "payor":
    {
    "responsibleParty":
    {
    "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",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
  },
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
  - "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
  - "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
  - "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
  - "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
  - "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
  },
- "emailNotificationDetail":
  {
  - "aggregationType": "PER_PACKAGE",
  - "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
  - "personalMessage": "your personal message here"
  },
- "expressFreightDetail":
  {
  - "bookingConfirmationNumber": "123456789812",
  - "shippersLoadAndCount": 123,
  - "packingListEnclosed": true
  },
- "variableHandlingChargeDetail":
  {
  - "rateType": "PREFERRED_CURRENCY",
  - "percentValue": 12.45,
  - "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
  - "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
  },
- "customsClearanceDetail":
  {
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "brokers":
    [
    {
    "broker":
    {
    "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",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
  - "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
  - "freightOnValue": "OWN_RISK",
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
  - "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-06T00:35:26Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
  - "isDocumentOnly": true,
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
  - "generatedDocumentLocale": "en_US",
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "partiesToTransactionAreRelated": true,
  - "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
  - "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
  },
- "smartPostInfoDetail":
  {
  - "ancillaryEndorsement": "RETURN_SERVICE",
  - "hubId": "5015",
  - "indicia": "PRESORTED_STANDARD",
  - "specialServices": "USPS_DELIVERY_CONFIRMATION"
  },
- "blockInsightVisibility": true,
- "rateRequestType":
  [
  - "LIST",
  - "PREFERRED"
  ],
- "preferredCurrency": "USD",
- "requestedPackageLineItems":
  [
  - {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "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"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ]
},
"accountNumber":
{
- "value": "Your account number"
},
"openShipmentAction": "CREATE_PACKAGE",
"index": "Test1234"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624dxxx6-b709-470c-8c39-4b55xxxxx492",
"customerTransactionId": "order123xxxx89",
"output":
{
- "asynchronousProcessingResultsDetail": "SYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "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": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "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":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "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": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "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."
    }
  ]
}

}

Modify Open Shipment

This endpoint helps you to modify an Open shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-modifyOpenShipment
MinimumSamplePayload-modifyOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
requestedShipment required	object (OpenshipmentRequestedShipment) The detailed transaction data for the requested Open Shipment.
openShipmentAction	string (OpenShipAction) Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Indicates the optional actions that can be performed during the modification of packages in Open Shipment. Here are the values: CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment. STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed). WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"requestedShipment":
{
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "PRIORITY_OVERNIGHT",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20.6,
- "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": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
  },
- "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": "000",
    "phoneNumber": "XXXX345671",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
  ],
- "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": "Your account number"
    }
  },
- "origin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "shippingChargesPayment":
  {
  - "paymentType": "SENDER",
  - "payor":
    {
    "responsibleParty":
    {
    "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",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
  },
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
  - "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
  - "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
  - "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
  - "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
  - "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
  },
- "emailNotificationDetail":
  {
  - "aggregationType": "PER_PACKAGE",
  - "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
  - "personalMessage": "your personal message here"
  },
- "expressFreightDetail":
  {
  - "bookingConfirmationNumber": "123456789812",
  - "shippersLoadAndCount": 123,
  - "packingListEnclosed": true
  },
- "variableHandlingChargeDetail":
  {
  - "rateType": "PREFERRED_CURRENCY",
  - "percentValue": 12.45,
  - "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
  - "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
  },
- "customsClearanceDetail":
  {
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "brokers":
    [
    {
    "broker":
    {
    "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",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
  - "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
  - "freightOnValue": "OWN_RISK",
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
  - "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-06T00:35:26Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
  - "isDocumentOnly": true,
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
  - "generatedDocumentLocale": "en_US",
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "partiesToTransactionAreRelated": true,
  - "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
  - "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
  },
- "smartPostInfoDetail":
  {
  - "ancillaryEndorsement": "RETURN_SERVICE",
  - "hubId": "5015",
  - "indicia": "PRESORTED_STANDARD",
  - "specialServices": "USPS_DELIVERY_CONFIRMATION"
  },
- "blockInsightVisibility": true,
- "rateRequestType":
  [
  - "LIST",
  - "PREFERRED"
  ],
- "preferredCurrency": "USD",
- "requestedPackageLineItems":
  [
  - {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "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"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ]
},
"openShipmentAction": "CREATE_PACKAGE",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "string",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "asynchronousProcessingResultsDetail": "SYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "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": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "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":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "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": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "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 Open Shipment

Use this endpoint to validate and upload the Open Ship shipment data to FedEx Systems once all packages are added in the Shipment request.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-confirmOpenShipment
MinimumSamplePayload-confirmOpenShipment

labelResponseOptions required	string (LABELRESPONSEOPTIONS) Enum: "URL_ONLY" "LABEL" 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.
edtRequestType	string Enum: "ALL" "NONE" Indicate whether to have estimated duties and taxes provided with the rate quotes on this shipment. Only applies for International Shipment.
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.
index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shippingDocumentSpecification	object (ShippingDocumentSpecification) Use this object to provide all data required for additional (non-label) shipping documents to be produced.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/

Sandbox Server

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

Production Server

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

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"labelResponseOptions": "LABEL",
"edtRequestType": "ALL",
"labelSpecification":
{
- "labelFormatType": "COMMON2D",
- "labelOrder": "SHIPPING_LABEL_FIRST",
- "customerSpecifiedDetail":
  {
  - "maskedData":
    [
    "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
    ],
  - "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
  - "additionalLabels":
    [
    {
    "type": "CONSIGNEE",
    "count": 1
    }
    ],
  - "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    }
    }
  },
- "printedLabelOrigin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
- "labelRotation": "UPSIDE_DOWN",
- "imageType": "PDF",
- "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
- "returnedDispositionDetail": true,
- "resolution": 300
},
"index": "Test1234",
"shippingDocumentSpecification":
{
- "generalAgencyAgreementDetail":
  {
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "returnInstructionsDetail":
  {
  - "customText": "This is additional text printed on Return instr",
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US\"",
    "docType": "PNG"
    }
  },
- "op900Detail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "signatureName": "Signature Name",
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "usmcaCertificationOfOriginDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
  - "certifierSpecification": "EXPORTER",
  - "importerSpecification": "UNKNOWN",
  - "producerSpecification": "SAME_AS_EXPORTER",
  - "producer":
    {
    "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
  - "blanketPeriod":
    {
    "begins": "22-01-2020",
    "ends": "2-01-2020"
    },
  - "certifierJobTitle": "Manager"
  },
- "usmcaCommercialInvoiceCertificationOfOriginDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
  - "certifierSpecification": "EXPORTER",
  - "importerSpecification": "UNKNOWN",
  - "producerSpecification": "SAME_AS_EXPORTER",
  - "producer":
    {
    "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
  - "certifierJobTitle": "Manager"
  },
- "shippingDocumentTypes":
  [
  - "RETURN_INSTRUCTIONS"
  ],
- "certificateOfOrigin":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "commercialInvoiceDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  }
},
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "string",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "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": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "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":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "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": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "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."
    }
  ]
}

}

Modify Open Shipment Packages

This endpoint helps you to modify packages in Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-modifyPackageInOpenShipment
MinimumSamplePayload-modifyPackageInOpenShipment

requestedPackageLineItem required	object Contains the data for the package that is to be modified in the open shipment.
index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shipAction	string Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Allowed values are STRONG_VALIDATION
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingId required	object (TrackingId) Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedPackageLineItem":
{
- "sequenceNumber": "1",
- "subPackagingType": "BUCKET",
- "customerReferences":
  [
  - {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
  ],
- "declaredValue":
  {
  - "amount": 12.45,
  - "currency": "USD"
  },
- "weight":
  {
  - "units": "KG",
  - "value": 68.25
  },
- "dimensions":
  {
  - "length": 100,
  - "width": 50,
  - "height": 30,
  - "units": "CM"
  },
- "groupPackageCount": 2,
- "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"
    ],
  - "signatureOptionType": "SERVICE_DEFAULT",
  - "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
  - "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
  - "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
  - "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
  - "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "pieceCountVerificationBoxCount": 0,
  - "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
  - "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
  }
},
"index": "Test1234",
"shipAction": "STRONG_VALIDATION",
"accountNumber":
{
- "value": "Your account number"
},
"trackingId":
{
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "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": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "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":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "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": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "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."
    }
  ]
}

}

Add Open Shipment Packages

This endpoint helps you to add packages to Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-addPackagesToOpenShipment
MinimumSamplePayload-addPackagesInOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shipAction	string Enum: "CONFIRM" "TRANSFER" There are Ship actions as part of processing the shipment.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
requestedPackageLineItems required	Array of objects (RequestedPackageLineItem) These are package line item details in the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"shipAction": "STRONG_VALIDATION",
"accountNumber":
{
- "value": "Your account number"
},
"requestedPackageLineItems":
[
- {
  - "sequenceNumber": "1",
  - "subPackagingType": "BUCKET",
  - "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
  - "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "weight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
  - "groupPackageCount": 2,
  - "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"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
  }
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "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": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "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":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "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": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "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."
    }
  ]
}

}

Delete Open Shipment Packages

This endpoint helps you to delete packages from Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-deletePackagesFromOpenShipment
MinimumSamplePayload-deletePackagesOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingIds required	Array of objects (TrackingId) One or more tracking IDs, for which the packages to be removed from the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages/delete

Sandbox Server

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

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
},
"trackingIds":
[
- {
  - "formId": "0201",
  - "trackingIdType": "EXPRESS",
  - "uspsApplicationId": "92",
  - "trackingNumber": "49092000070120032835"
  }
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Retrieve Open Shipment Package

This endpoint helps the user to RETRIEVE specific package request details of the Open Shipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-retrievePackageInOpenShipment
MinimumSamplePayload-retrievePackageInOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingId required	object (TrackingId) Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages/retrieve

Sandbox Server

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

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/retrieve

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
},
"trackingId":
{
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestedpackageLineItem":
  {
  - "sequenceNumber": "1",
  - "subPackagingType": "BUCKET",
  - "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
  - "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "weight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
  - "groupPackageCount": 2,
  - "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"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

OpenShipmentDelete V1

This endpoint helps you to delete a Openshipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-deleteOpenShipment
MinimumSamplePayload-deleteOpenShipment

index required	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). Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/delete

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

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

}

Retrieve Open Shipment

This endpoint helps the user to RETRIEVE the entire shipment request details of the OpenShipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-RetrieveOpenShipment
MinimumSamplePayload-RetrieveOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /ship/v1/openshipments/retrieve

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "XXX_ORDERXXXX789",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestedShipment":
  {
  - "shipDatestamp": "2019-10-14",
  - "totalDeclaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "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": "XXXX567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "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": "000",
    "phoneNumber": "XXXX345671",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    ],
  - "recipientLocationNumber": "1234567",
  - "pickupType": "USE_SCHEDULED_PICKUP",
  - "serviceType": "PRIORITY_OVERNIGHT",
  - "packagingType": "YOUR_PACKAGING",
  - "totalWeight": 20.6,
  - "origin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
  - "shippingChargesPayment":
    {
    "paymentType": "SENDER",
    "payor":
    {
    "responsibleParty":
    {
    "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",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
    },
  - "shipmentSpecialServices":
    {
    "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
    "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
    "returnShipmentDetail":
    {
    "returnEmailDetail":
    {
    "merchantPhoneNumber": "19012635656",
    "allowedSpecialService":
    [
    "SATURDAY_DELIVERY"
    ]
    },
    "rma":
    {
    "reason": "Wrong Size or Color"
    },
    "returnAssociationDetail":
    {
    "shipDatestamp": "2019-10-01",
    "trackingNumber": "123456789"
    },
    "returnType": "PRINT_RETURN_LABEL"
    },
    "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
    "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
    "pendingShipmentDetail":
    {
    "pendingShipmentType": "EMAIL",
    "processingOptions":
    {
    "options":
    [
    "ALLOW_MODIFICATIONS"
    ]
    },
    "recommendedDocumentSpecification":
    {
    "types": "ANTIQUE_STATEMENT_EUROPEAN_UNION"
    },
    "emailLabelDetail":
    {
    "recipients":
    [
    {
    "emailAddress": "neena@fedex.com",
    "optionsRequested":
    {
    "options":
    [
    "PRODUCE_PAPERLESS_SHIPPING_FORMAT",
    "SUPPRESS_ACCESS_EMAILS"
    ]
    },
    "role": "SHIPMENT_COMPLETOR",
    "locale": "en_US"
    }
    ],
    "message": "your optional message"
    },
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "expirationTimeStamp": "2020-01-01"
    },
    "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
    "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
    "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
    "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
    },
  - "emailNotificationDetail":
    {
    "aggregationType": "PER_PACKAGE",
    "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
    "personalMessage": "your personal message here"
    },
  - "expressFreightDetail":
    {
    "bookingConfirmationNumber": "123456789812",
    "shippersLoadAndCount": 123,
    "packingListEnclosed": true
    },
  - "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
  - "customsClearanceDetail":
    {
    "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
    "brokers":
    [
    {
    "broker":
    {
    "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",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
    "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
    "freightOnValue": "OWN_RISK",
    "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
    "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-06T00:35:26Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
    "isDocumentOnly": true,
    "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
    "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
    "generatedDocumentLocale": "en_US",
    "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
    "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "partiesToTransactionAreRelated": true,
    "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
    "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "smartPostInfoDetail":
    {
    "ancillaryEndorsement": "RETURN_SERVICE",
    "hubId": "5015",
    "indicia": "PRESORTED_STANDARD",
    "specialServices": "USPS_DELIVERY_CONFIRMATION"
    },
  - "blockInsightVisibility": true,
  - "labelSpecification":
    {
    "labelFormatType": "COMMON2D",
    "labelOrder": "SHIPPING_LABEL_FIRST",
    "customerSpecifiedDetail":
    {
    "maskedData":
    [
    "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
    ],
    "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
    "additionalLabels":
    [
    {
    "type": "CONSIGNEE",
    "count": 1
    }
    ],
    "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    }
    }
    },
    "printedLabelOrigin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
    "labelRotation": "UPSIDE_DOWN",
    "imageType": "PDF",
    "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
    "returnedDispositionDetail": true,
    "resolution": 300
    },
  - "shippingDocumentSpecification":
    {
    "generalAgencyAgreementDetail":
    {
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "returnInstructionsDetail":
    {
    "customText": "This is additional text printed on Return instr",
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US\"",
    "docType": "PNG"
    }
    },
    "op900Detail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "signatureName": "Signature Name",
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "usmcaCertificationOfOriginDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
    "certifierSpecification": "EXPORTER",
    "importerSpecification": "UNKNOWN",
    "producerSpecification": "SAME_AS_EXPORTER",
    "producer":
    {
    "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
    "blanketPeriod":
    {
    "begins": "22-01-2020",
    "ends": "2-01-2020"
    },
    "certifierJobTitle": "Manager"
    },
    "usmcaCommercialInvoiceCertificationOfOriginDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
    "certifierSpecification": "EXPORTER",
    "importerSpecification": "UNKNOWN",
    "producerSpecification": "SAME_AS_EXPORTER",
    "producer":
    {
    "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": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "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"
    }
    ]
    },
    "certifierJobTitle": "Manager"
    },
    "shippingDocumentTypes":
    [
    "RETURN_INSTRUCTIONS"
    ],
    "certificateOfOrigin":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "commercialInvoiceDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    }
    },
  - "rateRequestType":
    [
    "LIST",
    "PREFERRED"
    ],
  - "preferredCurrency": "USD",
  - "totalPackageCount": 25,
  - "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
  - "requestedPackageLineItems":
    [
    {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "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"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
    ]
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Get Open Shipment Results

This endpoint enables you to finalize the Open Shipment. Once an Open Shipment is confirmed, no further changes can be done.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-getOpenShipmentResults
MinimumSamplePayload-getConfirmOpenShipmentResults
MinimumSamplePayload-getCreateOpenShipmentResults
MinimumSamplePayload-getModifyOpenShipmentResults

resultMethodType required	string Enum: "CREATE" "MODIFY" "CONFIRM" The use of this method is to retrieve the results of the CREATE, MODIFY and CONFIRM events of Asynchronous flow. CREATE- Customer will create Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Create OpenShipment. MODIFY- Customer will modify Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Modify OpenShipment. CONFIRM- Customer will confirm Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Confirm OpenShipment.
jobId required	string Indicates the job under which the deferred shipment artifacts must be identified in the subsequent retrieval request. Example: '89sxxxxx233ae24ff31xxxxx'
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/results

Sandbox Server

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

Production Server

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

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"resultMethodType": "CREATE",
"jobId": "89sxxxxx233ae24ff31xxxxx",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "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": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "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":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "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": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "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":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "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."
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Open Ship API

Introdução

Detalhes da API Open Ship

Fluxo de trabalho da API Open Ship

Como funciona a API Open Ship

Remessa aberta com vários volumes (MPS)

Etiquetas de remessa FedEx

Regras do negócio

Coleção JSON API

Open Ship API (1.0)

Create Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Modify Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Modify Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Add Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Open Shipment Package

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

OpenShipmentDelete V1

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Open Shipment Results

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in