Fedex Logo
Developer Portal

Trade Documents Upload API

Introdução

A API de upload de documentos comerciais é uma solução de carregamento de documentos de remessa internacional da FedEx que simplifica suas necessidades de remessa global e permite que você carregue eletronicamente a documentação alfandegária necessária para remessas internacionais. Você pode enviar a maioria dos seus documentos comerciais eletronicamente, evitando a necessidade de imprimir ou anexar os documentos comerciais à remessa.

A alfândega e outras agências recebem documentos enviados eletronicamente mais rápido do que as cópias em papel anexadas à sua remessa. O processo de liberação alfandegária também é otimizado, pois o recebimento e o compartilhamento de informações comerciais importantes são feitas em estágios iniciais do transporte.

Observação:

  • Em certos cenários, os originais de documentos internacionais específicos ainda precisam ser anexados ao pacote. Para obter mais informações, consulte a seção Exportar documentos.
  • Para facilitar a liberação alfandegária e evitar atrasos, certifique-se de que os documentos estejam visualmente claros e sem distorções.

Detalhes da API de upload de documentos comerciais

Carregue seus documentos alfandegários ou use os documentos comerciais gerados pela FedEx. Você também pode personalizar os documentos comerciais eletrônicos gerados pela FedEx carregando o timbre/logotipo da empresa e a imagem da assinatura digital. Usar o formato eletrônico elimina a necessidade de assinar, dobrar, colocar no envelope e anexar manualmente os documentos alfandegários de cada remessa. Além disso, você economiza papel, energia e custos com impressão.

Os seguintes recursos estão associados a essa API:

Upload de documento

Você pode carregar um documento por vez antes de criar a remessa (pré-remessa) ou depois de criá-la usando a API de envio (pós-remessa).

Observação: a criação de remessas mencionada ao longo deste texto é aplicável aos endpoints: Criar remessa da API de envio, Criar remessa aberta da API de remessa aberta e Enviar carga parcial (LTL) da API de carga parcial (LTL).

Upload de múltiplos documentos

Você pode carregar até cinco documentos por solicitação tanto em condições pré-remessa como pós-remessa.

Upload de múltiplos documentos codificados

Você pode carregar até cinco documentos codificados em base64 ao mesmo tempo antes (pré-remessa) ou depois (pós-remessa) de criar a remessa. Essa opção de upload oferece proteção adicional aos dados dos documentos no caso de uma intercepção inesperada.

Upload de imagens

Este recurso permite que você carregue imagens personalizadas de timbre/logotipo da empresa e da assinatura digital, que podem ser usadas na documentação ou relatórios gerados pela FedEx. Primeiro, carregue o timbre/logotipo da empresa e imagem da assinatura digital para os servidores FedEx e, em seguida, forneça essas referências de carregamento em sua solicitação de remessa (Criar endpoint da remessa) para o documento individual usando o elemento customerImageUsages em shippingDocumentSpecification.

As assinaturas digitais ou timbre/logotipo da empresa são impressos nos seguintes documentos e relatórios gerados pela FedEx:

  • Fatura comercial
  • Certificado de origem
  • OP900
  • Fatura pró-forma
  • Certificado de origem USMCA
  • Fatura comercial USMCA e Certificado de origem

Observação:

  • Assinatura digital: a limitação da assinatura é de 240x25 pixels e as imagens podem estar nos formatos GIF e PNG.
  • Timbre/logotipo da empresa: a limitação do logotipo é de 700x50 pixels e as imagens podem estar nos formatos GIF e PNG.

Fluxo de trabalho da API de upload de documentos comerciais

Veja a seguir o fluxo que pode ser usado para carregar documentos antes ou depois da remessa.

Upload de documento antes da remessa:

O upload de documentos antes da remessa envolve carregar documentos usando esta API antes da criação da remessa. Após o carregamento bem-sucedido dos documentos, você poderá incluir a referência do documento na solicitação da remessa.

Este é o método padrão para carregar seus documentos comerciais antes da confirmação do envio.

