Fedex Logo
Developer Portal

Global Trade API

Johdanto

Maailmankauppa-APIn avulla voit hakea luettelon lähetyksesi vaatimista sääntelyasiakirjoista ennen lähettämistä. Sääntelyasiakirjoja tarvitaan, jotta voidaan välttää säädösten noudattamiseen liittyviä ongelmia, jotka johtavat usein tulliselvityksen viiveisiin, sakkoihin ja asiakkaiden tyytymättömyyteen toimitusten suhteen.

API tarjoaa myös seuraavat:

  • Tärkeitä tietoja FedExiltä ja viranomaissääntelystä sekä yksittäisiä lähetyksiä koskevia tiedotuksia, kuten
    • lähetyksiin vaikuttavia tilannetietoja
    • tietoja säästä ja muista häiriöistä
    • sääntelyuutisia ja -päivityksiä.
  • Mahdollisuuden selvittää, vaatiiko lähetys sähköisten vientitietojen (EEI) ilmoittamista Yhdysvaltain tullille.
  • Mahdollisuuden ilmoittaa EEI-tiedot Yhdysvaltain tullille käyttäen FedExiä edustajana.
  • Sisäisen tapahtumanumeron (ITN) hakemisen, jota voidaan sitten käyttää seuraavassa lähetystapahtumassa, joka liittyy vastaavaan EEI-numeroon.

Lisätietoa EEI-tiedoista on seuraavilla sivuilla:

Maailmankauppa-APIn tiedot

Tämän APIn avulla voit hakea luettelon lähetystä koskevista tiedotuksista ja vaadituista sääntelyasiakirjoista. Sen avulla voit myös selvittää, vaatiiko lähetyksesi EEI-tietojen ilmoittamista, ja jos vaatii, se auttaa ilmoittamaan EEI-tiedot Yhdysvaltain tullille ja hakemaan ITN-numeron lähetykselle.

Maailmankauppa-API sisältää seuraavat ominaisuudet:

Hae sääntelytiedot

Tämän ominaisuuden avulla voit hakea luettelon ulkomaanlähetyksiin tarvittavista pakollisista asiakirjoista, mikä auttaa varmistamaan sujuvan tulliselvityksen.

Kaikki asiakirjavihkot, ilmoitukset, hakemukset, muokkaukset, muutokset, lisäykset, tarkistukset, raportit, lähetykset, valtuutukset ja hyväksynnät sekä kaikki raportit tai muutokset, joita tarvitaan sääntömääräisten hyväksyntien ylläpitoon, määritetään ulkomaanlähetysten alkuvaiheessa.

API tukee seuraavia sääntelyasiakirjojen tyyppejä: 

  • FEDEX_GENERATED – Osoittaa, että asiakirja on määritetty ja luotu sisäisessä FedEx-järjestelmässä. Asiakas ei voi määrittää tai muokata tätä asiakirjaa. Esimerkki: FedExin luoma kauppalasku, FedExin luoma pro forma -lasku.
  • FILLABLE – Osoittaa, että lomake tai asiakirja voidaan täyttää verkossa tai ladata FedExin verkkosivustolta täyttämistä varten. Nämä lomakkeet voidaan myös noutaa FedExin lähetyskeskuksista täyttämistä varten. Esimerkki: CN 22 -postitulliselvityslomake.
  • PRINT_ONLY – Osoittaa, että asiakirja tai lomake hyväksytään vain paperimuodossa. Esimerkki: laskut.
  • SAMPLE – Osoittaa, että asiakirja on FedExin luoma näyteasiakirja. Esimerkki: kauppalaskunäyte.

Hae tiedotuksia

Tämän ominaisuuden avulla voit hakea lähetystäsi koskevia tärkeitä sääntelytietoja, FedEx-tiedotuksia tai viranomaistiedotuksia. Tiedotukset voivat liittyä säähän tai palveluhäiriöihin, tai ne voivat olla valtion viranomaisten julkaisemia virallisia varoitusilmoituksia, kuten tiettyihin maihin tai määränpäihin matkustamista koskevia turvallisuustietoja.

