Global Trade API
Inleiding
Via de Global Trade API vindt u de lijst met reglementeerde documenten over regelgeving die verplicht zijn voor uw zending voordat deze wordt verzonden. Gereglementeerde documenten zijn verplicht, zodat problemen omtrent de naleving van regelgeving die doorgaans leiden tot vertragingen bij inklaring, boetes en ontevredenheid bij de klant bij levering kunnen worden voorkomen.
De API biedt ook:
- Belangrijke informatie van FedEx, informatie over regelgeving van overheidsinstanties en adviezen die specifiek op uw zending van toepassing zijn, zoals:
- Actuele situaties die van invloed zijn op zendingen
- Weersomstandigheden en andere onderbrekingen
- Informatie en updates over de nieuwste regelgeving
- De mogelijkheid om te bepalen of er voor uw zending Elektronische exportinformatie (EEI) moet worden ingediend bij de Amerikaanse douane.
- De mogelijkheid om EEI in te dienen bij de Amerikaanse douane met FedEx als uw agent.
- Het ophalen van uw Interne transactienummer (ITN), dat vervolgens kan worden gebruikt in de volgende zendingstransactie om te worden gekoppeld aan de bijbehorende EEI.
Bezoek de onderstaande pagina's voor meer informatie over de EEI:
Details over de Global Trade API
Via deze API vindt u de lijst met vereiste gereglementeerde documenten en adviezen die van toepassing zijn op de zending. U kunt er ook mee bepalen of er voor uw zending EEI moet worden ingediend. Als dat zo is, dan kunt u met de API ook de EEI indienen bij de Amerikaanse douane en het ITN-nummer voor uw zending ophalen.
De Global Trade API heeft de volgende functies:
Gegevens over regelgeving opvragen
Via deze functie hebt u toegang tot de lijst met documenten die u bij uw internationale zendingen moet voegen, zodat de afhandeling bij de douane soepel verloopt.
Alle dossiers, gedeponeerde stukken, aanvragen, wijzigingen, amendementen, toevoegingen, revisies, rapporten, ingediende stukken, autorisaties en goedkeuringen, alsmede rapporten of amendementen die vereist zijn voor het behoud van de goedkeuring van regelgevende instanties worden in een vroeg stadium van een internationale verzending vermeld.
De volgende soorten gereglementeerde documenten worden ondersteund:
- FEDEX_GENERATED - Geeft aan dat het document is geconfigureerd en gegenereerd door een intern FedEx-systeem. Dit document kan niet worden geconfigureerd of aangepast door de klant. Voorbeelden: door FedEx gegenereerde handelsfactuur of door FedEx gegenereerde pro-formafactuur.
- FILLABLE- Dit betreft de formulieren en documenten die ofwel online kunnen worden ingevuld of na het downloaden van de FedEx-sites. Deze formulieren kunnen ook bij FedEx Ship Centers worden opgehaald en ingevuld. Voorbeeld: Formulier CN 22 - douane-aangifte per post.
- PRINT_ONLY- Dit betreft documenten en formulieren die alleen afgedrukt worden geaccepteerd. Voorbeeld: Facturen
- SAMPLE- Dit betreft de door FedEx gegenereerde voorbeelddocumenten. Voorbeeld: voorbeeld van handelsfactuur
Adviezen opvragen
Via deze functie kunt u belangrijke informatie over regelgeving of adviezen van FedEx of overheidsinstanties vinden die specifiek op uw zending van toepassing zijn. Adviezen kunnen betrekking hebben op de weersomstandigheden en serviceonderbrekingen of dit zijn officiële waarschuwingen van een overheidsinstantie, die informatie geven of reizen naar of bezoeken van één of meer specifieke landen of bestemmingen relatief veilig is.
De volgende verschillende soorten adviezen worden ondersteund door FedEx:
- APPLICATION
- DOCUMENT_SPECIFIC
- FEDEX
- GOVERNMENT
- INSPECTION
- LICENSE_OR_PERMIT
- MAYBE_DOCUMENT
- MAYBE_STATEMENT
- PROHIBIT
- UNIT_OF_MEASURE
- WAIVER
Elektronische exportinformatie (EEI)
De Elektronische exportinformatie (EEI) is vereiste documentatie wanneer de waarde van het artikel geclassificeerd onder elk individuele Schedule B-nummer hoger is dan $ 2.500 of als er een gevalideerde exportlicentie is vereist om het artikel te exporteren.
EEI zijn de gegevens die moeten worden ingediend via het Automated Export System (AES) voor goederen die van de VS naar het buitenland worden verzonden. De indiening bevat informatie over de verzender en de ontvanger van de goederen, en over de goederen die worden geëxporteerd. Het Census Bureau gebruikt deze indieningen om de Amerikaanse handelsstatistieken te berekenen, en de Customs and Border Protection (CBP) en het Bureau of Industry and Security (BIS) gebruiken de gegevens om ervoor te zorgen dat wordt voldaan aan de Amerikaanse exportvoorschriften.
De exporteur is verantwoordelijk voor de voorbereiding van de EEI, en de vervoerder dient de EEI in bij de Amerikaanse Customs and Border Protection (CBP) via de Automated Commercial Environment (ACE) en daarbinnen, AES Direct. Voor elk EEI-record genereert AES een uniek ITN dat bevestigt dat de EEI-transactie is geaccepteerd en is ingediend in AES.
Vereisten
De klant moet een accountnummer in de VS gebruiken.
Transitvereisten:
- Van de VS, Puerto Rico of de Amerikaanse Maagdeneilanden naar buitenlandse bestemmingen,
- Tussen de VS en Puerto Rico, en
- Van de VS of Puerto Rico naar de Amerikaanse Maagdeneilanden.
Onder hetzelfde Schedule B- of geharmoniseerde tariefnummer met een waarde van meer dan $ 2.500 USD en die zijn verzonden van dezelfde exporteur naar dezelfde ontvanger op dezelfde dag.
(Opmerking: zendingen naar Canada vanuit de VS zijn vrijgesteld van deze vereiste.)
- Die ruwe diamanten zijn, geclassificeerd onder de geharmoniseerde tarieflijst 7102.10, 7102.21 en 7102.31.
- Waarvoor een exportlicentie of -vergunning is vereist uitgegeven door de Amerikaanse overheid.
- Onderhevig aan de Amerikaanse International Traffic In Arms Regulations (ITAR) of
- Onderhevig aan de vereisten voor artikelen, eindgebruikers of bestemmingen zoals uiteengezet in de internationale handelsvoorschriften van de VS.
Zo werkt de Global Trade API
Gegevens over regelgeving opvragen
Gebruik dit eindpunt om voorafgaand aan een zending de vereiste documenten en adviezen op te vragen.
Voor dit eindpunt is de volgende informatie vereist.
- Adres van herkomst – Verstrek gegevens over de plaats van herkomst, zoals de code van het land, de staat/provincie en de postcode, indien van toepassing.
- Adres van bestemming – Verstrek gegevens over de bestemming, zoals de code van het land, de staat/provincie en de postcode, indien van toepassing.
- Doauneafhandelingsgegevens – Vermeld de kosten voor de douaneafhandeling, de geharmoniseerde code en aanvullende maatregelen voor de zending.
- Vervoerderscode – Vermeld de FedEx-vervoerder die nodig is voor de zending.
- Totaalgewicht – Vermeld het totale gewicht van de zending in de gepaste meeteenheid.
Een succesvolle respons op het verzoek retourneert een lijst met alle mogelijke gereglementeerde documenten en adviezen op basis van de ingevoerde informatie. Als het verzoek fouten bevat, worden foutmeldingen en codes weergegeven in het foutobject.
Opzoeken van naleving van wet- en regelgeving
Gebruik dit eindpunt om te bepalen of er export- en/of importnalevingsregels gelden voor de zending
De volgende nalevingstypen worden vanaf nu ondersteund:
Export:
- EEI-indiening bij de Amerikaanse douane is vereist voor een zending.
Import:
- Geen
Voor dit eindpunt is de volgende informatie vereist:
- shipDate: vermeld de verzenddatum.
- carrierCode: vermeld de FedEx-vervoerderscode. Voorbeeld: FXE.
- originAddress:
- countryCode: vermeld de code van het land van herkomst voor de zending.
- destinationAddress:
- countryCode: vermeld de code van het land van bestemming voor de zending.
- serviceType: vermeld het gekozen servicetype van de FedEx-werkmaatschappij. Bijvoorbeeld: IP, SG, PO etc.
- serviceOptionTypes: vermeld de functie van het servicetype. Bijvoorbeeld: FICE, ITAR.
- totalWeight: vermeld het totale gewicht van de zending.
- eenheden: vermeld de meeteenheid voor gewicht. Bijvoorbeeld: KG, LB etc.
- waarde: vermeld het gewicht van de zending, bijvoorbeeld 68,50.
- consolidationType: vermeld het consolidatietype. Bijvoorbeeld: IPD
- consolidationRole: vermeld de rol van de zending binnen de consolidatie. Bijvoorbeeld: CRN_SHIPMENT
- totalCommodityValue: vermeld de totale waarde van de zending.
- regulatoryCustomsClearanceDetail: vermeld de gegevens voor de douaneregelgeving.
De succesvolle respons voor dit verzoek laat u weten of u voor uw zending EEI moet indienen of niet.
EEI indienen
Gebruik dit eindpunt om EEI in te dienen bij de Amerikaanse douane of om bestaande EEI bij te werken of te annuleren.
Voor dit eindpunt is de volgende informatie vereist:
- processingOption: vermeld de verwerkingsoptie voor uw EEI-verzoek. Bijvoorbeeld: TOEVOEGEN, BIJWERKEN, ANNULEREN
- eeiControlDetail:
- shipDate: vermeld de verzenddatum.
- accountNumber: vermeld uw FedEx-accountnummer.
- eeiPartyDetails: vermeld de gegevens van de partij die verantwoordelijk is voor het verzenden
- eeiShipmentPartyType
- eeiContactAndAddress
- contact:
- companyName: vermeld de naam van het bedrijf.
- adres:
- adresregels: vermeld het adres van het bedrijf. Bijvoorbeeld: GEBOUW
- stad: vermeld de stad van het bedrijf. Bijvoorbeeld: PARIJS
- countryCode: vermeld de landcode. Voorbeeld: VS
- contact:
- eeiCommodities
- artikel: vermeld het lijnartikel in de zending.
- beschrijving: geef een beschrijving op van het artikel.
- harmonizedCode: vermeld de geharmoniseerde code.
- quantityUnits: geef de code voor meeteenheid op zoals voorgeschreven door het B/HTS-aflevernummer.
- Gewicht: geef het gewicht van het artikel op.
- Eenheden: geef de meeteenheid van het gewicht op. Bijvoorbeeld: KG
- HarmonizedCode: vermeld de geharmoniseerde code
- quantityUnits: geef de code voor meeteenheid op zoals voorgeschreven door het B/HTS-aflevernummer.
- gewicht: vermeld het gewicht van het artikel
- Eenheden: geef de meeteenheid van het gewicht op. Bijvoorbeeld: KG
- exportInformationCode: vermeld de exportinformatiecode: bijvoorbeeld: GP
- eeiCommodityLicenseDetail:
- licenseCode: vermeld de licentiecode
- artikel: vermeld het lijnartikel in de zending.
De succesvolle respons voor dit verzoek zal de EEI voor uw zending indienen bij de Amerikaanse douane en een zendingsreferentienummer geven. Het zendingsreferentienummer dat de respons u geeft, is vereist om het interne transactienummer (ITN) op te halen.
ITN ophalen
Gebruik dit eindpunt om het interne transactienummer (ITN) voor EEI op te halen die al is ingediend bij de Amerikaanse douane.
Voor dit eindpunt is de volgende informatie vereist:
- shipmentReferenceNumber: vermeld het zendingsreferentienummer dat u hebt ontvangen via de indiening van de EEI-transactie.
De reactie op deze aanvraag stuurt het ITN-nummer voor de ingediende EEI. Dit ITN-nummer moet worden vermeld in het bijbehorende zendingtransactieverzoek.
In Ship API moeten de volgende elementen bijvoorbeeld worden ingevuld, voordat u uw ITN- of EEI-vrijstellingsnummer indient bij FedEx.
Element | Omschrijving |
---|---|
Verzender/tins/type tin |
Voor EEI-zendingen moet u als afzender uw belastingidentificatiegegevens uploaden naar FedEx. Geef het werkgeversnummer (EIN-nummer) op. Geldige waarden:
|
Verzender/tins/nummer |
Geef het belastingidentificatienummer met het bijbehorende ID-nummer voor type tin op. |
Douaneafhandelingsgegevens/exportgegevens/verklaring van naleving van de exportwetgeving |
Bij zendingen waarvoor een EEI is vereist, voert u het ITN-nummer in dat u van AES hebt ontvangen toen u uw zending indiende, of het FTR-vrijstellingsnummer (Foreign Trade Regulations, internationale handelsvoorschriften), of het ITN-nummer dat u hebt ontvangen toen u de EEI indiende bij/via FedEx. De juiste notatie van een ITN-nummer is AES XJJJJMMDDNNNNNN, waarbij JJJJMMDD de datum is en NNNNNN door de AES gegenereerde nummers zijn. |
Opmerking: het ITN- of FTR-vrijstellingsnummer in het verzendverzoek, is afgedrukt op het internationale verzendlabel.
Verzendingsdocumenten
Nauwkeurige documentatie vormt een belangrijk onderdeel van zowel binnenlandse als internationale verzendingen. Dit voorkomt dat pakketten in beslag worden genomen of vertraging oplopen en garandeert een vlotte levering.
Hieronder staan de verschillende soorten verzendings- en douanedocumenten die u kunt opvragen via de FedEx Global Trade Manager API.
Opmerking:
- Mogelijk zijn andere handelsdocumenten vereist voor uw zending die hier niet vermeld staan, afhankelijk van de exacte aard van de goederen. Als u twijfelt, neem dan contact op met de klantenservice van FedEx voor instructies over welke documenten u moet bijvoegen, zodat uw zending vlot kan worden afgehandeld door de douane.
Certificaat van herkomst (COO)
Een COO is een internationaal document dat bevestigt in welk land/gebied een product is geproduceerd. Sommige landen beperken de import uit bepaalde landen, veel landen beperken het aantal geïmporteerde goederen en sommige landen geven de voorkeur aan goederen die in een bepaald land zijn geproduceerd.
[Service ENUM: CERTIFICATE_OF_ORIGIN]
Handelsfactuur (CI)
Dit is een document dat wordt verstrekt door de verkoper/exporteur waarin de partijen worden beschreven die betrokken zijn bij de verzendtransactie en de goederen die worden vervoerd. Het is het belangrijkste document dat de douane gebruikt. Het moet worden opgesteld in de officiële taal van het land waarnaar de goederen worden geëxporteerd (door FedEx gegenereerde facturen hebben deze optie niet), indien mogelijk. De handelsfactuur moet een gedetailleerde beschrijving bevatten van alle items die in de zending zitten, inclusief: een juiste beschrijving van de goederen (wat is het? waar is het van gemaakt? wat is het beoogde gebruik?), de hoeveelheid, het land/regio van productie, de kostprijs, de gebruikte valuta, het geharmoniseerde systeemnummer voor elk artikel en de leveringsvoorwaarden. Sommige landen eisen dat een originele factuur wordt opgesteld op briefpapier van de verzender. De factuur moet altijd worden ondertekend en gedateerd door de exporteur, waarmee verklaard wordt dat de verstrekte gegevens een correcte weergave zijn van de inhoud die genoemd wordt op de handelsfactuur. [Service ENUM: COMMERCIAL_INVOICE]
Ga voor meer informatie naar FedEx Global Trade Manager.
Verklaring van afzender voor gevaarlijke goederen
De verzendersverklaring voor zendingen die geclassificeerd worden als gevaarlijke goederen op basis van de Veiligheidsinformatiegids (SDG), International Air Transport Association (IATA) en International Civil Aviation Organization (ICAO). Bij het formulier FX 18 zijn de door FedEx erkende leveranciers verplicht om het formulier Verzendersverklaring voor gevaarlijke goederen in te vullen voor zendingen met geclassificeerde gevaarlijke goederen die vanuit de VS worden verzonden.
[Service ENUM : DANGEROUS_GOODS_SHIPPERS_DECLARATION]
Exportverklaring
De Elektronische exportinformatie (EEI) voorheen bekend als de Exportverklaring afzender (SED) is vereist door de US Department of Census om statistische gegevens te verzamelen en door het Bureau of Industry and Security (BIS) om te helpen bij het handhaven van exportcontroles. De SED/EEI is vereist wanneer de totale waarde van de goederen geclassificeerd onder een enkel Schedule B-nummer, hoger is dan $ 2.500 (USD) of wanneer voor het artikel(en) een exportvergunning is vereist. Deze informatie kan digitaal worden ingevuld door de importeur of de vertegenwoordiger van de importeur. Deze informatie moet verplicht digitaal ingediend worden via het Automated Export System (AES) voor artikelen die op de Commerce Control List (CCL) of de U.S. Munitions List (USML) staan.
Opmerking: Dit is alleen verplicht voor Amerikaanse exportzendingen.
[Service ENUM: EXPORT_DECLARATION]
Algemene agentuurovereenkomst
Een agentuurovereenkomst of een volmacht (POA) is de wettelijke autoriteit die wordt geboden door de importeurs aan een inklaringsagent om deze in staat te stellen zendingen vrij te geven en/of er de verantwoordelijkheid voor te nemen met de Canada Revenue Agency (CRA) namens het bedrijf van de importeur. Indien een in Canada gevestigde importeur wil dat Federal Express optreedt als zijn inklaringsagent in Canada op een doorlopende basis, moeten deze formulieren worden ingevuld en geretourneerd volgens het instructieblad voordat de zending in Canada is. Dit formulier is een beperkte agentuurovereenkomst en is uitsluitend van toepassing voor Federal Express-zendingen. Dit formulier heeft een indeling die maakt dat het eenvoudig kan worden ingevuld en gebruikt in het bibliotheekgedeelte van deze website.
[Service ENUM: GENERAL_AGENCY_AGREEMENT]
OP900
Dit formulier is verplicht door de DOT voor het verzenden van gevaarlijke goederen. De klant ontvangt het specifieke formulier OP-900 en moet dit invullen op basis van de zending.
Voorbeelden:
- OP-900LL als de zending een laserprinter bevat.
- OP-900LG als de zending een dot-matrixprinter bevat.
Opmerking: Handmatige formulieren worden niet meer geaccepteerd. U dient dus het formulier in te vullen en ons hiervan digitaal een kopie toe te sturen.
[Service ENUM: OP_900]
Pro-formafactuur
De pro-formafactuur wordt uitgegeven voordat de verkoop heeft plaatsgevonden. Wanneer de pro-formafactuur is ontvangen van de leverancier, verstuurt de koper een inkooporder of wordt een kredietbrief aan de leverancier verstrekt. Op de overeengekomen verzenddatum verstuurt de verkoper de goederen.
[Service ENUM: PRO_FORMA_INVOICE]
VICS Vrachtbrief
Het formulier VICS Vrachtbrief wordt gemaakt door de VICS (Voluntary Inter-Industry Commerce Standards) en primair gebruikt voor zendingen van algemene merchandiseartikelen.
[Service ENUM: VICS_BILL_OF_LADING]
USMCA Handelsfactuur en Certificaat van herkomst
De handelsfactuur - Certificaat van herkomst USMCA/T-MEC/CUSMA is een handelsfactuur gecombineerd met de vereiste gegevenselementen voor certificering van de oorsprong. Dit is inclusief een verklaring waarmee in aanmerking komende goederen kunnen worden verzonden en waarvoor een voorkeurstariefbehandeling kan worden geclaimd. Hiervoor kan één enkel document worden gebruikt van het United States-Mexico-Canada Agreement. Goederen die in aanmerking komen voor de voorkeurstariefbehandeling moeten uit de VS, Mexico of Canada komen en vandaaruit worden geëxporteerd. [Service ENUM: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]
USMCA Certificaat van herkomst
Het USMCA/T-MEC/CUSMA Certificaat van herkomst is een formulier dat wordt gebruikt om de voorkeurstariefbehandeling te claimen voor het United States-Mexico-Canada Agreement. De certificering bestaat uit een reeks gegevens, inclusief een verklaring, en moet door de exporteur, producent of importeur van de in aanmerking komende producten zijn gecertificeerd. De geïmporteerde goederen moeten uit de VS, Mexico of Canada komen en vandaar worden geëxporteerd. Dit formulier kan worden gebruikt voor een enkele zending of voor een algemene periode van maximaal 12 maanden.
[Service ENUM: USMCA_CERTIFICATION_OF_ORIGIN]
Bedrijfsregels
- De handelsfactuur moet worden opgesteld in de officiële taal van het land/de regio waar de goederen naar worden geëxporteerd. Door FedEx gegenereerde facturen bieden deze optie niet, waardoor klanten verantwoordelijk zijn voor het afdrukken van hun eigen handelsfactuur.
- FedEx accepteert alleen de digitale kopieën van OP-900-formulieren. Handmatig ingevulde formulieren worden niet geaccepteerd.
JSON API-verzameling
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