As etapas para o upload de documento antes da remessa são as seguintes:

  • Use qualquer dos endpoints abaixo como precisar.
    • Upload de documento
    • Upload de múltiplos documentos
    • Upload de documentos codificados
  • Especifique o valor workflowName como ETDPreShipment para indicar que este é um upload pré-remessa.
  • Forneça os arquivos ou documentos codificados em base64 a serem carregados.
  • Forneça os detalhes do documento (fatura comercial, certificado de origem, declaração de exportação etc.), incluindo o tipo do documento e os metadados da remessa associada ao documento.
  • A solicitação bem-sucedida carregará os documentos nos servidores FedEx e retornará um identificador exclusivo, por exemplo, docId para cada documento carregado como token de sucesso.
  • Use o endpoint Criar remessa/Criar remessa aberta/Enviar carga LTL.
  • No endpoint selecionado, especifique shipmentSpecialService/specialServiceTypes como ELECTRONIC_TRADE_DOCUMENTS e passe os valores de docId ao elemento shipmentSpecialServices/etdDetail/attachedDocuments/documentId.
    • Observação: no caso de uma remessa de vários volumes (MPS), especifique o docId gerado no carregamento dos documentos para todos os pacotes na remessa.
  • A solicitação de remessa bem-sucedida confirmará a remessa de ETD para a FedEx e gerará os detalhes de rastreamento e etiqueta. Além disso, o objeto completedEtdDetail retornará o tipo e o ID dos documentos carregados como referência.
  • No upload pré-remessa, você pode carregar um documento de cada vez ou até cinco documentos ao mesmo tempo e, em seguida, fornecer todos os IDs dos documentos da remessa ao mesmo tempo.

Upload de documento após a remessa (PSDU):

O upload de documento após a remessa (PSDU) permite que você carregue documentos depois que a remessa for solicitada e as etiquetas de rastreamento forem geradas. Nesse caso, uma vez que a remessa é criada e o número de rastreamento é gerado, associe esse número de rastreamento em sua solicitação de carregamento de documento.

Esse é um método prático para clientes que criam as próprias faturas comerciais e têm terceiros ou escritórios remotos que preparam a documentação alfandegária.

Alguns pontos importantes a serem lembrados ao usar esse método são:

  • Você deve ter o número de rastreamento da remessa e a data da remessa prontos antes da solicitação de carregamento.
  • Você deve estar ciente do horário limite da localização do remetente para enviar a documentação em tempo hábil.

Esta API também permite enviar documentos alfandegários para remessas com data futura, bem como remessas na data atual.

As etapas para carregar um documento após a remessa são as seguintes:

  • Use o endpoint Criar remessa/Criar remessa aberta/Enviar carga parcial (LTL).
  • No endpoint Criar remessa, especifique os detalhes abaixo de acordo com sua seleção:
    • Forneça shipmentSpecialServices/specialServiceTypes como ELECTRONIC_TRADE_DOCUMENTS.
    • Forneça shipmentSpecialServices/etdDetail/attributes como POST_SHIPMENT_UPLOAD_REQUESTED.
  • A solicitação de remessa bem-sucedida confirmará a remessa para a FedEx e gerará detalhes de rastreamento e etiqueta.
  • Use qualquer dos endpoints abaixo como precisar.
    • Upload de documento
    • Upload de múltiplos documentos
    • Upload de múltiplos documentos codificados
  • Forneça o valor workflowName como ETDPostShipment para indicar que é um carregamento após a remessa.
  • Forneça os arquivos ou documentos codificados em base64 a serem carregados.
  • Forneça detalhes do documento (fatura comercial, certificado de origem, declaração de exportação etc.).
  • Forneça o trackingNumber e a shipmentDate da remessa já processada nos elementos document/meta/trackingNumber e document/meta/shipmentDate.
    Observação: no caso de remessas de vários volumes (MPS), use o número de rastreamento da remessa principal ao fazer upload dos documentos. Os detalhes de ETD informados para a remessa principal também se aplicam às remessas secundárias.
  • A solicitação bem-sucedida carregará os documentos nos servidores FedEx e associará os documentos carregados à remessa.

Veja a seguir os recursos da API de upload de documentos comerciais que permitem a você carregar documentos e imagens relevantes à documentação da remessa.

Como a API de upload de documentos comerciais funciona