FedEx tukee seuraavia tiedotustyyppejä: 

  • APPLICATION (soveltamisala) 
  • DOCUMENT_SPECIFIC (asiakirjakohtainen) 
  • FEDEX 
  • GOVERNMENT (valtionhallinto) 
  • INSPECTION (tarkastus) 
  • LICENSE_OR_PERMIT (lisenssi tai lupa) 
  • MAYBE_DOCUMENT (mahdollinen asiakirja) 
  • MAYBE_STATEMENT (mahdollinen lausunto) 
  • PROHIBIT (kielto) 
  • UNIT_OF_MEASURE (mittayksikkö) 
  • WAIVER (luopuminen)

Sähköiset vientitiedot (EEI)

Sähköiset vientitiedot (EEI) on pakollinen asiakirja, jos kunkin yksittäisen taulukon B numeron mukaisesti luokitellun hyödykkeen arvo on yli 2 500 $ tai jos hyödykkeen vienti vaatii vahvistetun vientiluvan.

EEI tarkoittaa tietoja, jotka on ilmoitettava automaattisen vientijärjestelmän (AES) kautta Yhdysvalloista ulkomaille lähetetyistä tavaroista. Ilmoitus sisältää tietoja tavaroiden lähettäjästä ja vastaanottajasta sekä vietävistä tavaroista. Väestönlaskentavirasto käyttää näitä ilmoituksia Yhdysvaltain kauppatilastojen laskemiseen, ja tulli- ja rajavartiolaitos (CBP) ja teollisuus- ja turvallisuusvirasto (BIS) varmistavat näiden tietojen avulla Yhdysvaltain vientisäännösten noudattamisen.

Viejä on vastuussa EEI-tietojen valmistelusta, ja kuljetusliike ilmoittaa ne Yhdysvaltain tulli- ja rajavartiolaitokselle (CBP) automaattisen kaupallisen ympäristön (ACE) kautta ja sen sisällä AES Direct ‑järjestelmässä. AES luo kullekin EEI-tietueelle yksilöllisen ITN-numeron ja vahvistaa siten, että EEI-tapahtuma on hyväksytty ja AES:n arkistoissa.

Vaatimukset

Asiakkaan on käytettävä Yhdysvaltalaista asiakasnumeroa.

Kuljetusvaatimukset:

  • Yhdysvalloista, Puerto Ricosta tai Yhdysvaltain Neitsytsaarilta ulkomaisiin määränpäihin
  • Yhdysvaltain ja Puerto Ricon välillä
  • Yhdysvalloista tai Puerto Ricosta Yhdysvaltain Neitsytsaarille.

Saman taulukon B tai yhtenäistetyn tariffinumeron mukaisen lähetyksen arvo on yli 2 500 $, ja lähetys lähetetään samalta viejältä samalle vastaanottajalle samana päivänä.
(Huomautus: vaatimus ei välttämättä koske lähetyksiä Yhdysvalloista Kanadaan.)

  • Raakatimantit, jotka on luokiteltu yhtenäistetyssä tariffitaulukossa 7102.10, 7102.21 ja 7102.31.
  • Lähetys vaatii Yhdysvaltojen valtionhallinnon vientiluvan.
  • Lähetykseen sovelletaan Yhdysvaltojen kansainvälistä asekauppaa koskevia määräyksiä (ITAR).
  • Lähetykseen sovelletaan Yhdysvaltojen ulkomaankaupan säädöksissä lueteltuja hyödyke-, loppukäyttäjä- tai määränpäävaatimuksia.

Maailmankauppa-APIn käyttö

Hae sääntelytiedot

Tämän päätepisteen avulla voit hankkia tarvittavat sääntelyasiakirjat sekä etukäteistiedotuksia lähetyksistä.

