Global Trade API
Bevezetés
A Global Trade API lehetővé teszi, hogy a küldemény elszállítása előtt lekérje a küldeményhez szükséges szabályozási dokumentumok listáját. A szabályozási dokumentumokra azért van szükség, hogy elkerülhetők legyenek a szabályozási megfelelési problémák, amelyek jellemzően késedelmes vámkezeléshez, bírságokhoz és a küldeményekre vonatkozó ügyfél-elégedettségi problémákhoz vezetnek.
Az API a következőket is biztosítja:
- Fontos információk a FedExtől, kormányzati szabályozási információk, valamint az Ön küldeményére vonatkozó tanácsok, mint például:
- A küldeményeket érintő aktuális információk
- Időjárásbeli és egyéb fennakadások
- Szabályozási újdonságok és frissítések
- Lehetőség annak meghatározására, hogy a küldeményéhez szükséges-e elektronikus exportálási adatokat (EEI) benyújtani az Egyesült Államok vámhatóságához.
- Az EEI benyújtásának lehetősége az Egyesült Államok vámhatóságához a FedExen, mint az Ön ügynökén keresztül.
- Belső tranzakciószám (ITN) lekérdezése, amely a következő küldeménytranzakcióban felhasználható a megfelelő EEI-hez való hozzárendeléshez.
Az EEI-vel kapcsolatos további információkért látogasson el az alábbi oldalakra:
A Global Trade API részletei
Ez az API lehetővé teszi, hogy lekérje a küldeményre vonatkozó szükséges szabályozási dokumentumok és útmutatók listáját. Lehetővé teszi továbbá annak megállapítását, hogy küldeményéhez szükséges-e EEI-t benyújtani, és ha igen, segít az EEI benyújtásában az Egyesült Államok vámhatóságához, valamint a küldemény ITN-számának lekérdezésében.
A következő funkciók kapcsolódnak a Global Trade API-hoz:
Szabályozási részletek lekérése
Ez a funkció segít a nemzetközi küldeményeket kötelezően kísérő dokumentumok listájának lekérdezésében, így támogatva a zökkenőmentes vámkezelés biztosítását.
Minden ügyirat, bejelentés, kérvény, módosítás, helyesbítés, kiegészítés, átdolgozás, jelentés, kérelem, felhatalmazás és jóváhagyás, valamint minden olyan jelentés vagy helyesbítés, amely szükséges a szabályozási jóváhagyások kezeléséhez, a nemzetközi szállítás korai szakaszában kerül meghatározásra.
A támogatott szabályozási dokumentumtípusok a következők:
- FEDEX_GENERATED – Meghatározza, hogy a dokumentumot egy belső FedEx rendszer konfigurálta és generálta. Ezt a dokumentumot az ügyfél nem konfigurálhatja vagy módosíthatja. Példa: FedEx által generált kereskedelmi számla, FedEx által generált Proforma számla.
- FILLABLE – Meghatározza azokat a nyomtatványokat és dokumentumokat, amelyeket vagy online lehet kitölteni, vagy a FedEx webhelyekről letölteni. Ezek a nyomtatványok a FedEx fuvarozási központjaiban is átvehetők és kitölthetők. Példa: CN 22 postai vámnyilatkozat formanyomtatványa.
- PRINT_ONLY – Meghatározza azokat a dokumentumokat és formanyomtatványokat, amelyeket kizárólag nyomtatott formában fogadnak el. Példa: számlák
- SAMPLE – Megadja a FedEx által generált mintadokumentumokat. Példa: kereskedelmi számla mintája
Figyelmeztetések megszerzése
Ez a funkció segít Önnek a küldeményére vonatkozó fontos szabályozási információk, illetve a FedEx vagy a kormányzat figyelmeztetéseinek lekérdezésében. A figyelmeztetések kapcsolódhatnak időjárási és szolgáltatási zavarokhoz, vagy kormányzati ügynökségek által kiadott hivatalos figyelmeztető nyilatkozatokhoz, hogy egy vagy több konkrét külföldi országba vagy úti célhoz történő utazás vagy látogatás viszonylagos biztonságáról adjanak tájékoztatást.
A FedEx a következő típusú figyelmeztetéseket támogatja:
- ALKALMAZÁS
- DOCUMENT_SPECIFIC
- FEDEX
- KORMÁNYZAT
- ELLENŐRZÉS
- LICENSE_OR_PERMIT
- MAYBE_DOCUMENT
- MAYBE_STATEMENT
- TILALOM
- UNIT_OF_MEASURE
- MEGÁLLAPODÁS
Elektronikus exportálási adatok (EEI-k)
Az elektronikus exportálási adatok (EEI) megadása akkor kötelező dokumentáció, ha az egyes B jegyzék-számok alá sorolt árcikkek értéke meghaladja a 2500 USD-t, vagy ha az árucikk kiviteléhez érvényes kiviteli engedély szükséges.
Az EEI azokat az adatokat jelenti, amelyeket az Automatizált exportálási rendszeren (Automated Export System – AES) keresztül kell benyújtani olyan áruk esetén, amelyeket az Egyesült Államokból fuvaroznak külföldre. A benyújtott adatok között szerepelnek az áruk feladójára és címzettjére, valamint az exportált árukra vonatkozó információk. A Statisztikai Hivatala ezeket a benyújtott adatokat az Egyesült Államok kereskedelmi statisztikáinak kiszámításához használja, a Vámügyi és Határvédelmi Hivatal (CBP) és az Ipari és Biztonsági Iroda (BIS) pedig az adatokat az Egyesült Államok exportszabályainak való megfelelés biztosításához használja fel.
Az exportőr a felelős az EEI létrehozásáért, amelyeket pedig a fuvarozó nyújtja be az Automatikus Kereskedelmi Környezet (ACE) és azon belül az AES Direct rendszerén keresztül az Egyesült Államok Vámügyi és Határvédelmi Hivatalának (CBP). Az AES minden egyes EEI-rekordhoz egyedi ITN-t generál, amely megerősíti, hogy az EEI-tranzakciót elfogadták, és az AES-ben szerepel.
Követelmények
Az ügyfélnek egyesült államokbeli ügyfélszámot kell használnia.
Tranzitkövetelmények:
- Az Egyesült Államokból, Puerto Ricóból vagy az Amerikai Virgin-szigetekről külföldi rendeltetési helyre,
- Az Egyesült Államok és Puerto Rico között, valamint
- Az Egyesült Államokból vagy Puerto Ricóból az Amerikai Virgin-szigetekre.
Ugyanazon B jegyzék vagy harmonizált tarifajegyzék szerinti szám alá tartozó, 2500 USD-t meghaladó értékű és ugyanazon exportőr által ugyanazon a napon ugyanannak a címzettnek küldött termékek.
(Megjegyzés: Az USA-ból Kanadába irányuló küldemények mentesülhetnek ez alól a követelmény alól)
- A harmonizált tarifajegyzék (HTS) 7102.10, 7102.21 és 7102.31 kódja szerinti nyers gyémántok.
- Az Egyesült Államok kormányának kiviteli engedélye vagy licence szükséges.
- Az Egyesült Államok nemzetközi fegyverkereskedelmi szabályzata (ITAR-felmentés) hatálya alá tartozik, vagy
- Az Egyesült Államok külkereskedelemre vonatkozó előírásaiban felsorolt árucikkekre, végfelhasználókra vagy rendeltetési helyekre vonatkozó követelmények hatálya alá tartozik.
Hogyan működik a Global Trade API?
Szabályozási részletek lekérése
Használja ezt a végpontot a szükséges szabályozási dokumentumok, valamint a küldemény előzetes figyelmeztetéseinek beszerzéséhez.
A következő információk szükségesek ehhez a végponthoz kapcsolódóan.
- Küldeményfeladási hely címe – Adja meg a küldeményfeladási hely adatait, mint például az országot, a postai irányítószámot és az állami tartomány kódját, amennyiben van ilyen.
- Rendeltetési hely címe– Adja meg a rendeltetési hely adatait, mint például az országot, a postai irányítószámot és az állami tartomány kódját, amennyiben van ilyen.
- Vámkezelési részletek – Adja meg a küldemény vámkezelési díjait, a vámtarifaszámát és egyéb méreteit.
- Fuvarozói kód – Adja meg a küldeményhez szükséges FedEx fuvarozót.
- Teljes tömeg – Adja meg a küldemény teljes tömegét a megfelelő mértékegységgel.
A kérelemre adott sikeres válasz az összes lehetséges szabályozási dokumentum és figyelmeztetés listája a megadott adatoknak megfelelően. Hibás kérelem esetén a hibaüzenetek és hibakódok a hibaobjektumban lesznek megadva.
Szabályozásnak való megfeleléssel kapcsolatos adatok lekérése (Regulatory Compliance Lookup)
Ezzel a végponttal határozhatja meg, hogy a küldeményre vonatkoznak-e export- és/vagy importmegfelelőségi előírások
Jelenleg a következő megfelelési típusok támogatottak:
Exportálás:
- A küldemény esetén EEI-t kell benyújtani az Egyesült Államok vámhatóságához.
Importálás:
- Nincs
A következő információk szükségesek ehhez a végponthoz kapcsolódóan:
- shipDate: A fuvarozás dátumának megadása.
- carrierCode: A FedEx-fuvarozó kódjának megadása. Példa: FXE.
- originAddress:
- countryCode: A küldeményfeladási hely országkódjának megadása.
- destinationAddress:
- countryCode: A rendeltetési hely országkódjának megadása a küldeményhez.
- serviceType: A FedEx szolgáltató vállalat választott szolgáltatási típusának megadása. Példa: IP, SG, PO stb.
- serviceOptionTypes: A szolgáltatástípus funkciójának megadása. Példa: FICE, ITAR.
- totalWeight: A küldemény teljes tömegének megadása.
- units: A súlymértékegység megadása. Példa: kg, lb stb.
- value: A küldemény tömegének megadása. Példa: 68,50.
- consolidationType: Összevonás típusának megadása. Példa: IPD
- consolidationRole: A küldemény szerepének meghatározása az összevonáson belül. Példa: CRN_SHIPMENT
- totalCommodityValue: A küldemény teljes értékének megadása.
- regulatoryCustomsClearanceDetail: Az előírások szerinti vámkövetelmények megadása.
A kérelemre adott sikeres válaszból megtudhatja, hogy küldeménye esetén szükséges-e az EEI benyújtása.
EEI benyújtása (File EEI)
Ezen a végponton keresztül nyújthat be EEI-t az Egyesült Államok vámhatóságához, illetve módosíthat vagy törölhet egy meglévő EEI-t.
A következő információk szükségesek ehhez a végponthoz kapcsolódóan:
- processingOption: Az EEI-kérelem feldolgozási opciójának megadása. Példa: ADD, UDPATE, CANCEL
- eeiControlDetail:
- shipDate: A fuvarozás dátumának megadása.
- accountNumber: FedEx-ügyfélszám megadása.
- eeiPartyDetails: A feladó adatainak megadása
- eeiShipmentPartyType
- eeiContactAndAddress
- contact:
- companyName: A vállalat nevének megadása.
- address:
- streetlines: A vállalat utcaadatainak megadása. Példa: ÉPÜLET
- city: A vállalat városának megadása. Példa: Párizs
- countryCode: Az országkód megadása. Példa: Egyesült Államok
- contact:
- eeiCommodities
- commodity: A küldeményen belül az árucikktételsor megadása.
- description: Árucikk leírásának megadása.
- HarmonizedCode: A vámtarifaszám megadása.
- quantityUnits: A mértékegység kódjának megadása a B jegyzék/HTS bejelentett számának megfelelően.
- Weight: Az árucikk tömegének megadása.
- Units: A súlymértékegység megadása. Példa: kg
- HarmonizedCode: A vámtarifaszám megadása
- quantityUnits: A mértékegység kódjának megadása a B jegyzék/HTS bejelentett számának megfelelően.
- weight: Az árucikk tömegének megadása
- Units: A súlymértékegység megadása. Példa: kg
- exportInformationCode: Exportinformációs kód megadása. Példa: GP
- eeiCommodityLicenseDetail:
- licenseCode: Az engedélykód megadása
- commodity: A küldeményen belül az árucikktételsor megadása.
A kérelemre adott sikeres válasz benyújtja a küldeménye EEI-jét az Egyesült Államok vámhatóságához, és visszatér a küldemény hivatkozási számával (SRN). A válaszban kapott ShipmentReferenceNumber (SRN) érték szükséges a belső tranzakciószám (ITN) lekéréséhez.
Belső tranzakciószám lekérdezése (Retrieve ITN)
Ezzel a végponttal lekérdezheti a belső tranzakciószámot (ITN) egy olyan EEI-hez, amelyet már benyújtott az Egyesült Államok vámhatóságához.
A következő információk szükségesek ehhez a végponthoz kapcsolódóan:
- shipmentReferenceNumber: A FileEEI-tranzakcióból kapott küldeményhivatkozási szám megadása.
A kérelemre adott sikeres válasz visszatér a benyújtott EEI ITN-számával. Ezt az ITN-számot meg kell adni a megfelelő küldeménytranzakciós kérelemben.
Például a Ship API-ban a következő elemeket kell kitölteni az ITN vagy az EEI-mentesítési szám FedExnek történő benyújtásához.
Elem | Leírás |
---|---|
Feladó/TIN-ek/TIN-típus |
Feladóként az Ön adóazonosító adatait fel kell töltenie a FedEx számára az EEI-küldemények esetében. Adja meg a munkaadó azonosító számát (EIN). Érvényes értékek:
|
Feladó/TIN-ek/Szám |
Adja meg az adófizetői azonosítószámot, a TIN-típus megfelelő azonosítószámával együtt. |
CustomsClearanceDetail/ExportDetail/ExportComplianceStatement |
Az EEI-t igénylő küldemények esetében adja meg az AES-től a küldeményadatok benyújtásakor kapott ITN-számot vagy az FTR (Foreign Trade Regulations) szerinti mentesítési számot, illetve az EEI FedExnél/FedEx által történő benyújtásakor kapott ITN-számot. Az ITN-szám megfelelő formátuma: AES XÉÉÉÉHHNNNNNNNN, amelyben az ÉÉÉÉHHNN a dátum, az NNNNNN pedig az AES által generált számok. |
Megjegyzés: A Fuvarozási kérelemben megadott ITN-szám vagy FTR-mentesítési szám rá van nyomtatva a nemzetközi fuvarozási címkére.
A küldemény dokumentumai
A pontos dokumentáció fontos része a belföldi és a nemzetközi szállításnak egyaránt, hogy elkerülhető legyen a csomagok elzárása vagy késedelme, és biztosítható legyen a csomagok zökkenőmentes kézbesítése.
A FedEx Global Trade Manager API-n keresztül elérhető szállítási és vámdokumentumok különböző típusai a következők.
Megjegyzés:
- Az áru pontos jellegétől függően más, itt fel nem sorolt kereskedelmi okmányokra is szükség lehet az Ön küldeményéhez. Ha bizonytalan, forduljon a FedEx ügyfélszolgálatához útbaigazításért arra vonatkozóan, hogy mit kell megadnia a küldemény zökkenőmentes vámkezelésének biztosítása érdekében.
Származási bizonyítvány (COO)
A származási bizonyítvány egy nemzetközi dokumentum, amely igazolja, hogy a terméket melyik országban/területen gyártották. Egyes országok korlátozzák a bizonyos országokból származó áruk behozatalát, sok ország korlátozza az importált áruk mennyiségét, és egyes országok előnyben részesítik az egy bizonyos országban gyártott árukat.
[Szolgáltatás ENUM-kódja: CERTIFICATE_OF_ORIGIN]
Kereskedelmi számla (CI)
Ez az eladó/exportőr által biztosított olyan dokumentum, amely ismerteti a szállítási tranzakció résztvevőit és a szállított árukat. Elsősorban ezt a dokumentumot használják a vámkezelés során. Lehetőség szerint annak az országnak/területnek a hivatalos nyelvén kell elkészíteni, ahová az árukat exportálják (a FedEx által generált számlák nem rendelkeznek ezzel a lehetőséggel). A kereskedelmi számlának tételes bontásban tartalmaznia kell a küldeménybe tartozó összes tétel részletes információit, többek között az áruk pontos leírását (Mi ez a tétel? Miből készült? Mi a rendeltetése?), mennyiségét, gyártási országát/területét, árát vagy költségét, használt pénznemét, valamint az egyes árucikkeknek a Harmonizált Rendszer (Harmonized System) szerinti számát és a kézbesítési feltételeket. Egyes országok előírják, hogy az eredeti számla a feladó céges levélpapírján készüljön el. A számlát az exportőrnek mindig alá kell írnia és le kell dátumoznia, így tanúsítva, hogy a megadott részletes adatok a valóságnak megfelelően és pontosan írják le azt a tartalmat, amelyre a kereskedelmi számla vonatkozik. [Szolgáltatás ENUM-kódja: COMMERCIAL_INVOICE]
További tájékoztatásért keresse fel a FedEx Global Trade Manager oldalát.
Veszélyes áruk feladójának nyilatkozata
Ez egy feladó nyilatkozata a Nemzetközi Légi Szállítási Szövetség (IATA) és a Nemzetközi Polgári Repülési Szervezet (ICAO) Biztonsági Adatlapja (SDG) alapján veszélyes áruként besorolt küldemények esetében. Az FX 18 formanyomtatvány megköveteli, hogy a FedEx által elismert szállítók az Egyesült Államokból származó, veszélyes áruknak minősített szállítmányok esetében a "Feladói nyilatkozat veszélyes árukról" című formanyomtatványt nyújtsák be.
[Szolgáltatás ENUM-kódja: DANGEROUS_GOODS_SHIPPERS_DECLARATION]
Kiviteli nyilatkozat
A korábban a feladó exportnyilatkozata (Shipper's Export Declaration - SED) néven ismert elektronikus exportálási adatokra (Electronic Export Information - EEI) az Egyesült Államok Népszámlálási Hivatala statisztikai adatgyűjtés céljából tart igényt, az Ipari és Biztonsági Hivatal (Bureau of Industry and Security - BIS) pedig az exportellenőrzések betartatásának segítése érdekében. A SED/EEI akkor szükséges, ha egy B függelékbeli azonosítószám alá sorolt áru összértéke meghaladja a 2500 USD-t, vagy ha az árucikk(ek) exportengedély-köteles(ek). Az információkat elektronikus formában kell megadni az exportőrnek vagy a megbízottjának. A kereskedelmi ellenőrzési jegyzékben (Commerce Control List - CCL) vagy az Egyesült Államok lőszerlistáján (U.S. Munitions List - USML) szereplő árucikk esetén az információk benyújtása az Automatizált exportálási rendszerben (Automated Export System - AES) elektronikus formában kötelező.
Megjegyzés: Ez csak az amerikai exportküldemények esetén kötelező.
[Szolgáltatás ENUM-kódja: EXPORT_DECLARATION]
Általános ügynöki szerződés
Az ügynöki megállapodás vagy meghatalmazás az a törvényes felhatalmazás, amelyet az importőrök biztosítanak egy vámbrókernek, hogy lehetővé tegyék az importőr nevében való eljárást a Kanadai Adóhivatalnál (Canada Revenue Agency - CRA) a szállítmányok kiadásával és/vagy elszámolásával kapcsolatban. Ha egy kanadai lakóhellyel rendelkező importőr azt szeretné, hogy a Federal Express állandó vámbrókereként járjon el Kanadában, akkor ezeket az űrlapokat ki kell töltenie és vissza kell küldenie az utasítások szerint a Kanadába történő fuvarozást megelőzően. Ez a formanyomtatvány korlátozott ügynöki megállapodás, és kizárólag a Federal Express küldeményeire vonatkozik. Ez a formanyomtatvány olyan formátumban van, amely könnyen kitölthető és könnyen használható a webhely dokumentumtárában.
[Szolgáltatás ENUM-kódja: GENERAL_AGENCY_AGREEMENT]
OP900
Ezt a formanyomtatványt a Közlekedési Minisztérium írja elő a veszélyes anyagok szállításához. Az ügyfél megkapja az OP-900-as formanyomtatványt, amelyet a küldemény alapján kell kitölteni.
Példák:
- OP-900LL, ha a küldemény lézernyomtató.
- OP-900LG, ha a küldemény pontmátrixnyomtató.
Megjegyzés: A kézi formanyomtatványokat már nem fogadjuk el, ezért kérjük, töltse ki és küldje el nekünk a formanyomtatvány digitális másolatát.
[Szolgáltatás ENUM-kódja: OP_900]
Pro Forma számla
A pro-forma számlát az értékesítés előtt állítják ki. Miután a vevő megkapta a szállítótól a pro-forma számlát, megrendelést küld vagy hitellevelet nyit a szállítónak. Az eladó a megállapodás szerinti szállítási időpontban gondoskodik az áru elszállításáról.
[Szolgáltatás ENUM-kódja: PRO_FORMA_INVOICE]
VICS-fuvarlevél
A VICS fuvarlevél formanyomtatványát az Önkéntes Iparági Kereskedelmi Szabványok Szervezete (Voluntary Inter-Industry Commerce Standards - VICS) hozta létre, és elsősorban az általános áruforgalmi kiskereskedelmi szállítmányokhoz használják.
[Szolgáltatás ENUM-kódja: VICS_BILL_OF_LADING]
USMCA szerinti kereskedelmi számla és származási bizonyítvány
Az USMCA/T-MEC/CUSMA szerinti kereskedelmi számla származási bizonyítványa egy olyan kereskedelmi számla, amely az előírt származási bizonyítvány adatelemeit is tartalmazza. Többek között azt a nyilatkozatot is, amely lehetőséget nyújt mind a feltételeknek megfelelő áruk szállítására, mind a preferenciális tarifális elbánás kérelmezésére az ilyen áruk vonatkozásában egyetlen dokumentum használatával, az Egyesült Államok, Mexikó és Kanada közötti egyezmény értelmében. A preferenciális tarifális elbánásra jogosult áruknak az Egyesült Államokból, Mexikóból vagy Kanadából származónak és ezekből exportáltnak kell lenniük. [Szolgáltatás ENUM-kódja: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]
USMCA szerinti származási bizonyítvány
Az USMCA/T-MEC/CUSMA szerinti származási bizonyítvány formanyomtatványát az Egyesült Államok, Mexikó és Kanada közötti egyezmény szerinti preferenciális tarifális eljárás igényléséhez használják. A bizonyítvány számos adatelemet tartalmaz, beleértve egy nyilatkozatot is, és az adatokat az áruk exportőrének, gyártójának vagy importőrének kell tanúsítania a feltételeknek megfelelő áruk esetén. Az importált áruknak az Egyesült Államokból, Mexikóból vagy Kanadából származónak és ezekből exportáltnak kell lenniük. Ez a formanyomtatvány használható egyetlen, de akár több szállítmány esetén is egy legfeljebb tizenkét hónap hosszúságú „keretidőszakban”.
[Szolgáltatás ENUM-kódja: USMCA_CERTIFICATION_OF_ORIGIN]
Üzleti szabályok
- A kereskedelmi számlát annak az országnak/területnek a hivatalos nyelvén kell létrehozni, amelyikbe az árukat exportálják. A FedEx által generált számlák nem biztosítják ezt a lehetőséget, ezért az ügyfelek felelősek a saját kereskedelmi számlájuk kinyomtatásáért.
- A FedEx csak az OP-900 formanyomtatványok digitális másolatát fogadja el. A kézi formanyomtatványokat nem fogadjuk el.
JSON API-gyűjtemény
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