Veja a seguir os recursos da Trade Documents Upload API, que permite o carregamento de documentos e imagens relevantes à documentação da remessa.

Upload de documento

Use este endpoint para carregar os documentos comerciais para as condições antes e após a remessa.

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

  • attachment – arquivo certo a ser carregado.
  • workFlowName – forneça o ETDPreShipment para o upload antes da remessa e o ETDPostShipment para o upload após a remessa.
  • document – forneça detalhes do documento e metadados da remessa.
  • trackingNumber – forneça o número de rastreamento de remessa PSDU para a qual os documentos serão carregados. É opcional para upload antes da remessa.
  • shipmentDate – essa é a data da remessa. É opcional para upload antes da remessa.

No upload pré-remessa, a resposta bem-sucedida carregará o documento nos servidores FedEx e retornará o docId. O docId será usado na remessa real para enviar a remessa e gerar etiquetas.

No caso de upload após a remessa, uma resposta bem-sucedida carregará o documento nos servidores FedEx e associará os documentos carregados à remessa já confirmada.

Upload de imagem

Use esse endpoint para carregar imagens personalizadas de assinatura e timbre/logotipo da empresa para que sejam usadas nos documentos da remessa.

As informações de entrada a seguir são obrigatórias para esta solicitação:

  • attachment – o arquivo da imagem.
  • document – forneça detalhes da imagem, como nome do arquivo, tipo de conteúdo e metadados do arquivo.

A solicitação bem-sucedida carregará imagens da assinatura e timbre/logotipo da empresa nos servidores FedEx e retornará imageIndex. Esse índice é adicionado à solicitação de remessa como o elemento individual do documento customerImageUsages em shippingDocumentSpecification para garantir que as imagens personalizadas ou o timbre sejam impressos no documento da remessa.

Upload de múltiplos documentos

Use este endpoint para carregar até cinco documentos comerciais tanto em condições pré-remessa como pós-remessa. As informações de entrada obrigatória associadas a esta solicitação são:

  • workflowName – forneça  ETDPreShipment no upload pré-remessa e ETDPostShipment no upload pós-remessa.
  • fileName – forneça os nomes dos documentos ou do arquivo sendo atualizados e o tipo de extensão. Exemplo: COD.PDF.
  • contentType – indique o tipo e o formato do arquivo a ser carregado entre as opções disponíveis.
  • shipDocumentType – forneça os tipos de documentos a serem carregados.

    Para obter mais informações sobre os documentos individuais, consulte a seção Upload de documentos nesta página. Os tipos de documentos disponíveis para escolha são:

    • CERTIFICATE_OF_ORIGIN COMMERCIAL_INVOICE
    • ETD_LABEL
    • USMCA_CERTIFICATION_OF_ORIGIN
    • USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
    • OUTRO
    • PRO_FORMA_INVOICE
  • carrierCode – forneça o código de quatro letras da empresa operante da FedEx. Exemplo: FDXE
  • originCountryCode – forneça o código do país de origem para a remessa.
  • destinationCountryCode – forneça o código do país de destino para a remessa.
    • Observação: consulte o Guia de Referência para pesquisar o código do país. Exemplo: US
  • shipmentDate – em um upload pós-remessa, forneça a data real da remessa.
  • trackingNumber – em um upload pós-remessa, forneça o número de rastreamento da remessa. Exemplo: 7825XXXXXXX.

No upload pré-remessa, a resposta bem-sucedida carregará os documentos nos servidores FedEx e retornará os IDs dos documentos (docId). O docId será usado na remessa real para enviar a remessa e gerar etiquetas.

No caso de upload após a remessa, uma resposta bem-sucedida carregará os documentos nos servidores FedEx e associará os documentos carregados à remessa já confirmada.

Upload de múltiplos documentos codificados