Seuraavat tähän päätepisteeseen liittyvät tiedot ovat pakollisia: 

  • Lähetyspaikan osoite – Ilmoita lähetyspaikan tiedot, kuten maa, postinumero ja tarvittaessa myös osavaltion tai provinssin koodi.
  • Määränpään osoite – Ilmoita määränpään tiedot, kuten maa, postinumero ja tarvittaessa myös osavaltion tai provinssin koodi.
  • Tulliselvityksen tiedot – Ilmoita lähetyksen tulliselvitysmaksut, tullitariffikoodi ja lisätoimenpiteet.
  • Kuljetusliikkeen koodi – Ilmoita lähetystä varten tarvittava FedEx-kuljetusliike.
  • Kokonaispaino – Ilmoita lähetyksen kokonaispaino käyttäen asianmukaista mittayksikköä.

Onnistunut vastaus pyyntöön tarjoaa annettujen syötteiden mukaisen luettelon kaikista mahdollisista sääntelyasiakirjoista ja tiedotuksista. Jos pyynnössä on virheitä, virheobjektissa näytetään virheviestit ja -koodi.

Säädöstenmukaisuuden vaatimat tiedot

Tämän päätepisteen avulla voit selvittää, sovelletaanko lähetykseen mitään vienti- ja/tai tuontimääräyksiä

Seuraavia vaatimustenmukaisuustyyppejä tuetaan tästä hetkestä alkaen:

Vienti:

  • Lähetyksen EEI-tiedot on ilmoitettava Yhdysvaltain tullille.

Tuonti:

  • Ei mitään

Seuraavat tähän päätepisteeseen liittyvät tiedot ovat pakollisia:

  • shipDate: ilmoita lähetyspäivämäärä.
  • carrierCode: Ilmoita FedEx-kuljetusliikkeen koodi. Esimerkki: FXE.
  • originAddress:
    • countryCode: ilmoita lähetyksen alkuperämaan koodi.
  • destinationAddress:
    • countryCode: ilmoita lähetyksen määränpäämaan koodi.
  • serviceType: Ilmoita palveluja toimittavan FedEx-yhtiöön kuuluvan yrityksen valittu palvelutyyppi. Esimerkki: IP, SG, PO jne.
  • serviceOptionTypes: Ilmoita palvelutyypin ominaisuus. Esimerkki: FICE, ITAR.
  • totalWeight: ilmoita lähetyksen kokonaispaino.
    • units: Ilmoita painon mittayksikkö. Esimerkki: KG, LB jne.
    • value: Ilmoita lähetyksen paino. Esimerkki: 68,50.
  • consolidationType: Ilmoita konsolidoinnin tyyppi. Esimerkki: IPD.
  • consolidationRole: Ilmoita lähetyksen rooli konsolidoinnissa. Esimerkki: CRN_SHIPMENT.
  • totalCommodityValue: ilmoita lähetyksen kokonaisarvo.
  • regulatoryCustomsClearanceDetail: ilmoita säädöstenmukaiset tullitiedot.

Kun vastaat tähän pyyntöön onnistuneesti, saat tietää, vaatiiko lähetyksesi EEI-tietojen ilmoittamista.

EEI-tietojen ilmoittaminen

Käytä tätä päätepistettä EEI-tietojen ilmoittamiseen Yhdysvaltain tullille tai nykyisten EEI-tietojen päivittämiseen tai peruuttamiseen.

Seuraavat tähän päätepisteeseen liittyvät tiedot ovat pakollisia:

  • processingOption: Ilmoita EEI-pyynnön käsittelyvaihtoehto. Esimerkki: ADD, UDPATE, CANCEL.
  • eeiControlDetail:
    • shipDate: ilmoita lähetyspäivämäärä.
    • accountNumber: ilmoita FedEx-asiakasnumero.
  • eeiPartyDetails: ilmoita lähettävän osapuolen tiedot.
    • eeiShipmentPartyType
    • eeiContactAndAddress
      • contact:
        • companyName: ilmoita yrityksen nimi.
      • address:
        • streetlines: ilmoita yrityksen katuosoite. Esimerkki: BUILDING
        • city: ilmoita yrityksen kaupunki. Esimerkki: PARIS
        • countryCode: Ilmoita maakoodi. Esimerkki: US.
  • eeiCommodities
    • commodity: ilmoita hyödykkeen rivinimike lähetyksessä.
      • description: anna hyödykkeen kuvaus.
      • harmonizedCode: ilmoita tullitariffikoodi.
      • quantityUnits: ilmoita mittayksikön koodi B/HTS-numeron mukaisesti.
      • Weight: ilmoita hyödykkeen paino.
        • Units: Ilmoita painon mittayksikkö. Esimerkki: KG.
    • HarmonizedCode: ilmoita tullitariffikoodi.
    • quantityUnits: ilmoita mittayksikön koodi B/HTS-numeron mukaisesti.
    • weight: ilmoita hyödykkeen paino.
      • Units: Ilmoita painon mittayksikkö. Esimerkki: KG.
    • exportInformationCode: Ilmoita vientitietojen koodi. Esimerkki: GP.
    • eeiCommodityLicenseDetail:
      • licenseCode: ilmoita lupakoodi.

