Global Trade API
Úvod
Rozhraní API pro globální obchod umožňuje získat seznam regulačních dokumentů požadovaných pro zásilku před jejím odesláním. Regulační dokumenty jsou potřebné, aby se předešlo problémům s dodržováním předpisů, které obvykle vedou ke zpoždění celního odbavení, pokutám a nespokojenosti zákazníků s dodávkami.
Toto rozhraní API také nabízí:
- Důležité informace od společnosti FedEx, regulační informace státní správy a také upozornění specifická pro vaši zásilku, jako jsou:
- Aktuální situace ovlivňující zásilky
- Počasí a jiné rušivé faktory
- Novinky a aktualizace o nařízeních
- Možnost zjistit, zda zásilka vyžaduje podání elektronických informací o exportu (EEI) celnímu úřadu USA.
- Možnost podat EEI celnímu úřadu USA s využitím společnosti FedEx jako vašeho zástupce.
- Možnost získat interní číslo transakce (ITN), které lze použít v následné přepravní transakci pro přiřazení k odpovídajícím elektronickým informacím o exportu.
Další informace o EEI naleznete na níže uvedených stránkách:
Podrobnosti o rozhraní API pro globální obchod
Toto rozhraní API umožňuje načíst seznam požadovaných regulačních dokumentů a doporučení vztahujících se na zásilku. Také vám umožňuje zjistit, zda vaše zásilka vyžaduje podání EEI, a pokud tomu tak je, pomůže vám podat EEI celním úřadům USA a načíst číslo ITN pro vaši zásilku.
S rozhraním Global Trade API souvisejí následující funkce:
Načíst regulační podrobnosti
Tato funkce vám pomůže načíst seznam dokumentů, které je třeba přiložit k mezinárodním zásilkám, a zajistit tak hladké celní odbavení.
Veškerá dokumentace, podání, žádosti, změny, dodatky, doplňky, revize, zprávy, povolení a schválení a veškeré zprávy a změny nezbytné pro splnění regulačních povolení jsou specifikovány v počátečních fázích mezinárodní přepravy.
Podporovány jsou následující typy regulačních dokumentů:
- FEDEX_GENERATED – Určuje, že dokument je konfigurován a generován interním systémem společnosti FedEx. Tento dokument nemůže zákazník konfigurovat ani upravovat. Příklad: Obchodní faktura vygenerovaná společností FedEx, proforma faktura vygenerovaná společností FedEx.
- FILLABLE – Určuje formuláře a dokumenty, které lze vyplnit online nebo stáhnout z webových stránek společnosti FedEx. Tyto formuláře lze také získat a vyplnit v přepravních centrech společnosti FedEx. Příklad: Formulář CN 22 – poštovní celní prohlášení
- PRINT_ONLY – Určuje dokumenty a formuláře, které jsou přijímány pouze v tištěné podobě. Příklad: Faktury
- SAMPLE – Určuje vzorové dokumenty vygenerované společností FedEx. Příklad: Vzorové obchodní faktury
Získat doporučení
Tato funkce vám pomůže získat důležité informace o předpisech nebo doporučení společnosti FedEx či státní správy týkající se vaší zásilky. Doporučení se mohou týkat počasí a narušení služeb nebo oficiálních varování vydaných vládní agenturou, například s cílem poskytnout informace o relativní bezpečnosti cestování do jedné nebo více konkrétních zahraničních zemí nebo destinací.
Různé typy oznámení, které společnost FedEx podporuje:
- APPLICATION
- DOCUMENT_SPECIFIC
- FEDEX
- GOVERNMENT
- INSPECTION
- LICENSE_OR_PERMIT
- MAYBE_DOCUMENT
- MAYBE_STATEMENT
- PROHIBIT
- UNIT_OF_MEASURE
- ZPROŠTĚNÍ (WAIVER)
Elektronické informace o exportu (EEI)
Elektronické informace o exportu (EEI) jsou požadovanou dokumentací, pokud hodnota komodity zařazené pod jednotlivými čísly plánu B přesahuje 2 500 USD nebo pokud je k exportu komodity vyžadována ověřená exportní licence.
EEI jsou data, která musí být podána prostřednictvím automatizovaného exportního systému (AES) pro zboží odeslané z USA do jiné země. Podání zahrnuje informace o odesílateli a příjemci zboží a o exportovaném zboží. Úřad pro sčítání lidu používá tato podání k výpočtu obchodních statistik USA a Celní a pohraniční stráž (CBP) a Úřad pro průmysl a bezpečnost (BIS) používají tyto údaje k zajištění dodržování vývozních předpisů USA.
Vývozce je odpovědný za přípravu EEI a přepravce je podává Celní a pohraniční stráži USA (CBP) prostřednictvím automatizovaného exportního systému (ACE) a v jeho rámci AES Direct. Pro každý záznam EEI vygeneruje AES jedinečné číslo ITN potvrzující, že transakce EEI byla přijata a je zaznamenána v AES.
Požadavky
Zákazník musí použít číslo zákaznického účtu v USA.
Požadavky na tranzit:
- Z USA, Portorika nebo Amerických Panenských ostrovů do míst určení v jiných zemích
- Mezi USA a Portorikem
- Z USA nebo Portorika na Americké Panenské ostrovy
Pod stejným číslem plánu B nebo harmonizovaného celního sazebníku v hodnotě vyšší než 2 500 USD a jsou odeslány od stejného vývozce stejnému příjemci ve stejný den.
Poznámka: Zásilky z USA do Kanady mohou být od této povinnosti osvobozeny.
- Surové diamanty klasifikované podle harmonizovaného celního sazebníku 7102.10, 7102.21 a 7102.31.
- Vyžaduje se vývozní licence nebo povolení vlády USA.
- Podléhá mezinárodním předpisům týkající se mezinárodního obchodu se zbraněmi (ITAR) USA
- Podléhá požadavkům na komoditu, koncového uživatele nebo místo určení uvedeným v nařízení o zahraničním obchodu USA.
Jak rozhraní API pro globální obchod funguje
Načíst regulační podrobnosti
Pomocí tohoto koncového bodu získáte požadované regulační dokumenty i předběžná doporučení týkající se přepravy.
Níže jsou uvedeny požadované informace spojené s tímto koncovým bodem:
- Adresa místa původu – Zadejte údaje o původu, jako je kód země, PSČ a kód provincie.
- Adresa místa určení – Zadejte údaje o místu určení, jako je země, PSČ a kód provincie.
- Podrobnosti o celním odbavení – Zadejte poplatky za celní odbavení, kód harmonizovaného systému a další opatření pro zásilku.
- Kód přepravce – Zadejte přepravce FedEx pro tuto zásilku.
- Celková hmotnost – Zadejte celkovou hmotnost zásilky s příslušnou měrnou jednotkou.
Úspěšná odpověď na požadavek vrátí seznam všech možných regulačních dokumentů a doporučení podle zadaných vstupů. Pokud se v požadavku vyskytnou chyby, budou chybové zprávy a kódy uvedeny v objektu chyby.
Vyhledávání souladu s předpisy
Pomocí tohoto koncového bodu zjistíte, zda se na zásilku vztahují nějaké předpisy o vývozu a/nebo dovozu.
V současné době jsou podporovány následující typy souladu:
Export:
- Pro zásilku je vyžadováno podání EEI celnímu úřadu USA.
Import:
- Žádná položka
Níže jsou uvedeny požadované informace spojené s tímto koncovým bodem:
- shipDate: Zadejte datum odeslání zásilky.
- carrierCode: Zadejte kód přepravce FedEx. Příklad: FXE.
- originAddress:
- countryCode: Zadejte kód země původu zásilky.
- destinationAddress:
- countryCode: Zadejte kód země určení zásilky.
- serviceType: Zadejte typ vybrané služby provozní společnosti FedEx. Příklad: IP, SG, PO atd.
- serviceOptionTypes: Zadejte funkci typu služby. Příklad: FICE, ITAR.
- totalWeight: Zadejte celkovou hmotnost zásilky.
- units: Zadejte měrnou jednotku hmotnosti. Příklad: KG, LB atd.
- value: Zadejte hmotnost zásilky: Příklad: 68.50.
- consolidationType: Zadejte typ konsolidace. Příklad: IPD
- consolidationRole: Zadejte roli zásilky v rámci konsolidace. Příklad: CRN_SHIPMENT
- totalCommodityValue: Zadejte celkovou hodnotu zásilky.
- regulatoryCustomsClearanceDetail: Zadejte celní regulatorní detaily.
Při úspěšné odpovědi na tento požadavek zjistíte, zda vaše zásilka vyžaduje podání EEI, či nikoli.
Podání EEI
Tento koncový bod použijte k podání EEI celnímu úřadu USA nebo aktualizaci nebo zrušení existujícího podání EEI.
Níže jsou uvedeny požadované informace spojené s tímto koncovým bodem:
- processingOption: Zadejte možnosti zpracování požadavku EEI. Příklad: ADD, UDPATE, CANCEL
- eeiControlDetail:
- shipDate: Zadejte datum odeslání zásilky.
- accountNumber: Zadejte číslo zákaznického účtu FedEx.
- eeiPartyDetails: Zadejte detaily o straně odesílatele
- eeiShipmentPartyType
- eeiContactAndAddress
- contact:
- companyName: Zadejte název společnosti.
- address:
- streetlines: Zadejte ulici a číslo popisné společnosti. Příklad: BUILDING
- city: Zadejte město společnosti. Příklad: PARIS
- countryCode: Zadejte kód země. Příklad: US
- contact:
- eeiCommodities
- commodity: Zadejte řádek komodity v rámci zásilky.
- description: Zadejte popis komodity.
- harmonizedCode: Zadejte harmonizovaný kód.
- quantityUnits: Zadejte kód měrné jednotky, jak je předepsáno reportovaným číslem B/HTS.
- Weight: Zadejte hmotnost komodity.
- Units: Zadejte měrnou jednotku hmotnosti. Příklad: KG
- HarmonizedCode: Zadejte harmonizovaný kód
- quantityUnits: Zadejte kód měrné jednotky, jak je předepsáno reportovaným číslem B/HTS.
- weight: Zadejte hmotnost komodity
- Units: Zadejte měrnou jednotku hmotnosti. Příklad: KG
- exportInformationCode: Zadejte kód informací o exportu: Příklad: GP
- eeiCommodityLicenseDetail:
- licenseCode: Zadejte kód licence
- commodity: Zadejte řádek komodity v rámci zásilky.
Úspěšná odpověď na tento požadavek podá EEI zásilky celnímu úřadu USA a vrátí referenční číslo zásilky (SRN). Pole ShipmentReferenceNumber (SRN) obdržené v odpovědi je vyžadováno k získání interního čísla transakce (ITN).
Načtení ITN
Tento koncový bod použijte k načtení interního čísla transakce (ITN) pro elektronické informace o exportu, které již byly podány celnímu úřadu USA.
Níže jsou uvedeny požadované informace spojené s tímto koncovým bodem:
- shipmentReferenceNumber: Zadejte referenční číslo zásilky získané z transakce FileEEI.
Úspěšná odpověď na tento požadavek vrátí číslo ITN pro podané EEI. Toto číslo ITN musí být zadáno do požadavku příslušné přepravní transakce.
Například v rozhraní Ship API je třeba vyplnit následující prvky pro odeslání čísla výjimky ITN nebo EEI společnosti FedEx.
Prvek | Popis |
---|---|
Sender/Tins/TinType |
Jako odesílatel musíte pro zásilky EEI společnosti FedEx odeslat své daňové identifikační údaje. Uveďte identifikační číslo EIN.
|
Sender/Tins/Number |
Uveďte identifikační číslo daňového poplatníka s odpovídajícím identifikačním číslem pro TinType. |
CustomsClearanceDetail/ExportDetail/ExportComplianceStatement |
U zásilek vyžadujících EEI zadejte číslo ITN, které jste získali při podání zásilky z AES, nebo číslo výjimky FTR (nařízení o zahraničním obchodu) nebo číslo ITN získané při podání EEI prostřednictvím společnosti FedEx. Správný formát čísla ITN je AES RRRRMMDDNNNNNN, kde RRRRMMDD je datum a NNNNNN jsou čísla vygenerovaná AES. |
Poznámka: Číslo výjimky ITN nebo FTR, které zadáte v požadavku zásilky, se vytiskne na mezinárodní přepravní štítek.
Dokumenty k zásilce
Správná dokumentace je důležitou součástí vnitrostátní i mezinárodní přepravy, protože pomáhá zabránit zadržení či zpoždění balíků a zajistit jejich hladké doručení.
Následují různé typy přepravních a celních dokumentů, které jsou k dispozici prostřednictvím rozhraní API pro globální obchod společnosti FedEx.
Poznámka:
- Pro vaši zásilku mohou být v závislosti na přesné povaze zboží vyžadovány další obchodní dokumenty, které zde nejsou uvedeny. Pokud si nejste jisti, obraťte se na zákaznickou podporu společnosti FedEx a informujte se, co je třeba přiložit pro zajištění bezproblémového odbavení zásilky.
Osvědčení o původu (COO)
Osvědčení o původu (COO) je mezinárodní dokument, který potvrzuje zemi/oblast, ve které byl produkt vyroben. Některé země omezují dovoz z určitých zemí, řada zemí omezuje množství dováženého zboží a některé země upřednostňují zboží vyrobené v konkrétní zemi.
[Service ENUM : CERTIFICATE_OF_ORIGIN]
Obchodní faktura (CI)
Je dokument poskytovaný prodejcem/vývozcem, který popisuje zúčastněné strany přepravní transakce a přepravované zboží. Jedná se o primární dokument používaný celními orgány. Pokud je to možné, měl by být připraven v úředním jazyce země/oblasti, do které je zboží vyváženo (faktury generované společností FedEx tuto možnost nemají). Obchodní faktura by měla obsahovat podrobný seznam všech položek obsažených v zásilce včetně řádného popisu zboží (Co to je? Z čeho je vyrobeno? K jakému použití je určeno?), množství, zemi/oblast výroby, ceny nebo náklady, použité měny, kódy harmonizovaného systému pro jednotlivé komodity a podmínky doručení. Některé země vyžadují originální faktury na hlavičkovém papíře odesilatele. Faktura musí být vždy podepsána a datována vývozcem, který potvrzuje, že poskytnuté podrobnosti jsou pravdivé a správně popisují obsah krytý obchodní fakturou. [Service ENUM: COMMERCIAL_INVOICE]
Další informace najdete v nástroji Global Trade Manager.
Prohlášení přepravce o nebezpečném zboží
Jedná se o prohlášení odesílatele pro zásilky klasifikované jako nebezpečné zboží podle příručky Safety Data Guide (SDG), Mezinárodní asociace leteckých dopravců (IATA) a Mezinárodní organizace pro civilní letectví (ICAO). Formulář FX 18 vyžaduje, aby uznávaní prodejci společnosti FedEx předložili formulář prohlášení odesílatele pro nebezpečné zboží pro zásilky klasifikované jako nebezpečné zboží, které pocházejí z USA.
[Service ENUM: DANGEROUS_GOODS_SHIPPERS_DECLARATION]
Vývozní prohlášení
Elektronické informace o exportu (EEI), původně vývozní prohlášení přepravce (SED), jsou vyžadovány úřadem pro sčítání lidu USA (Department of Census) za účelem sběru statistických údajů a úřadem pro průmysl a bezpečnost (Bureau of Industry and Security, BIS) pro účely vynucování opatření na kontrolu vývozu. Formulář SED/EEI je vyžadován, pokud celková hodnota zboží klasifikovaného pod kterýmkoli jednotlivým číslem plánu B překročí 2 500 USD nebo pokud je k vývozu dané komodity zapotřebí vývozní licence. Tyto informace může vývozce nebo jeho zástupce zadat elektronicky. Informace týkající se komodit uvedených na seznamu pro kontrolu obchodu (Commerce Control List, CCL) nebo na americkém seznamu střeliva (USML) se povinně zadávají elektronicky prostřednictvím automatizovaného exportního systému (AES).
Poznámka: Tento požadavek platí pouze pro exportní zásilky z USA.
[Service ENUM: EXPORT_DECLARATION]
Všeobecná zastupitelská smlouva
Zastupitelská smlouva nebo plná moc představuje zákonné oprávnění udělené dovozcem celnímu deklarantovi, aby mohl jménem společnosti dovozce vydat zásilky úřadu Canada Revenue Agency (CRA) a/nebo za zásilky u tohoto úřadu zodpovídat. Pokud chce dovozce, který je kanadským občanem, jako celního deklaranta v Kanadě průběžně využívat Federal Express, musí před odesláním zásilky do Kanady podle příslušných pokynů vyplnit a vrátit tyto formuláře. Tento formulář představuje omezenou zastupitelskou smlouvu a vztahuje se pouze na zásilky Federal Express. Formulář je ve formátu, který lze snadno vyplnit a použít v sekci knihovny dokumentů na těchto webových stránkách.
[Service ENUM: GENERAL_AGENCY_AGREEMENT]
OP900
Tento formulář je vyžadován ministerstvem dopravy pro přepravu nebezpečných materiálů. Zákazník obdrží konkrétní formulář OP-900, který je třeba vyplnit na základě zásilky.
Příklady:
- OP-900LL, pokud je zásilka laserovou tiskárnou.
- OP-900LG, pokud je zásilka jehličkovou tiskárnou.
Poznámka: Ručně vyplněné formuláře již nejsou přijímány, proto je nutné vyplnit formulář a zaslat nám jeho digitální kopii.
[Service ENUM: OP_900]
Pro forma faktura
Proforma faktura se vystavuje před uskutečněním prodeje. Jakmile kupující od dodavatele obdrží proforma fakturu, odešle objednávku nebo pro dodavatele otevře akreditiv. Prodávající zajistí odeslání zboží v dohodnutém termínu.
[Service ENUM: PRO_FORMA_INVOICE]
Nákladní list VICS
Formulář nákladního listu VICS vytvořila organizace VICS (Voluntary Inter-Industry Commerce Standards) a používá se především u zásilek smíšeného zboží v maloobchodu.
[Service ENUM: VICS_BILL_OF_LADING]
Obchodní faktura a osvědčení o původu USMCA
Obchodní faktura – osvědčení o původu USMCA/T-MEC/CUSMA je obchodní faktura kombinovaná s požadovanými datovými prvky osvědčení o původu. To zahrnuje prohlášení, které umožňuje jak přepravu způsobilého zboží s využitím jednoho dokumentu na základě dohody mezi USA, Mexikem a Kanadou, tak i uplatnění preferenčních sazebních opatření. Zboží, u kterého lze uplatnit preferenční sazební opatření, musí mít původ v USA, Mexiku nebo Kanadě a musí být vyváženo z těchto zemí. [Service ENUM: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]
Osvědčení o původu USMCA
Osvědčení o původu USMCA/T-MEC/CUSMA je formulář žádosti o uplatnění preferenčních sazebních opatření na základě dohody mezi USA, Mexikem a Kanadou. Toto osvědčení obsahuje sadu datových prvků včetně prohlášení a musí být pro způsobilé zboží potvrzeno vývozcem, výrobcem nebo dovozcem. Dovážené zboží musí mít původ v USA, Mexiku nebo Kanadě a musí být vyváženo z těchto zemí. Tento formulář lze použít pro jednotlivou zásilku nebo pro souhrnné období v délce až dvanácti měsíců.
[Service ENUM: USMCA_CERTIFICATION_OF_ORIGIN]
Obchodní pravidla
- Obchodní faktura by měla být připravena v úředním jazyce země/oblasti, do které je zboží vyváženo. Faktury generované společností FedEx tuto možnost neposkytují, proto je zákazník zodpovědný za dodání vlastní obchodní faktury.
- FedEx přijímá pouze digitální kopie formulářů OP-900 forms. Ručně připravené formuláře nejsou přijímány.
Kolekce 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