Use este endpoint para carregar até cinco documentos comerciais codificados em base64 tanto em condições pré-remessa como pós-remessa.

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

  • workFlowName – forneça o ETDPreShipment para o upload antes da remessa e ETDPostShipment para o upload após a remessa.
  • carrierCode – forneça o código de quatro letras da empresa operante da FedEx. Exemplo: FDXE
  • contentType – indique o tipo e o formato do arquivo a ser carregado entre as opções disponíveis.
  • shipDocumentType – forneça os tipos de documentos a serem carregados.

    Para obter mais informações sobre os documentos individuais, consulte a seção Upload de documentos nesta página. Os tipos de documentos disponíveis para escolha são:

    • CERTIFICATE_OF_ORIGIN COMMERCIAL_INVOICE
    • ETD_LABEL
    • USMCA_CERTIFICATION_OF_ORIGIN
    • USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN
    • OUTRO
    • PRO_FORMA_INVOICE
  • originCountryCode – forneça o código do país de origem para a remessa.
  • destinationCountryCode – forneça o código do país de destino para a remessa.
    • Observação: consulte o Guia de Referência para pesquisar o código do país. Exemplo: US
  • fileContentBase64 – especifique o conteúdo de bytecode do arquivo em base64 a ser carregado.

No upload pré-remessa, a resposta bem-sucedida carregará os documentos codificados nos servidores FedEx e retornará os IDs dos documentos (docId). O docId será usado na remessa real para enviar a remessa e gerar etiquetas.

No upload pós-remessa, a resposta bem-sucedida carregará os documentos codificados nos servidores FedEx e associará esses documentos à remessa já confirmada.

Upload de documentos

Os documentos que podem ser enviados com essa API são:

Certificado de origem (COO)

O COO é um documento internacional que verifica o país/território onde um produto foi fabricado. Alguns países restringem as importações de determinados países, muitos limitam a quantidade de mercadorias importadas e alguns dão preferência a mercadorias fabricadas em um país específico.

Fatura Comercial (CI)

Este é um documento fornecido pelo vendedor/exportador que descreve as partes envolvidas na transação de envio da remessa e nas mercadorias a serem transportadas. É o principal documento utilizado pelas alfândegas. Se possível, deve ser preparado no idioma oficial do país/território para o qual as mercadorias estão sendo exportadas. A fatura comercial deve conter um relatório detalhado de todos os itens incluídos na remessa, inclusive uma descrição adequada das mercadorias (O que são? De que são feitas? Qual é o uso pretendido?), a quantidade, o país/território de fabricação, o preço ou custo, a moeda usada, o número do sistema harmonizado para cada mercadoria e os termos da entrega. Alguns países exigem que uma fatura original seja redigida no papel timbrado do remetente. A fatura deve ser assinada e datada pelo exportador certificando que os detalhes informados são verdadeiros e que constituem representações corretas do conteúdo coberto pela fatura comercial.

Para obter mais informações, acesse nosso Global Trade Manager.

Etiqueta ETD

Essa é a etiqueta de envio gerada na remessa com serviço especial ETD com critérios de upload de documento após a remessa. Essa etiqueta também pode ser carregada com a remessa, juntamente com outros documentos.

Fatura pró-forma

A fatura pró-forma é emitida antes da realização da venda. Após receber a fatura pró-forma do fornecedor, o comprador envia um pedido de compra ou abre uma carta de crédito para o fornecedor. Conforme a data de envio acordada, o vendedor providencia o envio da mercadoria.

Fatura comercial USMCA e Certificado de origem

A certificação de origem (COO) do USMCA é obrigatória para mercadorias que se qualificam para entrada isenta de imposto ou com imposto reduzido como produto originado de um dos três participantes do ACORDO ESTADOS UNIDOS-MÉXICO-CANADÁ (USMCA/T-MEC/CUSMA), Canadá, México e Estados Unidos. A certificação é preenchida pelo exportador ou pelo fabricante das mercadorias.

Certificado de origem USMCA

É necessário apresentar uma fatura comercial e a certificação de origem (COO) do USMCA para mercadorias que se qualificam para entrada sem imposto aduaneiro ou com imposto reduzido como produto originado de um dos três participantes do Acordo Estados Unidos-México-Canadá (USMCA/T-MEC/CUSMA), Canadá, México ou Estados Unidos. A certificação é preenchida pelo exportador ou pela fabricante das mercadorias e é fornecida com a fatura comercial.

Outros