Kun olet vastannut tähän pyyntöön onnistuneesti, lähetyksen EEI-tiedot ilmoitetaan Yhdysvaltain tullille ja saat lähetyksen viitenumeron (SRN). Saatua ShipmentReferenceNumber (SRN) ‑numeroa tarvitaan sisäisen tapahtumanumeron (ITN) hakemiseen.

ITN-numeron hakeminen

Käytä tätä päätepistettä sisäisen tapahtumanumeron (ITN) hakemiseen EEI-tiedoille, jotka on jo ilmoitettu Yhdysvaltain tullille.

Seuraavat tähän päätepisteeseen liittyvät tiedot ovat pakollisia:

  • shipmentReferenceNumber: ilmoita lähetyksen viitenumero, jonka sait ilmoittaessasi EEI-tiedot.

Kun vastaat tähän pyyntöön onnistuneesti, saat ITN-numeron ilmoitetuille EEI-tiedoille. Tämä ITN-numero on ilmoitettava vastaavan lähetystapahtuman pyynnössä.

Esimerkiksi Ship APIssa on täytettävä seuraavat elementit, kun ITN tai EEI-erivapausnumero lähetetään FedExille.

Elementti Kuvaus

Sender/Tins/TinType

EEI-lähetykset edellyttävät lähettäjän verotunnistetietojen lähettämistä FedExille. Ilmoita työnantajatunnus (EIN). Kelvolliset arvot:

  • BUSINESS_NATIONAL
  • BUSINESS_STATE
  • BUSINESS_UNION
  • PERSONAL_NATIONAL
  • PERSONAL_STATE

Sender/Tins/Number

Ilmoita verotunniste/numero verotunnisteen tyyppiä vastaavalla tunnistenumerolla.

CustomsClearanceDetail/ExportDetail/ ExportComplianceStatement

Jos lähetys vaatii EEI-tietojen ilmoittamisen, anna ITN-numero, jonka saat AES-järjestelmästä ilmoittamalla lähetyksen, tai anna ulkomaankaupan säädöksien (FTR) erivapausnumero tai ITN-numero, jonka sait ilmoittaessasi EEI-tiedot FedExille tai FedExin kautta. ITN-numeron oikea muoto on AES XVVVVKKPPNNNNNN, jossa VVVVKKPP on päivämäärä ja NNNNNN AES-järjestelmän tuottama numerosarja.

Huomautus: lähetyspyynnössä ilmoittamasi ITN tai FTR-erivapausnumero tulostetaan kansainväliseen osoitelappuun.

Lähetysasiakirjat

Tarkat asiakirjat ovat tärkeä osa niin kotimaisia kuin kansainvälisiä lähetyksiä. Niiden avulla vältetään pakettien joutuminen säilöön tai viivästyminen ja varmistetaan sujuva toimitus. 

Seuraavassa kerrotaan erityyppiset lähetys- ja tulliasiakirjat, jotka ovat saatavana FedExin Global Trade Manager -APIn kautta.

