Global Trade API
Introdução
A API Global Trade permite que você obtenha a lista de todos os documentos regulatórios que a sua remessa precisará antes de enviá-la. Documentos regulatórios corretos evitam os problemas de conformidade regulatória que costumam gerar multas e atrasos na liberação alfandegária, e que deixam o cliente insatisfeito com as entregas.
A API também:
- Fornece informações importantes da FedEx, informações regulatórias governamentais e orientações específicas à remessa, como:
- Circunstâncias atuais que afetam as remessas
- Clima e outras interrupções
- Novidades e atualizações de cunho regulatório
- Permite determinar se a remessa exige que as Informações Eletrônicas de Exportação (EEI) sejam registradas na alfândega dos EUA.
- Permite registrar as EEI na alfândega dos EUA usando a FedEx como agente.
- Recupera o Número interno de transação (ITN), que pode ser usado na transação da remessa subsequente para associar às EEI correspondentes.
Para obter mais informações sobre as EEI, visite as páginas abaixo:
Detalhes da API Global Trade
Com esta API, você obtém a lista completa de orientações e documentos regulatórios necessários aplicáveis à remessa. Ela também permite determinar se é necessário registrar as EEI da remessa e, em caso afirmativo, ajuda você a registrá-las na alfândega dos EUA e a obter o ITN da remessa.
Veja a seguir as funcionalidades associadas à API Global Trade:
Obter detalhes regulatórios
Use esta funcionalidade para obter a lista dos documentos que precisam acompanhar suas remessas internacionais e evitar problemas durante a liberação alfandegária.
Todos os dossiês, arquivamentos, solicitações, modificações, alterações, suplementos, revisões, relatórios, submissões, autorizações e aprovações, relatórios ou adendos necessários para manter as aprovações regulatórias estão especificados nas fases iniciais da remessa marítima internacional.
Estes são os tipos de documentos regulatórios suportados:
- FEDEX_GENERATED - Especifica que o documento é configurado e gerado por um sistema interno da FedEx. O documento não pode ser configurado ou modificado pelo cliente. Exemplo: Fatura comercial gerada pela FedEx, Fatura pro forma gerada pela FedEx.
- FILLABLE- Especifica os formulários e documentos que podem ser preenchidos on-line ou depois de baixados dos sites da FedEx. Esses formulários também podem ser obtidos nos centros de envio FedEx e preenchidos. Exemplo: CN 22 formulário de Declaração Aduaneira Postal
- PRINT_ONLY- Especifica os documentos e formulários que só são aceitos em formato impresso. Exemplo: faturas
- SAMPLE- Especifica os documentos gerados pela FedEx como amostra. Exemplo: amostra de fatura comercial
Obter comunicados
Esta funcionalidade possibilita a obtenção de informações regulatórias importantes, além de comunicados da FedEx ou do governo específicos para a remessa. Os comunicados podem estar relacionados ao clima e interrupções de serviço, ou podem ser notas oficiais de alerta emitidas por um órgão público informando se é seguro viajar para um ou mais países ou destinos estrangeiros específicos.
A seguir, os diferentes tipos de comunicados com suporte da FedEx:
- APPLICATION
- DOCUMENT_SPECIFIC
- FEDEX
- GOVERNMENT
- INSPECTION
- LICENSE_OR_PERMIT
- MAYBE_DOCUMENT
- MAYBE_STATEMENT
- PROHIBIT
- UNIT_OF_MEASURE
- WAIVER
Informações Eletrônicas de Exportação (EEI)
As Informações Eletrônicas de Exportação (EEI) são documentos obrigatórios quando o valor da mercadoria classificada sob um número específico da Tabela B é superior a US$ 2.500 ou quando uma licença de exportação validada é exigida para exportar a mercadoria.
As EEI são dados que devem ser registrados no Sistema de Exportação Automatizado (AES) para mercadorias enviadas dos EUA para outro país. O registro inclui informações sobre o remetente, o destinatário e as mercadorias sendo exportadas. O Departamento do Censo dos EUA usa esses registros para calcular as estatísticas comerciais dos EUA, e a Alfândega e Proteção de Fronteiras (CBP) e o Departamento de Indústria e Segurança (BIS) usam os dados para ajudar a garantir a conformidade com as regras de exportação dos EUA.
O exportador é responsável por preparar as EEI, e a transportadora as registra na Alfândega e Proteção de Fronteiras (CBP) dos EUA usando o Ambiente Comercial Automatizado (ACE) e, dentro dele, o AES Direct. Para cada registro de EEI, o AES gera um ITN exclusivo confirmando que a transação de EEI foi aceita e registrada no AES.
Requisitos
O cliente deve usar o número de uma conta estabelecida nos EUA.
Requisitos de trânsito:
- Dos EUA, Porto Rico ou Ilhas Virgens Americanas para destinos estrangeiros.
- Entre os EUA e Porto Rico.
- Dos EUA ou Porto Rico para as Ilhas Virgens Americanas.
Mercadorias com o mesmo número da tarifa harmonizada ou da Tabela B, valor superior a US$ 2.500,00 e sendo enviadas do mesmo exportador para o mesmo destinatário no mesmo dia.
(Observação: remessas do Canadá para os EUA podem estar isentas desse requisito.)
- Diamantes brutos classificados na tabela de tarifas harmonizadas como 7102.10, 7102.21 e 7102.31.
- Itens que exigem licença ou autorização de exportação do governo dos EUA.
- Itens sujeitos aos Regulamentos do Tráfego Internacional de Armas (ITAR).
- Ou itens sujeitos aos requisitos de mercadoria, usuário final ou destino incluídos nos Regulamentos de Comércio Exterior (FTR) dos EUA.
Como funciona a API de comércio global
Obter detalhes regulatórios
Use este endpoint para obter, antecipadamente, comunicados ou documentos regulatórios necessários para uma remessa.
Veja a seguir as informações necessárias associadas a este endpoint.
- Endereço de origem – Especifique os detalhes da origem, como país, CEP e código de província/estado, se aplicável.
- Endereço de destino – Especifique os detalhes do destino, como país, CEP e código de província/estado, se aplicável.
- Detalhes da liberação alfandegária – Especifique as despesas de liberação alfandegária, código harmonizado e medidas adicionais da remessa.
- Código da transportadora – Especifique a transportadora FedEx necessária para a remessa.
- Peso total – Especifique o peso total da remessa usando a unidade de medida apropriada.
Caso a solicitação seja bem-sucedida, você verá uma lista de todos os documentos regulatórios e os comunicados compatíveis com os dados fornecidos. Em caso de erros na solicitação, você verá as mensagens e o código de erro no objeto de erro.
Busca de conformidade regulatória
Use este endpoint para determinar se alguma regulamentação de conformidade de exportação e/ou importação se aplica à remessa.
Estes são os tipos de conformidade compatíveis no momento:
Exportação:
- O registro das EEI de uma remessa na alfândega dos EUA é obrigatório.
Importação:
- Nenhum
Estas são as informações necessárias associadas a este endpoint:
- shipDate: especifique a data da remessa.
- carrierCode: especifique o código de transportadora da FedEx. Exemplo: FXE.
- originAddress:
- countryCode: especifique o código do país de origem da remessa.
- destinationAddress:
- countryCode: especifique o código do país de destino da remessa.
- serviceType: especifique o tipo de serviço da empresa operante da FedEx escolhido. Exemplo: IP, SG, PO etc.
- serviceOptionTypes: especifique o recurso do tipo de serviço. Exemplo: FICE, ITAR.
- totalWeight: especifique o peso total da remessa.
- units: especifique a unidade de medida do peso. Exemplo: KG, LB etc.
- value: especifique o peso da remessa. Exemplo: 68,50.
- consolidationType: especifique o tipo de consolidação. Exemplo: IPD.
- consolidationRole: especifique a função da remessa na consolidação. Exemplo: CRN_SHIPMENT.
- totalCommodityValue: especifique o valor total da remessa.
- regulatoryCustomsClearanceDetail: especifique os detalhes alfandegários regulatórios.
A resposta bem-sucedida a esta solicitação informará se a remessa exige o registro das EEI ou não.
Registro de EEI
Use este endpoint para registrar as EEI na alfândega dos EUA ou atualizar ou cancelar EEI existentes.
Estas são as informações necessárias associadas a este endpoint:
- processingOption: especifique a opção de processamento da solicitação de EEI. Exemplo: ADD, UDPATE, CANCEL.
- eeiControlDetail:
- shipDate: especifique a data da remessa.
- accountNumber: especifique o número de conta FedEx.
- eeiPartyDetails: especifique os detalhes do remetente:
- eeiShipmentPartyType
- eeiContactAndAddress
- contact:
- companyName: especifique o nome da empresa.
- address:
- streetlines: especifique o endereço da empresa. Exemplo: BUILDING.
- city: especifique a cidade da empresa. Exemplo: PARIS.
- countryCode: especifique o código do país. Exemplo: US.
- contact:
- eeiCommodities
- commodity: especifique o item de linha da mercadoria na remessa.
- description: descreva a mercadoria.
- harmonizedCode: especifique o código harmonizado.
- quantityUnits: especifique o código da unidade de medida conforme prescrito pelo número informado em B/HTS.
- Weight: especifique o peso da mercadoria.
- Units: especifique a unidade de medida do peso. Exemplo: KG.
- HarmonizedCode: especifique o código harmonizado.
- quantityUnits: especifique o código da unidade de medida conforme prescrito pelo número informado em B/HTS.
- weight: especifique o peso da mercadoria.
- Units: especifique a unidade de medida do peso. Exemplo: KG.
- exportInformationCode: especifique o código das informações de exportação. Exemplo: GP.
- eeiCommodityLicenseDetail:
- licenseCode: especifique o código da licença.
- commodity: especifique o item de linha da mercadoria na remessa.
A resposta bem-sucedida a esta solicitação registrará as EEI da remessa na alfândega dos EUA e retornará um número de referência da remessa (SRN). O ShipmentReferenceNumber (SRN) recebido na resposta é necessário para obter o Número interno de transação (ITN).
Recuperação do ITN
Use este endpoint para obter o Número interno de transação (ITN) das EEI que já foram registradas na alfândega dos EUA.
Estas são as informações necessárias associadas a este endpoint:
- shipmentReferenceNumber: especifique o número de referência da remessa recebido da transação FileEEI.
A resposta bem-sucedida a esta solicitação retornará o ITN das EEI registradas. Esse ITN deve ser especificado na solicitação de transação de remessa correspondente.
Por exemplo, na Ship API, os elementos a seguir devem ser preenchidos para o envio do número de isenção de ITN ou EEI à FedEx.
Elemento | Descrição |
---|---|
Sender/Tins/TinType |
Como remetente, suas informações de identificação fiscal devem ser carregadas na FedEx para remessas com EEI. Especifique o Número de Identificação do Empregador (EIN). Valores válidos:
|
Sender/Tins/Number |
Especifique a identificação/número do contribuinte com o número de ID correspondente para TinType. |
CustomsClearanceDetail/ExportDetail/ExportComplianceStatement |
No caso de remessas com exigência de EEI, insira o ITN recebido do AES quando você registrou a remessa ou o número de isenção dos Regulamentos de Comércio Exterior (FTR), ou ainda o ITN recebido quando as EEI foram registradas pela FedEx. O formato correto de um ITN é AES XAAAAMMDDNNNNNN, em que AAAAMMDD é a data e NNNNNN são números gerados pelo AES. |
Observação: o ITN ou o número de isenção dos FTR que você especifica na solicitação de envio é impresso na etiqueta de envio internacional.
Documentos da remessa
Ter a documentação correta é fundamental em qualquer remessa internacional e doméstica para evitar confisco ou atrasos do pacote e garantir que ele seja entregue sem contratempos.
A seguir, os diferentes tipos de documento de remessa e alfandegários que estão disponíveis por meio da API Global Trade Manager da FedEx.
Observação:
- Dependendo da natureza exata das mercadorias, sua remessa precisará de outros documentos comerciais não listados aqui. Em caso de dúvida, entre em contato com o Serviço de Atendimento ao Cliente FedEx para saber quais documentos devem ser incluídos para garantir a liberação rápida da remessa.
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.
[Service ENUM : CERTIFICATE_OF_ORIGIN]
Fatura Comercial (CI)
É 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. Observe que as faturas geradas pela FedEx não possuem essa opção. 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. [Service ENUM: COMMERCIAL_INVOICE]
Para obter mais informações, visite a página do FedEx Global Trade Manager.
Declaração do remetente de carga perigosa
Esta é a declaração do remetente para remessas classificadas como carga perigosa com base no Guia de Dados de Segurança (SDG), na International Air Transport Association (IATA) e na International Civil Aviation Organization (ICAO). O formulário FX 18 exige que os fornecedores reconhecidos pela FedEx apresentem o formulário de Carga Perigosa do Remetente para remessas de cargas classificadas como perigosas originadas nos EUA.
[Service ENUM: DANGEROUS_GOODS_SHIPPERS_DECLARATION]
Declaração de exportação
As Informações Eletrônicas de Exportação (EEI), antigamente conhecidas como Declaração de Exportação do Remetente (SED), são exigidas pelo Departamento de Censo dos EUA para obter dados estatísticos e pelo Departamento de Indústria e Segurança (BIS) para ajudar com os controles de exportação. A SED/EEI é exigida quando o valor total das mercadorias enquadradas em qualquer número da programação B exceder USD 2.500 ou quando as mercadorias exigirem uma licença de exportação. Essas informações podem ser preenchidas eletronicamente pelo exportador ou pelo agente. As informações são obrigatórias e devem ser enviadas eletronicamente pelo Sistema de Exportação Automatizado (AES) para as mercadorias que constam na Lista de Controle de Comércio (CCL) ou na Lista de Munições dos EUA (USML).
Observação: isso só é necessário para remessas de exportação dos EUA.
[Service ENUM: EXPORT_DECLARATION]
Contrato de Representação Geral (GAA - General Agency Agreement)
Um Contrato de agência ou Procuração (POA) é a autorização legal fornecida pelos importadores a um despachante aduaneiro para permitir que eles liberem e/ou respondam pelas remessas junto à Agência de Receita do Canadá (CRA) em nome da empresa do importador. Se um importador residente no Canadá desejar que a Federal Express atue continuamente como seu despachante aduaneiro no Canadá, esses formulários deverão ser preenchidos e devolvidos de acordo com a folha de instruções antes da exportação para o Canadá. Esse formulário é um Contrato de agência limitado e se aplica apenas a remessas da Federal Express. Este formulário é oferecido em um formato de fácil preenchimento e uso na seção da biblioteca de documentos deste site.
[Service ENUM: GENERAL_AGENCY_AGREEMENT]
OP900
Este formulário é exigido pelo Departamento de Transportes dos EUA para envio de material perigoso. O cliente receberá o formulário OP-900 específico a ser preenchido com base na remessa.
Exemplos:
- OP-900LL se a remessa for uma impressora a laser.
- OP-900LG se a remessa for uma impressora matricial.
Observação: não são mais aceitos formulários manuais. Você deve preencher o formulário e nos enviar uma cópia digital do documento preenchido.
[Service ENUM: OP_900]
Fatura pro forma
A fatura pró-forma é emitida antes da venda ser realizada. Ao receber a fatura pró-forma do fornecedor, o comprador envia um pedido de compra ou abre uma carta de crédito para o fornecedor. Na data acordada, o vendedor providencia o envio das mercadorias.
[Service ENUM: PRO_FORMA_INVOICE]
Conhecimento Aéreo VICS
O formulário de Conhecimento Aéreo VICS é criado pelo Padrão Voluntário de Comércio entre Ramos de Atividade (Voluntary Inter-Industry Commerce Standards, VICS) e é usado principalmente para remessas do setor de varejo de mercadorias em geral.
[Service ENUM: VICS_BILL_OF_LADING]
Fatura Comercial USMCA e Certificado de Origem
A Fatura comercial - Certificado de origem do USMCA/T-MEC/CUSMA é uma fatura comercial combinada com os elementos de dados do certificado de origem necessário. Isso inclui uma declaração que fornecerá uma maneira de enviar e reivindicar tratamento tarifário preferencial para mercadorias qualificadas usando um documento para o acordo entre os Estados Unidos, o México e o Canadá. As mercadorias que se qualificam para o tratamento tarifário preferencial devem ser originárias e exportadas dos EUA, México ou Canadá. [Service ENUM: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]
Certificado de Origem USMCA
O Certificado de Origem USMCA/T-MEC/CUSMA é um formulário utilizado para solicitar tratamento tarifário preferencial segundo o Acordo entre os Estados Unidos, México e Canadá. O certificado contém um conjunto de elementos de dados incluindo uma declaração e deve ser confirmado pelo exportador, produtor ou importador para mercadorias qualificadas. As mercadorias importadas devem ser originárias e exportadas dos EUA, México ou Canadá. O formulário pode ser usado para abranger uma única remessa ou um período generalizado de até doze meses.
[Service ENUM: USMCA_CERTIFICATION_OF_ORIGIN]
Regras do negócio
- A fatura comercial deve ser preparada no idioma oficial do país/território para o qual as mercadorias estão sendo exportadas. As faturas geradas pela FedEx não fornecem essa opção, portanto, os clientes são responsáveis por imprimir sua própria fatura comercial.
- A FedEx aceita apenas as cópias digitais dos formulários OP-900. Formulários manuais não são aceitos.
Coleção JSON API
Global Trade - API (1.0)
Retrieve Regulatory Details
Use this endpoint to retrieve regulatory document and advisories for your shipment.
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
- FullSchema
- MinimumSamplePayload
serviceType | string Specify the type of service that is used to ship the package. |
totalCommodityValue | object Specify the total commodity value. Either customsClearenceDetail or totalCommodityValue is required. |
originAddress required | object Provide the shipment origin address details. |
destinationAddress required | object Provide the shipment destination address details. |
serviceOptionType | Array of strings Items Enum: "FEDEX_ONE_RATE" "FREIGHT_GUARANTEE" "SATURDAY_DELIVERY" "SMART_POST_ALLOWED_INDICIA" "SMART_POST_HUB_ID" Specify attributes to filter location types. If more than one value is specified, only those locations that have all the specified attributes will be returned. |
customsClearanceDetail | object Specify the Customs clearance details.Either customsClearenceDetail or totalCommodityValue is required. |
shipDate | string Specify shipment date. |
carrierCode required | string Specify the four letter code of a FedEx operating company that meets your requirements.
Example: FDXE |
totalWeight | object Provide the total weight for the shipment. |
includeURLReferences | boolean Specify if the url references to be included in the output. These are regulatory reference data urls specific to document, agency. |
consolidationType | string Specify the type of consolidation that contains this shipment.
|
consolidationRole | string Specify the role this shipment plays within the consolidation.
|
Responses
Success
Bad Request
Unauthorized
Not Found
UnProcessable Entity
Failure
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "serviceType": "FEDEX_FREIGHT_ECONOMY",
- "totalCommodityValue": {
- "amount": 12.45,
- "currency": "USD"
- "originAddress": {
- "countryCode": "US",
- "postalCode": "75063",
- "stateOrProvinceCode": "TX"
- "destinationAddress": {
- "countryCode": "US",
- "postalCode": "75063",
- "stateOrProvinceCode": "TX"
- "serviceOptionType": [
- "FEDEX_ONE_RATE",
- "SATURDAY_DELIVERY"
- "customsClearanceDetail": {
- "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
- "insuranceCharges": {
- "amount": 12.45,
- "currency": "USD"
- "importerOfRecordAccountNumber": {
- "0": "8",
- "1": "9",
- "2": "7",
- "3": "6",
- "4": "5",
- "5": "4",
- "6": "5",
- "7": "6",
- "8": "4"
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "commercialInvoice": {
- "freightCharge": {
- "amount": 12.45,
- "currency": "USD"
- "purpose": "SOLD"
- "commodities": [
- {
- "quantity": "string",
- "quantityUOM": "string",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "countryOfManufacture": "US",
- "name": "string",
- "harmonizedCode": "0613",
- "description": "string",
- "weight": {
- "units": "KG",
- "value": 68
- "commodityId": 0,
- "additionalMeasures": {
- "uom": "string",
- "quantity": 0
- "documentContent": "DOCUMENT"
- "shipDate": "2019-10-14",
- "carrierCode": "FDXE",
- "totalWeight": {
- "units": "KG",
- "value": 68
- "includeURLReferences": true,
- "consolidationType": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
- "consolidationRole": "CONSOLIDATION_DOCUMENTS_SHIPMENT"
Response samples
- 200
- 400
- 401
- 404
- 422
- 500
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "userMessages": [
- {
- "code": "1028",
- "messageParameters": [
- {
- "id": "1",
- "value": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment"
- "index": 1,
- "text": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment",
- "localizedText": "Selon les informations fournies sur l envoi, seul le type de produit / document est autorisé pour cet envo"
- "countryDetails": {
- "shipmentDetails": {
- "regulatoryStatements": {
- "userMessage": {
- "code": "1028",
- "messageParameters": [
- {
- "id": "1",
- "value": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment"
- "index": 1,
- "text": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment",
- "localizedText": "Selon les informations fournies sur l envoi, seul le type de produit / document est autorisé pour cet envo"
- "supportType": "FEDEX_GENERATED",
- "allowability": "string",
- "fileName": "string",
- "agencyUrl": "string",
- "documentUrl": "string",
- "id": "string",
- "completionType": "COMPLETE",
- "agencyName": "string",
- "localizedAttributes": {
- "localization": {
- "localization": "EN",
- "localeCode": "us"
- "name": "string",
- "description": "string"
- "documentIds": [
- "string"
- "statementUrl": "string"
- "requiredCommodityUnitsOfMeasure": [
- "string"
- "level": "string",
- "commodityIndex": 0,
- "regulatoryDocuments": {
- "userMessage": {
- "code": "1028",
- "messageParameters": [
- {
- "id": "1",
- "value": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment"
- "index": 1,
- "text": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment",
- "localizedText": "Selon les informations fournies sur l envoi, seul le type de produit / document est autorisé pour cet envo"
- "supportType": "FEDEX_GENERATED",
- "allowability": "string",
- "fileName": "string",
- "documentType": "string",
- "agencyUrl": "string",
- "documentUrl": "string",
- "id": "string",
- "agencyName": "string",
- "localizedAttributes": {
- "localization": {
- "localization": "EN",
- "localeCode": "us"
- "name": "string",
- "description": "string"
- "regulatoryCountryAdvisories": {
- "types": "string",
- "messages": [
- {
- "code": "string",
- "text": "string",
- "parameters": [
- {
- "id": "string",
- "value": "string"
- "localizedText": "string"
- "countryCode": "string",
- "category": "string"
- "cxsalerts": [
- {
- "code": "string",
- "alertType": "NOTE",
- "parameterList": [
- {
- "value": "string",
- "key": "string"
- "message": "string"
Retrieve ITN
Use this endpoint to retrieve the ITN(internal tracking number) of an EEI(Electronic Export Information) which was already filed with US Customs.
header Parameters
x-locale | string Example: en_US This indicates the combination of language code and country code. |
content-type | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
authorization required | string Example: Bearer XXXXX This indicates the authorization token for the input request |
x-customer-transaction-id | string Example: 0e671149-016f-1000-941f-ef4dbabadd2e 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
version | object (version) |
shipmentReferenceNumber required | string This is the shipment reference number which is needed in order to retrieve the ITN (Internal Tracking Number). |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "version": {
- "major": 1,
- "minor": 1,
- "patch": 1
- "shipmentReferenceNumber": "24091060018"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "output": {
- "internalTrackingNumber": "X20241011791496",
- "status": "A1",
- "statusDescription": "EEI Approved",
- "alert": {
- "alertType": "NOTE",
- "message": "VALUE/QUANTITY 1 OUT OF RANGE - LOW"
File EEI
Use this endpoint to file an Electronic Export Information(EEI) with US Customs.
header Parameters
x-locale | string Example: en_US This indicates the combination of language code and country code. |
authorization required | string Example: Bearer XXXXX This indicates the authorization token for the input request. |
x-customer-transaction-id | string Example: 0e671149-016f-1000-941f-ef4dbabadd2e 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. |
Request Body schema: application/json
- FullSchema_FileEEIInputVO
- SamplePayload_CancelFiling
- SamplePayload_UpdateFiling
- Minimum_Payload
version | object (version) |
processingOption required | Array of strings Items Enum: "ADD" "CANCEL" "UPDATE" processingOption for ADD Cancel Update |
eeiControlDetail | object (FullSchema_FileEEIInputVO_eeiControlDetail) Object of EEIControlDetail |
eeiPartyDetails required | Array of objects (FullSchema_FileEEIInputVO_eeiPartyDetails) Both USPPI and ULTIMATE_CONSIGNEE are mandatory. |
eeiCommodities | Array of objects (FullSchema_FileEEIInputVO_eeiCommodities) commodity US Customs code, a high level explanation of type of export. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "version": {
- "major": 1,
- "minor": 1,
- "patch": 1
- "processingOption": "ADD",
- "eeiControlDetail": {
- "shipDate": "2024-09-04",
- "accountNumber": {
- "value": "602345XXX"
- "portOfExportCode": "2095",
- "shipmentReferenceNumber": "24102960001",
- "hazardousMaterial": false,
- "mode": "AIR",
- "customerReferenceNumber": "410",
- "trackingNumber": "1372",
- "partiesToTransactionAreRelated": false,
- "internationalControlledExportDetail": {
- "foreignTradeZoneCode": "string",
- "entryNumber": "string"
- "eeiPartyDetails": [
- {
- "eeiShipmentPartyType": "USPPI,ULTIMATE_CONSIGNEE",
- "ultimateConsigneeType": "DIRECT_CONSUMER",
- "eeiContactAndAddress": {
- "contact": {
- "personName": {
- "firstName": "Surya",
- "lastName": "Kumar"
- "title": "Mr",
- "companyName": "MARK PVT LIMITED",
- "phoneNumber": "6127812999",
- "eMailAddress": "maneesh.nv@fedex.com"
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TX",
- "postalCode": "26150",
- "countryCode": "US"
- "einTaxId": "456736452"
- "eeiCommodities": [
- {
- "commodity": {
- "commodityId": "12",
- "description": "REGISTERS, ACCOUNT BOOKS, NOTEBOOKS, ORDER BOOKS, RECEIPT BOOKS, LETTER PADS, MEMORANDUM PADS, DIARIES AND SIMILAR ARTICLES [REGISTERS, ACCOUNT BOOKS, NOTE BOOKS, ORDER BOOKS, RECEIPT BOOKS, LETTER PADS, MEMORANDUM PAD S, DIARIES AND SIMILAR ARTICLES, EXERCISE BOOKS, BLOTTING-PADS, BINDERS (LOOSELEAF OR OTHER)]",
- "countryOfManufacture": "US",
- "harmonizedCode": "4820100000",
- "weight": {
- "units": "KG",
- "value": 68
- "quantity": 1,
- "quantityUnits": "NO",
- "customsValue": {
- "currency": "USD",
- "amount": 2700
- "exportLicenseNumber": "26456"
- "scheduleBCode": "482010",
- "exportInformationCode": "GP",
- "eeiCommodityLicenseDetail": {
- "exportControlClassificationNumber": "0A018",
- "licenseCode": "C33",
- "licenseValue": {
- "currency": "USD",
- "amount": 0
- "inbondCode": "36",
- "usDomestic": false,
- "ddtcDetail": {
- "ddtcITARExemptionNumber": "123.11B",
- "ddtcRegistrationNumber": "C6754",
- "ddtcSignificantMilitarySMEIndicator": false,
- "ddtcEligibleParty": false,
- "usmlCategoryCode": "17",
- "ddtcXXIDeterminationNumber": "string",
- "ddtcUnitOfMeasure": {
- "units": "BBL",
- "quantity": 0
- "vehicleDetail": {
- "vinNumber": "string",
- "titleNumber": "string",
- "titleState": "string"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "output": {
- "shipmentReferenceNumber": "24102960001"
RegulatoryComplianceLookup V1
This endpoint is to determine the compliance regulations applied for Shipment for EEI Filings.
cookie Parameters
fdx_login | string Example: fdx_login=fdx_login%3Dssoxdev2.df9e.6b52a541 It is the login cookie.It is required for online clients. |
header Parameters
X-clientid | string Example: MAGS Registered client ids with FedEx API. i.e. MAGS, CAFE , INET, ISHP, etc. |
X-locale | string Example: en_US ISO locale |
content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
Authorization required | string Example: Bearer XXX Specifies the authorization token. |
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
Contains the Materials Input object to be applied.
version | object (version_optional) |
shipDate required | string <YYYY-MM-DD> String date format to indicate the date to be used for importing. Default to next day if not present in the request. This date can’t be greater than 120 days this includes weekends. The date format should be ISO8601Date, YYYY-MM-DD. |
carrierCode required | string The shipment type abbreviation for a FedEx operating company. EX: FXE for FedEx Express. Supported Values: FXE, FXG, FXF or any value supported in the DOM element CarrierCodeType. |
originAddress required | object (RegulatoryAddressVO) AddressVO V3 Model |
destinationAddress required | object (RegulatoryAddressVO) AddressVO V3 Model |
serviceType required | string String value to indicate a FedEx operating company’s type of service. Valid values from the authoritative data source (ADS) are listed in the example. Default value is “IP” if not present in the request. Valid values are also DOM ServiceType values. |
serviceOptionTypes required | Array of strings |
totalWeight required | object (Weight) Specify the Dry Ice weight details. Note:
|
consolidationType required | string String value to identify the type of consolidation containing this shipment. |
consolidationRole required | string A String value to identify the role of this shipment within the consolidation. |
totalCommodityValue required | object (Money_2) |
regulatoryCustomsClearanceDetail required | object (RegulatoryCustomsClearanceDetail) |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "version": {
- "major": 1,
- "minor": 1,
- "patch": 1
- "shipDate": "2022-10-05",
- "carrierCode": "FXE",
- "originAddress": {
- "countryCode": "US",
- "stateOrProvinceCode": "TX",
- "postalCode": "75024"
- "destinationAddress": {
- "countryCode": "US",
- "stateOrProvinceCode": "TX",
- "postalCode": "75024"
- "serviceType": "[\"IP\",\"SG\",\"PO\",\"XS\",\"FR\",\"FL\"]",
- "serviceOptionTypes": [
- "FICE",
- "ITAR"
- "totalWeight": {
- "units": "KG",
- "value": 68
- "consolidationType": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
- "consolidationRole": "CRN_SHIPMENT",
- "totalCommodityValue": {
- "amount": 12.45,
- "currency": "USD"
- "regulatoryCustomsClearanceDetail": {
- "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
- "documentContent": "NON_DOCUMENTS",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "commercialInvoice": {
- "freightCharge": {
- "amount": 12.45,
- "currency": "USD"
- "purpose": "SOLD"
- "commodities": [
- {
- "commodityID": "12",
- "scheduleBCode": "500000",
- "harmonizedCode": "611692",
- "name": "Papers",
- "description": "Theragem Power Supply Unit",
- "exportControlClassificationNumber": "10",
- "commodityLicenseOrPermit": "10",
- "countryOfManufacture": "GB",
- "weight": {
- "units": "KG",
- "value": 68
- "quantity": 15,
- "quantityUnits": "Ea",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "regulatoryComplianceCountryDetails": [
- {
- "countryCode": "US",
- "category": "ProductType",
- "regulatoryComplianceCommodityDetails": [
- {
- "commodityComplianceTypeDetail": {
- "commodityIndexes": 1,
- "regulatoryComplianceTypeDetail": {
- "type": "EEI",
- "description": "Shipments to your selected country require an EEI filing"
- "shipmentRegulatoryComplianceDetails": [
- {
- "type": "EEI",
- "description": "Shipments to your selected country require an EEI filing"
- "code": "INVALID.INPUT.EXCEPTION",
- "alertType": "WARNING",
- "parameterList": [
- {
- "value": "packagingType can not be null",
- "key": "NotNull.specialServicesOptionsInputVO.requestedShipment.packagingType"
- "message": "Validation failed for object. Error count: 1"
Response