A seção a seguir descreve alguns dos documentos comuns que são classificados em outros documentos. O upload desses documentos não é obrigatório para uma remessa, mas pode ser exigido para a liberação alfandegária da sua remessa individual. Isso poderá variar com base no tipo de remessa, origem, destino e outros fatores.

  • Romaneio

    • O romaneio será obrigatório se houver mais de um pacote em um conhecimento aéreo ou se a remessa pesar mais de 100 kg. Observe que essa exigência pode variar de um país para outro com base nas mercadorias sendo enviadas. A lista deve descrever correta e claramente a mercadoria, a quantidade e o peso.

  • Declaração FCC 740 Referente à Importação de Dispositivos de Radiofrequência que podem Causar Interferência Danosa

    • O formulário 740 da Comissão Federal de Comunicação (FCC) é obrigatório ao enviar produtos eletrônicos com dispositivos de radiofrequência capazes de causar interferência prejudicial. O formulário inclui detalhes como o modelo/nome do tipo do dispositivo, código do Sistema Harmonizado, nome e endereço do fabricante, nome e endereço do consignatário e nome e endereço do importador.

  • Declaração para Vídeos e Filmes

    • Declaração para vídeos e filmes: este documento é enviado para declarar que o filme/vídeo enviado não contém nenhum assunto obsceno ou imoral, nem qualquer assunto que defenda ou incite insurreição contra os Estados Unidos. O documento envolve detalhes como tamanho do filme/vídeo, duração do filme/vídeo e uma breve sinopse do conteúdo.

Isenção de responsabilidade: as informações acima estão sujeitas a alterações.

Os documentos na categoria "Outros" só são carregados em caso de exigências específicas com base no país, produto ou outro requisito alfandegário especial. Para exibir uma lista de diversos documentos comumente usados, acesse Documentos de exportação.

Requisitos e documentos alfandegários

A documentação precisa é um elemento importante do transporte doméstico e internacional. Cada país tem leis e regulamentos específicos sobre remessas internacionais. Para remessas de exportação nos EUA, os EUA e os países de destino exigem diferentes tipos de documentos regulatórios.

Observação: as remessas que exigem documentação além do conhecimento aéreo internacional FedEx, do conhecimento aéreo FedEx International Next Flight ou do conhecimento aéreo do serviço FedEx International Mail (ex., uma fatura comercial) podem exigir tempo de trânsito adicional.

Mercadorias controladas

Ao enviar as mercadorias a seguir internacionalmente, certifique-se de que elas sejam aceitas pelo serviço FedEx escolhido para entrega ao país e à cidade de destino:

  • Carga Perigosa
  • Normas referentes ao comércio internacional de armas (ITAR, International Traffic in Arms Regulations)
  • Carga perigosa em quantidade excepcional.
    Observação: para enviar carga perigosa em quantidade excepcional, use a opção de serviço especial SMALL_QUANTITY_EXCEPTION.
  • Pacote radioativo excepcional

Isenção de responsabilidade: as informações acima estão sujeitas a alterações e para obter mais informações, acesse o Guia de serviço ou entre em contato com seu representante da FedEx.

Declaração de exportação para remessas de saída do Canadá

A declaração de exportação é exigida pela CBSA (Agência de Serviços Fronteiriços do Canadá) para informar exportações do Canadá nas condições a seguir.

  • Todas as remessas de saída do Canadá contendo mercadorias não restritas quando seu valor comercial for avaliado em CAD 2.000,00 ou mais e o destino das mercadorias não for os Estados Unidos, Porto Rico ou as Ilhas Virgens dos Estados Unidos.
  • Todas as remessas de saída do Canadá contendo mercadorias controladas, restritas ou regulamentadas, independente do valor.

As transportadoras devem receber de você o número do comprovante do relatório antes que as mercadorias deixem o Canadá. O exportador precisa enviar a declaração de exportação antes de fornecer o número do comprovante do relatório à transportadora.

Informações Eletrônicas de Exportação (EEI)

As EEI são dados de exportação eletrônicos arquivados no Sistema de Exportação Automatizado (AES) usando AESDirect no Ambiente Comercial Automatizado (ACE). O portal de segurança de dados do ACE (ACE Portal) é um ponto de acesso centralizado para a comunidade comercial se conectar com a Alfândega e Proteção de Fronteiras (CBP) dos EUA.