Huomautus:         

  • Lähetys voi edellyttää muita tavarakohtaisia kauppa-asiakirjoja, joita ei ole mainittu tässä. Jos et ole varma tarvittavista asiakirjoista, pyydä FedExin asiakaspalvelusta ohjeita, jotta lähetyksesi tulliselvitys sujuisi ongelmitta.

Alkuperätodistus (COO)

Alkuperätodistus (COO) on kansainvälinen asiakirja, joka vahvistaa tuotteen valmistusmaan tai -alueen. Jotkin maat rajoittavat tuontia tietyistä maista, useat maat rajoittavat tuotavien tavaroiden määrää ja jotkin maat suosivat tavaroita, jotka on valmistettu tietyssä maassa.

[Palvelun ENUM: CERTIFICATE_OF_ORIGIN]

Kauppalasku (CI)

Tämä on myyjän tai viejän toimittama asiakirja, josta käyvät ilmi lähetystapahtuman osapuolet ja kuljetettavat tavarat. Se on tullin ensisijaisesti käyttämä asiakirja. Jos mahdollista, se on laadittava viennin määränpäämaan tai -alueen virallisella kielellä. (FedExin luomissa laskuissa ei ole tällaista vaihtoehtoa.) Kauppalaskussa on oltava yksityiskohtainen erittely kaikista lähetyksen sisältämistä tavaroista, mukaan lukien tavaroiden asianmukainen kuvaus (mikä tavara on kyseessä, mistä se on valmistettu, mihin käyttöön se on tarkoitettu?), määrä, valmistusmaa, hinta tai kulut, käytetty valuutta, harmonisoidun järjestelmän koodi ja toimitusehdot. Jotkin maat vaativat, että alkuperäinen lasku tulostetaan lomakkeelle, jossa on lähettäjän logo. Laskussa on aina oltava viejän allekirjoitus ja päiväys, joilla viejä vahvistaa, että annetut tiedot ovat oikeita ja virheettömiä esityksiä kauppalaskun kattamasta sisällöstä. [Palvelun ENUM: COMMERCIAL_INVOICE] 

Saat lisätietoja FedEx Global Trade Managerista.

Vaarallisten aineiden lähettäjän ilmoitus

Tämä on lähettäjän ilmoitus lähetyksistä, jotka on luokiteltu vaarallisiksi aineiksi Safety Data Guide ‑oppaan (SDG), Kansainvälisen lentokuljetusliiton (IATA) ja Kansainvälisen siviili-ilmailujärjestön (ICAO) mukaan. FX 18 ‑lomake edellyttää, että FedExin tunnistamat toimittajat täyttävät Vaarallisten aineiden lähettäjän ilmoitus ‑lomakkeen Yhdysvalloista peräisin oleville lähetyksille, jotka luokitellaan vaarallisiksi aineiksi.

[Palvelun ENUM: DANGEROUS_GOODS_SHIPPERS_DECLARATION]

Vienti-ilmoitus