As EEIs são a versão eletrônica da Declaração de Exportação do Remetente (SED), do Departamento de Comércio (Departamento de Censo), formulário 7525-V, que não pode mais ser enviada ao governo dos EUA. As EEI fornecem estatísticas de exportação e controle, relatando todos os dados de exportação pertinentes de uma transação de remessa internacional.

As EEI são obrigatórias e devem ser enviadas eletronicamente pelo Sistema de Exportação Automatizado (AES) para as mercadorias incluídas na Lista de Controle de Comércio (CCL).

Se a remessa for originada dos EUA, Ilhas Virgens dos EUA ou Porto Rico para os países de destino China, Rússia, Venezuela e Hong Kong, independentemente do valor da remessa, você deverá fornecer as seguintes informações:

  • Um registro de EEI para Número interno de transação (ITN)
  • O Export Control Classification Number (ECCN) correto ou o número de classificação EAR99 para cada item, ou
  • Uma isenção de registro aplicável

Isenções serão permitidas se o envio:

  • For elegível para exceção de licença GOV
  • For elegível para exceções nos Regulamentos de Administração da Exportação e Regulamentos de Comércio Exterior (FTR), ou
  • Consistir apenas em itens classificados como EAR99

Observação: para outros destinos, você deve registrar uma EEI para todas as remessas de exportação dos EUA se uma ou mais mercadorias (número Schedule B) totalizarem mais de US$ 2.500 na remessa consolidada em qualquer dia.

Carta de instrução do remetente (SLI)

A SLI pega informações de remessas internacionais para clientes dos EUA.

Observação:

  • A liberação alfandegária está inclusa para remessas para o Canadá por meio de nosso serviço de corretagem. Uma taxa é aplicada. A inclusão do serviço de corretagem pode não estar disponível em todas as soluções de remessa eletrônica.

O serviço de distribuição de pacotes FedEx International Ground® permite que o FedEx Ground® consolide as remessas FedEx International Ground® em uma unidade que é liberada e processada como uma entrada alfandegária com uma única taxa de entrada do agente.

Benefícios da API de upload de documentos comerciais

A seguir estão alguns dos benefícios associados ao recurso/API de upload de documentos comerciais:

  • Minimize os problemas de liberação alfandegária e reduza os atrasos alfandegários, o que aumenta a confiabilidade do transporte e a reputação do vendedor.
  • Mais tempo para construir o negócio melhora a produtividade e o lucro da empresa, eliminando a necessidade de imprimir e combinar várias cópias de documentos com pacotes individuais.
  • Permite adicionar um timbre da empresa e uma imagem de assinatura à fatura comercial gerada pela FedEx ou à fatura pró-forma.
  • Tenha mais tempo para resolver questões relacionadas aos documentos alfandegários, como falta de informações, antes da chegada da remessa.
  • Permite enviar sua fatura comercial eletronicamente para remessas da FedEx International Ground para o Canadá.
  • Envie documentos alfandegários à FedEx para remessas em data futura ou qualquer data a partir do dia de hoje até dez dias no futuro.
  • Maior paz de espírito, as informações sobre mercadorias não são reveladas a terceiros porque as faturas não estão nas embalagens.
  • Reduz a pegada de carbono ao diminuir o consumo de papel, toner e materiais de transporte e o uso de impressoras.
  • Reduza as chances de roubo de remessas, já que não há faturas nos pacotes e as informações das mercadorias não são reveladas a terceiros.
  • Economize tempo e reduza erros ao fazer envios internacionais.
  • Esse recurso de upload de documento pode ser usado para remessas de importação e exportação. Visualize a lista de países disponíveis para ver se o upload de documentos é aceito nos países de origem/destino.
  • Você pode preparar, armazenar e reutilizar documentos carregados online no Centro de preparação de documentos FedEx e na seção Ajuda para documentos internacionais.

Regras do negócio

Algumas das regras de negócios importantes associadas ao recurso/API de upload de documentos são:

  • Os tipos de arquivos válidos para documentos carregados são PDF, TXT, PNG, JPG, GIF, BMP, TIF, RTF, DOC, DOCX, XLS e XLSX.
  • Os documentos podem ser carregados no máximo 10 dias antes da remessa.
  • Cada documento comercial ou imagem carregada não pode exceder 5 MB.
  • Para assinatura digital, a limitação é de 240x25 pixels e as imagens podem estar nos formatos GIF e PNG.
  • Para timbre/logotipo da empresa, a limitação é de 700x50 pixels e as imagens podem estar nos formatos GIF e PNG.
  • A imagem do timbre pode não ser aceita em todas as localizações de origem e destino de acordo com os regulamentos alfandegários.
  • As imagens serão carregadas como estão e nenhuma correção é fornecida pela FedEx.
  • A documentação alfandegária pode ser carregada eletronicamente com as seguintes opções especiais de manuseio e serviço:
    • Gelo seco
    • Carga Perigosa
    • Materiais perigosos
  • Obrigatório para remessas TPC (consignatários de terceiros) originárias dos países da União Europeia (UE), Ásia-Pacífico, Estados Unidos (EUA) e Canadá (CA) sempre que o upload estiver ativado.
  • Todas as remessas com documentos eletrônicos devem ser criadas, carregadas e retiradas no dia da remessa solicitada.
  • Ao usar PSDU (upload de documentos após a remessa), certifique-se de fazer o upload do(s) documento(s) antes de retirar o pacote.

 

 

 

 

Documentation Powered by ReDoc

Trade Documents Upload API (1.0.2)

Upload Document

Use this endpoint to upload the trade documents electronically before (pre-shipment) and after (post-shipment) the shipment is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters
Content-Type
required
string
Default: "multipart/form-data"

Indicates the type of content
Example: "multipart/form-data"

Authorization
required
string
Default: "Bearer ****"

Indicates the JWE token to be used for authorizing the client request.
Example: "Bearer ****"

x-customer-transaction-id
string
Example: 771407-1

This is the customer transaction identifier.
Example: 771407-1

Request Body schema: multipart/form-data
One of
  • FullSchema-DocumentUploadInputVO
attachment
required
string <file>

Input the actual document/file to be uploaded.

document
required
object (ETDUploadRequest)

Provide all the document details and shipment meta data.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /documents/v1/etds/upload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/upload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/upload

Request samples

Content type
multipart/form-data
Example
Full-Schema
Copy
document: {"workflowName":"ETDPreshipment","carrierCode":"FDXE","name":"file.txt","contentType":"text/plain","meta":{"shipDocumentType":"COMMERCIAL_INVOICE","formCode":"USMCA","trackingNumber":"794791292805","shipmentDate":"2021-02-17T00:00:00","originLocationCode":"GVTKK","originCountryCode":"US","destinationLocationCode":"DEL","destinationCountryCode":"IN"}}
attachment: file.txt

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "output":
    {
    },
  • "customerTransactionId": "XXXX_XXX123XXXXX"
}

Upload Images

Use this endpoint to upload customized Company Letterhead/Logo and Digital signature images which can be used in the FedEx generated paperwork or reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters
Authorization
required
string
Example: Bearer XXX

Specifies the authorization token.
Example: Bearer XXX

x-customer-transaction-id
required
string
Example: 771407-1

Identifies the transaction ID of the request.
Example: "771407-1"

Request Body schema: multipart/form-data
attachment
required
string <file>

Input the actual image file to be uploaded.

document
required
object (Document)

Indicate the image reference metadata details.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /documents/v1/lhsimages/upload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/lhsimages/upload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/lhsimages/upload

Request samples

Content type
multipart/form-data
Copy
document: {"document": {"referenceId": "1234", "name": "LH2.PNG",    "contentType": "image/png",    "meta": { "imageType": "SIGNATURE","imageIndex": "IMAGE_1"}},"rules": {"workflowName": "LetterheadSignature" }}
attachment: file.PNG

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "output":
    {
    },
  • "customerTransactionId": "XXXX_XXX123XXXXX"
}

Upload Multiple Documents

Use this endpoint to upload multiple trade documents electronically before (pre-shipment) and after (post-shipment) the shipment is created