Yhdysvaltain väestönlaskentavirasto edellyttää tilastotietojen keräämiseksi sähköisiä vientitietoja (The Electronic Export Information, EEI), jotka tunnettiin aiemmin nimellä lähettäjän vienti-ilmoitus (Shipper's Export Declaration, SED). Teollisuus- ja turvallisuusvirasto (Bureau of Industry and Security, BIS) edellyttää samoja tietoja viennin valvonnan tueksi. SED/EEI vaaditaan, kun mihin tahansa luettelon B numeroon luokiteltujen tuotteiden arvo ylittää 2 500 Yhdysvaltain dollaria (USD) tai kun hyödykkeet edellyttävät vientilupaa. Viejä tai viejän edustaja täyttää tiedot sähköisesti. Tiedot on lähetettävä sähköisesti automaattisen vientijärjestelmän (Automated Export System, AES) kautta kaikkien sellaisten hyödykkeiden osalta, jotka sisältyvät Commerce Control List (CCL)- tai U.S. Munitions List (USML) ‑luetteloon. 

Huomautus: tämä vaaditaan vain Yhdysvalloista tehtäviin vientilähetyksiin.

[Palvelun ENUM: EXPORT_DECLARATION]

Yleinen edustussopimus

Edustussopimuksella tai valtakirjalla (Power of Attorney, POA) maahantuoja antaa tulliselvittäjälle laillisen valtuutuksen vapauttaa lähetyksiä ja/tai hoitaa muita lähetystä koskevia asioita tuontiyrityksensä puolesta Canada Revenue Agencyn (CRA) kanssa. Jos Kanadassa asuva maahantuoja haluaa Federal Expressin toimivan sen huolitsijana Kanadassa jatkuvasti, maahantuojan on täytettävä ja lähetettävä nämä lomakkeet ohjeiden mukaisesti ennen lähetyksen lähettämistä Kanadaan. Lomake on rajoitettu edustussopimus, joka koskee vain Federal Express ‑lähetyksiä. Helppokäyttöisen lomakkeen täyttäminen on vaivatonta. Saat lomakkeen tältä verkkosivustolta. 

[Palvelun ENUM: GENERAL_AGENCY_AGREEMENT]

OP900

Yhdysvaltain liikenneministeriö edellyttää tätä lomaketta vaarallisien materiaalien lähettämiseen. Asiakkaalle toimitetaan erityinen OP-900-lomake, joka täytetään lähetyksen tietojen perusteella.

Esimerkkejä:

  • OP-900LL, jos lähetettävä tavara on lasertulostin.
  • OP-900LG, jos lähetettävä tavara on pistematriisitulostin.

Huomaa: paperilomakkeita ei enää hyväksytä, joten lähetä täytetystä lomakkeesta digitaalinen kopio.

 [Palvelun ENUM: OP_900]

Pro forma -lasku

Pro forma ‑lasku lähetetään ennen myyntitapahtumaa. Kun ostaja on saanut toimittajalta pro forma ‑laskun, ostaja lähettää ostotilauksen tai avaa toimittajalle remburssin. Myyjä järjestää tavaroiden lähetyksen sovitun lähetyspäivän mukaan. 

[Palvelun ENUM: PRO_FORMA_INVOICE]

VICS-konossementti

VICS-konossementtilomakkeen luo VICS (Voluntary Inter-Industry Commerce Standards), ja sitä käytetään pääasiassa vähittäiskaupan alan yleisen kauppatavaran lähetyksiin. 

[Palvelun ENUM: VICS_BILL_OF_LADING]

USMCA-kauppalasku ja -alkuperätodistus

USMCA/T-MEC/CUSMA-kauppalasku/-alkuperätodistus on kauppalasku, jossa on vaaditun alkuperätodistuksen tietoelementtejä. Tämän asiakirjan avulla voidaan sekä hoitaa tuotteiden lähetys että hakea tullietuuksia Yhdysvaltain, Meksikon ja Kanadan sopimuksen mukaisesti. Tullietuuksiin oikeuttavien tavaroiden alkuperämaan ja viejämaan on oltava Yhdysvallat, Meksiko tai Kanada. [Palvelun ENUM: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]

USMCA-alkuperätodistus

USMCA/T-MEC/CUSMA-alkuperätodistus on lomake, jolla haetaan Yhdysvaltain, Meksikon ja Kanadan sopimuksen mukaisia tullietuuksia. Todistus sisältää tietyt tietoelementit (mm. lausunto), ja siinä on oltava sopimuksen ehdot täyttävien tavaroiden viejän, tuottajan tai maahantuojan sertifiointi. Tuontitavaroiden alkuperämaan ja viejämaan on oltava Yhdysvallat, Meksiko tai Kanada. Lomaketta voidaan käyttää yksittäiselle lähetykselle tai kattamaan yleisesti 12 kuukauden ajanjaksolla tehdyt lähetykset. 

[Palvelun ENUM: USMCA_CERTIFICATION_OF_ORIGIN]

Yrityssäännöt

  • Kauppalasku on laadittava vietävien tavaroiden määränpäämaan tai -alueen virallisella kielellä. FedExin luomissa laskuissa ei ole tällaista vaihtoehtoa. Siksi asiakkaan vastuulla on tulostaa omat kauppalaskunsa.
  • FedEx hyväksyy vain OP-900‑lomakkeiden digitaalisia kopioita. Käsin täytettyjä lomakkeita ei hyväksytä.

JSON API -kokoelma

Documentation Powered by ReDoc

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
One of
  • FullSchema
  • MinimumSamplePayload
serviceType
string

Specify the type of service that is used to ship the package.
click here to see Service Types

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.

Note : Default value is current date in case the date is not provided or a past date is provided.
Format [YYYY-MM-DD].
Example: 2021-08-05'

carrierCode
required
string

Specify the four letter code of a FedEx operating company that meets your requirements.

Valid values are:

  • FDXE - FedEx Express
  • FDXG - FedEx Ground

    • 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.

Valid values are:

  • INTERNATIONAL_DISTRIBUTION_FREIGHT
  • INTERNATIONAL_ECONOMY_DISTRIBUTION
  • INTERNATIONAL_GROUND_DISTRIBUTION
  • INTERNATIONAL_PRIORITY_DISTRIBUTION
  • TRANSBORDER_DISTRIBUTION

consolidationRole
string

Specify the role this shipment plays within the consolidation.

Valid values are:

  • CONSOLIDATION_DOCUMENTS_SHIPMENT – Shipment contains clearance documents for the corresponding consolidation.
  • CRN_SHIPMENT – Shipment is a Child Reference Number(individual shipment within consolidation).
  • MASTER_AIRWAYBILL_SHIPMENT – Shipment represents entire consolidation, moving as a unit.

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

422

UnProcessable Entity

500

Failure

post /globaltrade/v1/shipments/regulatorydetails/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/regulatorydetails/retrieve

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/regulatorydetails/retrieve

Request samples

Content type
application/json
Example
FullSchema
Copy
 Expand all Collapse all
{
  • "serviceType": "FEDEX_FREIGHT_ECONOMY",
  • "totalCommodityValue":
    {
    },
  • "originAddress":
    {
    },
  • "destinationAddress":
    {
    },
  • "serviceOptionType":
    [
    ],
  • "customsClearanceDetail":
    {
    },
  • "shipDate": "2019-10-14",
  • "carrierCode": "FDXE",
  • "totalWeight":
    {
    },
  • "includeURLReferences": true,
  • "consolidationType": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
  • "consolidationRole": "CONSOLIDATION_DOCUMENTS_SHIPMENT"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /globaltrade/v1/shipments/itn/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/itn/retrieve

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/itn/retrieve

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "version":
    {
    },
  • "shipmentReferenceNumber": "24091060018"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "output":
    {
    }
}

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
One of
  • 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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /globaltrade/v1/shipments/eei/file

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/eei/file

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/eei/file

Request samples

Content type
application/json
Example
FullSchema_FileEEIInputVO
Copy
 Expand all Collapse all
{
  • "version":
    {
    },
  • "processingOption": "ADD",
  • "eeiControlDetail":
    {
    },
  • "eeiPartyDetails":
    [
    ],
  • "eeiCommodities":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "output":
    {
    }
}

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:

  • Dry Ice is a Package level service for Domestic shipments.
  • Dry Ice must be declared at both Shipment and Package level for International MPS shipments to print the compliance statement on Airway Bill labels.

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /globaltrade/v1/regulatorycompliance/lookup

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/regulatorycompliance/lookup

Production Server

https://apis.fedex.com/globaltrade/v1/regulatorycompliance/lookup

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "version":
    {
    },
  • "shipDate": "2022-10-05",
  • "carrierCode": "FXE",
  • "originAddress":
    {
    },
  • "destinationAddress":
    {
    },
  • "serviceType": "[\"IP\",\"SG\",\"PO\",\"XS\",\"FR\",\"FL\"]",
  • "serviceOptionTypes":
    [
    ],
  • "totalWeight":
    {
    },
  • "consolidationType": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
  • "consolidationRole": "CRN_SHIPMENT",
  • "totalCommodityValue":
    {
    },
  • "regulatoryCustomsClearanceDetail":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}
CLOSE

Response

Copy