header Parameters
Content-Type
required
string
Default: "multipart/form-data"
Example: multipart/form-data

Type of content

Authorization
required
string
Default: "Bearer XXXXXX"
Example: Bearer XXXXXX

This indicates the authorization token for the input request.

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

Request Body schema: multipart/form-data
One of
  • FullSchema-MultiDocumentRequest
  • MinimumSamplePayload-MultiPreShipment
  • MinimumSamplePayload-MultiPostShipment
documentInformation
object (MultiETDUploadRequest)

Provide all the documents' details and shipment meta data

fileAttachments
Array of strings <binary> <= 5 items

Input the actual document/file to be uploaded.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

INTERNAL.SERVER.ERROR

503

Service Unavailable

post /documents/v1/etds/multiupload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/multiupload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/multiupload

Request samples

Content type
multipart/form-data
Example
FullSchema-MultiDocumentRequest
Copy
documentInformation: {"workflowName": "ETDPreshipment","carrierCode": "FDXE","originCountryCode": "US","destinationCountryCode": "CA","shipmentDate": "2021-10-21T00:00:00","trackingNumber": "782514212510","metaData": [{"fileName":"file1.png","fileReferenceId":"inv_file1_ctx_02132021_5","contentType": "image/png","formCode": "USMCA","shipDocumentType":"COMMERCIAL_INVOICE"},{"fileName":"file2.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"fileName":"file3.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"fileName":"file4.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"file5.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"}]
fileAttachments: 'file1.png'
fileAttachments: 'file2.txt'
fileAttachments: 'file3.txt'
fileAttachments: 'file4.txt'
fileAttachments: 'file5.txt'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerTransactionId": "5678b975-ev0e-420b-8d7b-aa6ce65ec48n",
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "output":
    {
    }
}

Upload Multiple Encoded Documents

Use this endpoint to upload multiple trade documents as base64 electronically before (pre-shipment) and after (post-shipment) the shipment is created

header Parameters
Content-Type
required
string
Default: "application/json"
Example: application/json

Type of content

Authorization
required
string
Default: "Bearer XXXXXX"
Example: Bearer XXXXXX

This indicates the authorization token for the input request.

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

Request Body schema: application/json
One of
  • FullSchema-Base64MultiDocumentRequest
  • MinimumSamplePayload-Base64MultiPreShipment
  • MinimumSamplePayload-Base64MultiPostShipment
workflowName
required
string
Enum: "ETDPreshipment" "ETDPostshipment"

Indicate if the documents are being uploaded before or after shipment creation process

carrierCode
required
string
Enum: "FDXE" "FDXG"

Specify the four letter code of a FedEx operating company that meets your requirements
Examples of FedEx Operating Companies are:

  • FDXE - FedEx Express
  • FDXG - FedEx Ground

orginCountryCode
required
string

Origin country code for the shipment.

Example: US
Click here to see Country Codes

destinationCountryCode
required
string

Destination country code for the shipment.

Example: CA

shipmentDate
string

Specify the Shipment date. This is only required for Post Shipment document upload. This value is present in Create Shipment response & this should match the shipment date timestamp

trackingNumber
string

Specifies the tracking number of the shipment. This is only required for Post Shipment documentation upload.
Example: 782514212510

metaData
required
Array of objects (MultiMetaDataRequest_1) <= 5 items

Indicate the shipment metadata associated with the document to be uploaded

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

INTERNAL.SERVER.ERROR

503

Service Unavailable

post /documents/v1/etds/encodedmultiupload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/encodedmultiupload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/encodedmultiupload

Request samples

Content type
application/json
Example
FullSchema-Base64MultiDocumentRequest
Copy
 Expand all Collapse all
{
  • "workflowName": "ETDPreshipment",
  • "carrierCode": "FDXE",
  • "originCountryCode": "US",
  • "destinationCountryCode": "CA",
  • "shipmentDate": "2024-01-06T00:00:00",
  • "trackingNumber": "782514212510",
  • "metaData":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerTransactionId": "5678b975-ev0e-420b-8d7b-aa6ce65ec48n",
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "output":
    {
    }
}
CLOSE

Response

Copy