Service Availability API

Johdanto

Käytettävissä olevat palvelut -APIn avulla voit selvittää syötetyillä lähtö- ja kohdepaikkojen tiedoilla käytettävissä olevat eri FedEx^®-palvelut, erikoispalvelut ja pakkaustyypit FedEx Express^®- ja FedEx Ground^®-palveluille.

Käytettävissä olevat palvelut -API:n tiedot

Käytettävissä olevat palvelut -APIin liittyvät seuraavat ominaisuudet:

Kaikkien syötetyn lähtöpaikan ja määränpään välillä käytettävissä olevien FedEx Express^®- ja FedEx Ground^®-palveluiden ja niiden pakkaustyyppien yhdistelmien haku.
Kaikkien lähtöpaikan ja määränpään välillä FedEx Express- ja FedEx Ground -palveluiden käytettävissä olevien erikoispalveluiden haku, mukaan lukien toimituksen allekirjoitusvaihtoehdot sekä palautuslähetysten tyypit.
Saat kuljetusajat annettuun lähtöpaikkaan ja määränpäähän saatavilla oleviin palveluihin.

Näin Käytettävissä olevat palvelut -API toimii

Tämän palvelun avulla voit hakea käytettävissä olevat FedEx-palvelut, erikoispalvelut (palveluvaihtoehdot) ja pakkaustyypit.

Palveluiden ja pakkausten vaihtoehtojen haku

Tätä pyyntöä käytetään palauttamaan luettelo kaikista käytettävissä olevista palveluista ja pakettityypeistä lähteville, palautettaville ja tuotaville lähetyksille syötettyjen tietojen perusteella.

Pyyntöön liittyvät tärkeimmät tiedot ovat

Lähetyksen tiedot, ml. osoite
Vastaanottajan tiedot, ml. osoite
Asiakasnumero ja lähetyspäivämäärät
Lähetettävät hyödykkeet

Tämä pyyntö antaa luettelon kaikista FedExin palveluista, palveluvaihtoehdoista ja pakkausvaihtoehdoista, jotka ovat saatavilla syötettyjen tietojen perusteella. Pyyntö epäonnistuu, jos osoitetiedot ovat virheelliset, esimerkiksi kaupunki, osavaltio/provinssi ja postinumero ei ole hyväksytty yhdistelmä.

Erityispalveluvaihtoehtojen haku

Tätä pyyntöä käytetään palauttamaan luettelo kaikista käytettävissä olevista erityispalveluista syötettyjen tietojen perusteella. Pyyntöön liittyvät tärkeimmät tiedot ovat

Lähetyksen tiedot, ml. osoite
Vastaanottajan tiedot, ml. osoite
Asiakasnumero ja lähetyspäivämäärät
Lähetettävät hyödykkeet

Tämän pyynnön tulos on luettelo kaikista lähtöpaikan ja määränpään välillä käytettävissä olevista FedExin palveluvaihtoehdoista, mukaan lukien toimituksen allekirjoitusvaihtoehdot sekä palautuslähetysten tyypit. Asiakas voi suodattaa tuloksia kuljetusliikkeen koodi(e)n ja/tai palvelutyyppi(e)n mukaan saadakseen tarkempia tietoja palveluiden saatavuudesta. Tämä palvelu on voimassa seuraaville kuljetusliikkeen koodeille: FedEx Express (FDXE), FedEx Ground (FDXG) ja FedEx Ground^® Economy (aiemmalta nimeltä FedEx SmartPost^®) (FXSP).

Palveluiden ja kuljetusaikojen haku

Tätä pyyntöä käytetään palauttamaan luettelo kaikista käytettävissä olevista palveluista ja kuljetusajoista lähteville, palautettaville ja tuotaville lähetyksille syötettyjen tietojen perusteella.

Pyyntöön liittyvät tärkeimmät tiedot ovat

Lähetyksen tiedot, ml. osoite
Vastaanottajan tiedot, ml. osoite
Asiakasnumero ja lähetyspäivämäärät
Lähetettävät hyödykkeet

Tämä pyyntö antaa luettelon kaikista FedExin saatavilla olevista palveluista ja kuljetusajoista. Pyyntö epäonnistuu, jos osoitetiedot ovat virheelliset, esimerkiksi kaupunki, osavaltio/provinssi ja postinumero ei ole hyväksytty yhdistelmä.

FedEx-palvelut

FedEx tarjoaa valikoiman lähetyspalveluita, joista löytyy sopiva vaihtoehto eri toimitusajoille ja budjeteille täyden palvelun vaihtoehdoilla ja kattavalla tukijärjestelmällä tehokasta pakettien toimitusta varten.

FedExin palvelut ovat seuraavat:

FedEx Express^®

FedEx Express -palvelu on nopea, ja siihen sisältyy tiettyyn aikaan sidottu toimitussitoumus sekä rahat takaisin -takuu. Myös valkoiset lähetyspakkaukset ja -laatikot sisältyvät hintaan.

Yhdysvalloissa pitää valita 1, 2 tai 3 arkipäivän toimitus tiettyyn aikaan mennessä asiakirjoille ja enintään 68 kg / 150 paunaa painaville paketeille.

FedEx Ground^®

Tämä on yrityksille ja kotitalouksille suunnattu kustannustehokas maantietoimituspalvelu, joka tarjoaa toimituksen päivän tarkkuudella 1–7 arkipäivässä kaikkiin yhdysvaltalaisiin yritysosoitteisiin Yhdysvaltain mantereella (3–7 arkipäivää Alaskaan ja Havaijille) riippuen etäisyydestä määränpäähän. Kansainvälisesti FedEx Ground tarjoaa maantietoimituksen päivän tarkkuudella 2–7 arkipäivässä kaikkiin yritysosoitteisiin ja kotitalouksiin Kanadassa riippuen etäisyydestä määränpäähän.

FedEx Home Delivery^®

Tämä palvelu mahdollistaa toimitukset kotitalouksiin 7 päivänä viikossa, mukaan lukien toimitukset useimpiin paikkoihin lauantaisin ja moniin sunnuntaisin.

FedEx Home Delivery -palvelun avulla voit lähettää enintään 68 kg:n / 150 paunan painoisia paketteja.

FedEx Ground^® Economy (ennen FedEx SmartPost^®)

Tämä palvelu tarjoaa kustannustehokkaan kevyiden pakettien yhdistämisen ja toimittamisen yrityksiltä asiakkaille yhteistyössä Yhdysvaltain postilaitoksen kanssa.

FedEx Office^®

Palvelu on tarkoitettu yritys- ja asiakirjaratkaisuille, ja se tarjoaa oikeuden FedEx Express- ja FedEx Ground -lähetyspalveluiden käyttöön. Digitaalisesti yhdistettyjen FedEx Office -pisteiden verkoston avulla voit hallita tehokkaasti laajaa valikoimaa yrityspalveluita työvoimasi ja toimipaikkojesi tarpeisiin auttaen samalla hallitsemaan ja alentamaan kustannuksia.

FedEx Logistics

Luotettavat ja tehokkaat päästä päähän -ratkaisut auttavat suoristamaan kansainvälisten lähetysten mutkat kuljetustavasta tai haluamastasi kuljetusliikkeestä riippumatta.

Kattava tullivälitys, tariffien ja tullimaksujen minimointi sekä vientiasiakirjat.
Maailmanlaajuinen meri- ja ilmarahtijakelu, rahtivakuutus ja useita eri kuljetusmuotoja käyttävä jakelu.
Saatavilla on myös suoratoimituslähetykset, jakelukeskuksen ohitus ja toimittajahallintaohjelmat.

Pakettipalvelut Yhdysvalloissa

Lähetykseen liittyvät tarpeesi	FedEx-palvelu
Heti seuraavan arkipäivän aamuna	FedEx First Overnight^®
Seuraavan arkipäivän aamuna	FedEx Priority Overnight^®
Seuraavana arkipäivänä iltapäivällä	FedEx Standard Overnight^®
2 arkipäivän kuluttua aamulla	FedEx 2Day^®A.M.
2 arkipäivää	FedEx 2Day^®
3 arkipäivää	FedEx Express Saver^®
Taloudellinen maantiekuljetus yrityksille	FedEx Ground^®
Taloudellinen maantiekuljetus kotitalouksiin	FedEx Home Delivery^®
Kevyet paketit kotitalouksiin	FedEx Ground^® Economy (ennen FedEx SmartPost^®)
Yhden päivän yön yli -kuljetus maanantaista perjantaihin	FedEx Extra Hours^®

Kansainväliset pakettipalvelut

Lähetykseen liittyvät tarpeesi	FedEx-palvelu
Varhainen toimitus tärkeille kansainvälisille markkina-alueille	FedEx International First^®
1, 2 tai 3 arkipäivässä ympäri maailman	FedEx International Priority^® FedEx International Priority Express (2A) FedEx International Priority (2P)
5 arkipäivän kuluessa ympäri maailman	FedEx International Economy^®
Lähetysten toimitus 5–10 arkipäivässä	FedEx^® International Deferred Freight
Suorajakelulähetykset	FedEx International Priority DirectDistribution^® FedEx International Economy DirectDistribution^SM
Taloudellinen maantiekuljetus Kanadaan	FedEx International Ground^®

Palvelutyyppien luetteloarvot

Luettelo saatavilla olevista FedEx-kuljetuspalveluista. Saat lisätietoja palvelutyypeistä Palvelutyypit-sivulta.

FedEx-palveluvaihtoehdot

FedEx Express^® Domestic (Yhdysvallat, Kanada) -palveluvaihtoehdot

Alkoholi (vain Yhdysvallat) – FedExin lähetysvaatimukset alkoholille koskevat viiniä, viinoja ja olutta. Jokainen tyyppi listataan erikseen, sillä määräykset vaihtelevat juoman tyypin mukaan. Viini on ainoa alkoholityyppi, jota voidaan toimittaa suoraan kuluttajille riippuen valitusta lähetyspalvelusta. Alkoholi voi olla FedEx Express -palvelun mukainen vaarallinen aine (DG) riippuen alkoholin tilavuusprosentista. Tämä ominaisuus on saatavilla ainoastaan niille FedEx-asiakkaille, jotka ovat liittyneet FedExin alkoholijuomalähetysohjelmaan.
Vaaralliset aineet – Vaarallisia aineita sisältävät lähetykset on luovutettava FedEx Expressille tämänhetkisten Kansainvälisen lentokuljetusliiton (IATA) ilmakuljetussäännösten ja FedEx Expressin ehtojen mukaisesti. Tätä vaatimusta sovelletaan riippumatta reitityksestä tai siitä, päätyykö lähetys fyysisesti lentokuljetukseen, maantiekuljetukseen tai näiden yhdistelmään. Saat lisävarmuutta käyttämällä FedEx DG Ready -ratkaisua vaarallisten aineiden ilmoituksen luomiseen. Se lähettää tiedot FedExille lähetyksesi esivahvistusta varten, ennen kuin tarjoat lähetystä FedEx Expressille.
Kuivajää – Voit lähettää kuivajäätä sisältäviä pakkauksia, kunhan kuivajäälähetyksen tiedot sisältyvät lähetystapahtumaan. Kuivajää lasketaan vaaralliseksi aineeksi.
Säilytys toimipisteessä – FedEx Expressin Säilytä FedExin toimipisteessä -palvelua käyttämällä asiakkaat voivat noutaa pakettinsa määrätystä FedExin toimipisteestä. Esimerkiksi hyväksytyt viininlähettäjät voivat käyttää FedEx Expressin Säilytä FedExin toimipisteessä -palvelua sellaisten asiakkaiden kanssa, jotka haluavat noutaa viinilähetyksensä FedEx Office- tai FedEx Express -toimipisteestä.
Nouto sisältä (vain Yhdysvallat) – Voit pyytää noudon rakennuksen sisältä.
Toimitus sisälle (vain Yhdysvallat) – Voit pyytää toimituksen vastaanottajan rakennuksen sisäpuolelle.
Palautuslappu (vain Yhdysvallat) – Palveluvaihtoehto, jossa tulostetaan palautusosoitelappu.
Lauantainouto/-toimitus – FedEx noutaa ja toimittaa paketteja lauantaina riippuen palvelusta, nouto-/toimituspaikasta ja muista vaihtoehdoista.
Allekirjoitusvaihtoehdot – Luettelossa näytetään sopivat allekirjoitusvaihtoehdot riippuen valitusta erityispalvelusta. Allekirjoitusvaihtoehdot ovat saatavilla Yhdysvalloissa sijaitseviin määränpäihin ja Kanadassa sijaitseviin lähtöpaikkoihin. Saatavilla olevat allekirjoitusvaihtoehdot ovat seuraavat:
- Ei mitään – Allekirjoitusta ei vaadita.
- Toimitus ilman allekirjoitusta. Kaupallisiin määränpäihin toimitettaessa kuljetusliikkeellä on oltava FedExissä kirjattuna allekirjoituksen vapautusnumero. Kotitalouksiin toimitettaessa kuljetusliikkeellä ei tarvitse olla FedExissä kirjattuna allekirjoituksen vapautusnumeroa.
- Epäsuora allekirjoitus vaaditaan.
- Suora allekirjoitus vaaditaan.
- Aikuisen allekirjoitus vaaditaan (vain Yhdysvallat).

Lähetys toimitetaan valitun kuljetustyypin normaalikäytäntöjen mukaisesti. Lisätietoja on FedExin palveluoppaassa.

FedEx Ground^® Domestic (Yhdysvallat, Kanada) -palveluvaihtoehdot

Vaarallinen materiaali (vain Yhdysvallat) – Yksityiskohtaiset ohjeet vaarallisen materiaalin kuljetuksiin löydät sivustolta fedex.com.

FedEx Home Delivery^® -erityispalvelut

Lähetykset Yhdysvalloissa, paino enintään 68 kg / 150 paunaa.
Sopimustoimitus (vain Yhdysvallat)
Saatavilla kaikkiin yhdysvaltalaisiin kotiosoitteisiin maanantaista sunnuntaihin klo 9–20.
Tarkan toimituspäivän toimitus (vain Yhdysvallat)
Toimita paketteja kotitalouksiin maanantaista lauantaihin juhlapyhiä lukuun ottamatta. Valittu päivämäärä ei voi olla ennen vakiotoimituspäivämäärää, ja sen on oltava 14 vuorokauden sisällä noutopäivästä.
Iltatoimitus (vain Yhdysvallat)
Kun toimitus on tehtävä henkilökohtaisesti, eikä vastaanottaja ole tavoitettavissa päiväsaikaan. Tällä valinnalla toimitus voidaan määrittää tapahtumaan klo 17–20 valittuna toimituspäivänä.
7-päiväinen toimitus
FedEx Home Delivery^® -palvelu mahdollistaa toimitukset kotitalouksiin 7 päivänä viikossa, mukaan lukien toimitukset useimpiin paikkoihin lauantaisin ja moniin sunnuntaisin.

Epävakio pakkaus
Jos lähetät paketin, jonka FedEx Ground on määritellyt "epävakioksi", kyseiseen lähetykseen lisätään automaattisesti käsittelyn lisämaksu.
Epävakio FedEx Ground -paketti on mikä tahansa paketti, joka:

On pituudeltaan yli 152 cm / 60 tuumaa mutta enintään 274 cm / 108 tuumaa
Ei ole täysin ulomman kuljetuslaatikon sisällä
On metallisen tai puisen ulomman kuljetuslaatikon sisällä
Mikä hyvänsä tynnyri tai sanko (tilavuudeltaan alle 19 litraa / 5 gallonaa), joka ei ole täysin ulomman, vahvistetusta pahvista valmistetun kuljetuslaatikon sisällä

Palautuslappu
Voit luoda palautuslähetyksen osoitelappuja tietokoneellasi tai lähetysjärjestelmässä. Sen jälkeen vain tulostat ja toimitat lapun asiakkaallesi tai lähetät sen sähköpostitse.

Allekirjoitusvaihtoehdot
FedEx tarjoaa joukon toimitusvaihtoehtoja, jotka vastaavat FedExin asiakkaiden tarpeita. Tarvitaanko FedExin asiakkaan arvotavaran turvallisen saapumisen todistamiseksi allekirjoitus, aikuisen allekirjoitus vai ehkä ei lainkaan allekirjoitusta?
Nämä FedExin toimituksen allekirjoitusvaihtoehdot vaihtelevat lähetyksesi käyttämien erityispalveluiden ja kuljetustyypin mukaan.

Saatavilla olevat allekirjoitusvaihtoehdot ovat seuraavat:

Allekirjoitusta ei vaadita: FedEx pyrkii saamaan allekirjoituksen toimitusosoitteessa. Jos ketään ei ole saatavilla allekirjoittamaan lähetystä, FedEx toimittaa lähetyksen turvalliseen paikkaan ilman allekirjoitusta.
Epäsuora allekirjoitus vaaditaan: FedEx pyrkii saamaan allekirjoituksen joltakulta toimitusosoitteessa, naapurilta tai isännöitsijältä. Jos ketään ei ole saatavilla allekirjoitusta varten, FedEx pyrkii uudelleentoimittamaan lähetyksen jonakin toisena päivänä. Tämä vaihtoehto on käytettävissä vain asuinrakennuksiin toimitettaville lähetyksille.
Suora allekirjoitus vaaditaan: FedEx pyrkii saamaan allekirjoituksen joltakulta ainoastaan toimitusosoitteessa. Jos ketään ei ole saatavilla allekirjoitusta varten, FedEx pyrkii uudelleentoimittamaan lähetyksen.
Aikuisen allekirjoitus vaaditaan: FedEx pyytää allekirjoituksen joltakulta sellaiselta toimitusosoitteessa olevalta henkilöltä, joka on määränpäämaan lakien mukaisesti täysi-ikäinen. Kuvallinen henkilöllisyystodistus tai muu paikallisten viranomaisten yleisesti hyväksymä henkilöllisyystodistus on esitettävä. Jos ketään sopivaa henkilöä ei ole paikalla kyseisessä osoitteessa, yritämme toimitusta uudelleen. Yhdysvaltojen toimituksissa vastaanottajan pitää olla 21-vuotias ja esittää valtion myöntämä valokuvallinen henkilöllisyystodistus.

Valvonta ja interventio (MI) sekä terveydenhuollon tunnisteet (HCID)

Valvonta ja interventio (MI) sekä terveydenhuollon tunnisteet (HCID) ovat erikoispalveluiden vaihtoehtoja, joiden avulla voidaan valvoa tärkeitä terveydenhuollon lähetyksiä ennakoivasti ja vähentää riskejä. Ne tarjoavat myös interventiotukea terveydenhuollon lähetysten suojaamiseksi. HCID-erikoispalvelut tunnistavat kiireelliset terveydenhuollon lähetykset ja asettavat ne etusijalle FedExin verkostossa.

Terveydenhuollon vaihtoehdot ovat käytettävissä vain Express Premium Services -palveluille. Sinun on ensin valittava valvonnan ja intervention (M&I) eritkoispalveluvaihtoehto, jotta voit lähettää nämä terveydenhuollon vaihtoehdot. Katso saatavilla olevat palvelut MI- ja HCID-erikoispalveluiden vaihtoehdoista.

Kun tämä palvelutyyppi määritetään erityispalveluiden vaihtoehtojen haussa, API esittää luettelon kaikista saatavilla olevista terveydenhuollon palveluista valitun lähetyspaikan ja määränpään mukaan. API ilmoittaa myös kyseisten palveluiden sequenceNumber- ja sequenceDisplay-arvot, jotka määrittävät terveydenhuollon palveluiden peräkkäisyyden ja näyttöjärjestyksen.

Vaaralliset aineet maantiekuljetuksena

Vaaralliset aineet (DG) maantiekuljetuksena on pakettitason erityispalvelu, jolla lähettäjä voi lähettää vaarallisia aineita sisältäviä paketteja maateitse ADR-säännösten mukaisesti Euroopassa. Kuivajäätä, litiumakkuja ja ‑paristoja, rajoitetun määrän vaarallisia aineita jne. voidaan lähettää maan sisällä mm. FedEx Regional Economy-, FedEx Regional Economy Freight- ja FedEx Express Domestic ‑palvelulla vaarallisten aineiden maantiekuljetuksena tärkeimmillä Euroopan markkinoilla.

Alla luetellut erityispalvelut mahdollistavat monien vaarallisten aineiden maantiekuljetuslähetykset:

Erilliset litiumakkujen ja ‑paristojen lähetykset
Täysin säädellyt vaaralliset aineet maantiekuljetuksena
Rajoitetun määrän lähetykset maantiekuljetuksena
Muuntogeeniset mikro-organismit
Biologiset aineet kategoria B
Poikkeusmäärät
Radioaktiiviset aineet

Huomautus:

STANDALONE_BATTERY-enum on määriteltävä specialServiceTypes-kohdassa, jotta näkyviin tulee vaihtoehto akku- ja paristotietojen valitsemiseksi standaloneBatteryDetails-elementissä. Erityispalvelutyyppi on käytettävissä vain Euroopan sisäisillä alueilla.
Täysin säädeltyjen vaarallisten aineiden (FDG) ja rajoitetun määrän vaarallisten aineiden (LDG) lähetyspyynnöissä sinun on määriteltävä säännökseksi ADR dangerousGoodsDetail-objektissa, jotta lähetysten käsittely onnistuu.

Palveluvaihtoehtojen luetteloarvot

Lähetykselle voidaan myös pyytää eri tyyppisiä erityispalveluita. Lisätietoja lähetysten erityispalveluista saat kohdasta Lähetystason erityispalvelutyypit.

FedEx-paketointi

FedEx tarjoaa erityisesti suunniteltuja pakkausratkaisuja täyttämään asiakkaiden tarpeet, koskivatpa ne sitten dokumentointia, diagnostiikkaa, pakkauksen järeyttä, turvallisuutta tai lämpötilan hallintaa. Pakkaaminen on olennaista lähetyksen nopean toimituksen kannalta. Näin ollen olemme kehittäneet oman valikoimamme käyttövalmiita, itsesulkeutuvia ja kaikenmuotoisia ja -kokoisia pakkauksia.

FedEx One Rate -hinta

FedEx One Rate -hinta on kiinteähintainen lähetys, jota ei tarvitse punnita tai mitata, jos se painaa alle 22,6 kg / 50 paunaa. Voit pakata lähetyksen sille sopivimpaan laatikkoon tai putkiloon ja täyttää sen niin täyteen kuin mahdollista, kunhan lähetyksen paino on korkeintaan 22,6 kilogrammaa. Saat FedEx Express -paketeillesi yksinkertaisen, ennustettavan, kiinteähintaisen lähetysvaihtoehdon. FedEx One Rate -lähetysvalikoima perustuu kuuteen FedEx Express -palveluvaihtoehtoon, ja siihen on yhdistetty FedExin yksinoikeudelliset (valkoiset) pakkaustyypit.

FedEx One Rate -pakkaukset

FedEx-pakkauksen tyypit, jotka ovat saatavilla One Rate -hinnoitteluvaihtoehdolle:

FEDEX_ENVELOPE
FEDEX_SMALL_BOX
FEDEX_MEDIUM_BOX
FEDEX_LARGE_BOX
FEDEX_EXTRA_LARGE_BOX
FEDEX_PAK
FEDEX_TUBE

Oma pakkaus ei ole saatavilla One Rate -hinnoitteluvaihtoehdolle.

Saat lisätietoja pakkauspalveluista Pakkaustyypit-sivulta.

Yrityssäännöt

Et voi valita useita kuljetusliikkeen koodeja. Jos haluat nähdä tulokset useammalle kuljetusliikkeelle, sinun on joko jätettävä tämä elementti pois tai lähetettävä erillisiä käytettävissä olevien palveluiden pyyntöjä.
Yksittäisille lavoille, jotka painavat 68,5 kg/ 151 paunaa tai enemmän. Lavat, jotka painavat yli 998 kg / 2 200 paunaa, vaativat etukäteishyväksynnän.
Kun haluat löytää FedExin palvelut, jotka sallivat vaarallisten aineiden kuljetuksen lähtöpaikka-määränpää-parillesi, käytä Käytettävissä olevat palvelut -palvelua.
Pakettien suurin sallittu määrä MPS-pyynnössä on 300.
Lähettäjän asiakasnumerolle tulee olla määritettynä Ground Residential -toiminnallisuus. Kun toiminnallisuus on käytössä, asiakas voi määritellä palvelutyypiksi Ground lähetykselle, joka painaa alle 68 kg / 150 paunaa ja joka on osoitettu kotitalouteen sen sijaan, että käytettäisiin Ground Home Delivery -palvelua.
Jos määrität SATURDAY_DELIVERY-arvon vaihteleville valinnoille, saat sekä lauantaitoimituksen vaihtoehdot että tavalliset vaihtoehdot kaikille palveluille, joissa on lauantaitoimituksen mahdollisuus. Älä määritä SATURDAY_DELIVERY-arvoa erityispalveluille, koska muutoin saat palautuksena vain soveltuvat lauantaitoimitusten vaihtoehdot.

JSON API -kokoelma

Service Availability API (1.0.0)

Retrieve Services and Transit Times

This endpoint gives the estimated transit times for a particular shipment.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

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. It also helps you to track the transaction with APIF.
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

Full_Schema_TransitTime
TransitTimes_Domestic
TransitTimes_International

requestedShipment	object (TransitTimeRequestedShipment) Provide shipment data details for which a transit time is desired.
carrierCodes	Array of strings Items Enum: "FDXE" "FDXG" "FXSP" Specify the four letter code of a FedEx operating company that meets your requirements Examples of FedEx Operating Companies are: FDXE - FedEx Express FDXG - FedEx Ground FXSP - FedEx SmartPost FXCC - FedEx Custom Critical.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /availability/v1/transittimes

Sandbox Server

https://apis-sandbox.fedex.com/availability/v1/transittimes

Production Server

https://apis.fedex.com/availability/v1/transittimes

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipper":
  {
  - "address":
    {
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    }
  },
- "recipients":
  [
  - {
    "address":
    {
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    }
    }
  ],
- "serviceType": "FEDEX_GROUND",
- "packagingType": "YOUR_PACKAGING",
- "shipDatestamp": "2019-09-01",
- "pickupType": "DROPOFF_AT_FEDEX_LOCATION",
- "shippingChargesPayment":
  {
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "accountNumber":
    {
    "value": "60xxxxxx2"
    }
    }
    },
  - "paymentType": "COLLECT"
  },
- "requestedPackageLineItems":
  [
  - {
    "declaredValue":
    {
    "amount": 12,
    "currency": "USD"
    },
    "weight":
    {
    "units": "LB",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "DANGEROUS_GOODS",
    "COD"
    ],
    "codDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "dryIceWeight":
    {
    "units": "LB",
    "value": 10
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "ACCESSIBLE",
    "options":
    [
    "BATTERY"
    ]
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "retailer"
    },
    "pieceCountVerificationBoxCount": 2,
    "batteryDetails":
    {
    "batteryMaterialType": "LITHIUM_METAL",
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    }
    }
    }
  ],
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "BROKER_SELECT_OPTION"
    ],
  - "codDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "codCollectionType": "PERSONAL_CHECK"
    },
  - "internationalControlledExportDetail":
    {
    "type": "DSP_LICENSE_AGREEMENT"
    },
  - "homeDeliveryPremiumDetail":
    {
    "homedeliveryPremiumType": "EVENING"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationType": "FEDEX_ONSITE",
    "locationContactAndAddress":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "1234",
    "faxNumber": "1234567890",
    "companyName": "Fedex"
    },
    "address":
    {
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    }
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "LB",
    "value": 10
    },
    "packageCount": 12
    }
  },
- "customsClearanceDetail":
  {
  - "commodities":
    [
    {
    "description": "DOCUMENTS",
    "quantity": 1,
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "LB",
    "value": 10
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "numberOfPieces": 1,
    "countryOfManufacture": "US",
    "quantityUnits": "PCS",
    "name": "DOCUMENTS",
    "harmonizedCode": "080211",
    "partNumber": "P1"
    }
    ]
  }
},
"carrierCodes":
[
- "FDXG"
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "alerts":
  [
  - {
    "code": "string",
    "alertType": "NOTE",
    "message": "string"
    }
  ],
- "transitTimes":
  [
  - {
    "transitTimeDetails":
    [
    {
    "serviceType": "GROUND_HOME_DELIVERY",
    "customerMessages":
    [
    {
    "code": "SERVICE.TYPE.INTERNATIONAL.MESSAGE",
    "message": "Rate does not include dities & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees"
    }
    ],
    "distance":
    {
    "units": "KM",
    "value": 1.2315135367772556
    },
    "commit":
    {
    "brokerCommitTimestamp": "2020-03-05T00:00:00-06:00",
    "cutOffTime": "18:30:00",
    "commodityName": "copper",
    "transitDays":
    {
    "description": "2-7 Business Days",
    "minimumTransitTime": "TWO_DAYS",
    "maximumTransitTime": "SEVEN_DAYS"
    },
    "commitMessageDetails": "string",
    "derivedDestinationDetail":
    {
    "serviceArea": "100015",
    "countryCode": "US",
    "locationId": "631278456",
    "airportId": "CA4562",
    "postalCode": "685423",
    "stateOrProvinceCode": "TN",
    "locationNumber": 7856
    },
    "dateDetail":
    {
    "dayOfWeek": "THU",
    "time": "09:30:00",
    "day": "Apr-13-2021"
    }
    },
    "destinationLocation":
    {
    "geoPositionalCoordinates": "{\"latitude\":5.637376656633329,\"longitude\":3.616076749251911}"
    },
    "serviceName": "FedEx Home Delivery"
    }
    ]
    }
  ],
- "encoded": false
}

}

Retrieve Services and Packaging Options

Use this endpoint to return a list of all FedEx Express or FedEx Ground services and packaging type combinations that are available between the input origin and destination and subpackaging information.
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

Full_Schema_Package_And_Service_Options
Package_and_Service_Options_Domestic
Package_and_Service_Options_International

requestedShipment required	object The descriptive data for the requested shipment.
carrierCodes	Array of strings Items Enum: "FDXE" "FDXG" "FXFR" "FXSP" "Specify the four letter code of a FedEx operating company that meets your requirements Examples of FedEx Operating Companies are: FDXE - FedEx Express FDXG - FedEx Ground FXSP - FedEx SmartPost FXCC - FedEx Custom Critical. "
accountNumber	object This is a Payor account number associated with the shipment. Account number is required, for SmartPost shipments (i.e. Carrier code: FXSP)
systemOfMeasureType	string Enum: "IMPERIAL" "METRIC" This is system measurement type, such as Imperial or Metric.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /availability/v1/packageandserviceoptions

Sandbox Server

https://apis-sandbox.fedex.com/availability/v1/packageandserviceoptions

Production Server

https://apis.fedex.com/availability/v1/packageandserviceoptions

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phoneExtension",
    "companyName": "Fedex",
    "faxNumber": "faxNumber"
    },
  - "accountNumber":
    {
    "value": "Your account number"
    }
  },
- "recipients":
  [
  - {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "postalCode": "m1m1m1",
    "countryCode": "CA",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "residential": false
    }
    }
  ],
- "shipDateStamp": "2020-02-28",
- "requestedPackageLineItems":
  [
  - {
    "physicalPackaging": "FEDEX_ENVELOPE",
    "groupPackageCount": 0,
    "itemDescriptionForClearance": "Item Description for Clearence",
    "customerReferences":
    [
    {
    "customerReferenceType": "DEPARTMENT_NUMBER",
    "value": "3686"
    }
    ],
    "contentRecord":
    {
    "itemNumber": "45673289",
    "receivedQuantity": 2,
    "description": "This is the part number.",
    "partNumber": "123"
    },
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "packageSpecialServices":
    {
    "signatureOptionType": "NO_SIGNATURE_REQUIRED",
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "TX64739DL7564"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "ACCESSIBLE",
    "options":
    [
    "HAZARDOUS_MATERIALS",
    "LIMITED_QUANTITIES_COMMODITIES"
    ]
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "specialServiceTypes":
    [
    "BATTERY",
    "DANGEROUS_GOODS"
    ],
    "codDetail":
    {
    "codCollectionType": "CASH",
    "codCollectionAmount":
    {
    "amount": 100.5,
    "currency": "USD"
    }
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ],
- "freightShipmentDetail":
  {
  - "shipmentDimensions":
    {
    "length": 100,
    "width": 30,
    "height": 50,
    "units": "CM"
    },
  - "alternateBilling": true,
  - "lineItem":
    [
    {
    "pieces": 1,
    "volume":
    {
    "units": "CUBIC_FT",
    "value": 9.965781217890562
    },
    "handlingUnits": 1,
    "freightClass": "CLASS_050",
    "description": "Description",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packaging": "SELFPACKAGE",
    "classProvidedByCustomer": true,
    "hazardousMaterials": "HAZARDOUS_MATERIALS",
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    }
    }
    ],
  - "role": "SHIPPER",
  - "clientDiscountPercent": 10.5,
  - "fedExFreightBillingContactAndAddress":
    {
    "contactAncillaryDetail":
    {
    "emailAddresses": null,
    "prefix": "prefix",
    "phoneNumberDetails":
    [
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    },
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    }
    ],
    "companyName":
    {
    "division": "division",
    "companyCd": "companyCd",
    "name": "name",
    "department": "department",
    "storeId": "storeId"
    },
    "title": "title"
    },
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "location in the city",
    "suite": "suite",
    "locationInProperty": "location in the property",
    "addtionalDescriptions": "addtional descriptions",
    "department": "department",
    "roomFloor": "room or floor",
    "crossStreet": "cross street",
    "building": "building",
    "apartment": "apartment",
    "room": "room",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF"
    }
    },
  - "aliasID": "36839",
  - "liabilityCoverageDetail":
    {
    "coverageType": "NEW",
    "coverageAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "fedExFreightAccountNumber":
    {
    "value": "Your account number"
    },
  - "totalHandlingUnits": 0
  },
- "specialServicesRequested":
  {
  - "internationalControlledExportDetail":
    {
    "type": "DEA_036"
    },
  - "returnShipmentDetail":
    {
    "returnType": "PENDING"
    },
  - "homeDeliveryPremiumDetail":
    {
    "homedeliveryPremiumType": "APPOINTMENT"
    },
  - "returnEmailDetail":
    {
    "merchantPhoneNumber": "1234567890",
    "allowedSpecialService":
    [
    "SATURDAY_DELIVERY"
    ]
    },
  - "specialServiceTypes":
    [
    "FEDEX_EXPRESS"
    ],
  - "saturdayDeliveryDetail":
    {
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName":
    {
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "suffix": "suffix"
    },
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "companyName": "company name",
    "faxNumber": "fax number",
    "title": "title"
    }
    }
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "EMAIL",
    "address": "address",
    "permissions":
    {
    "EMAIL": "GRANT"
    }
    },
    {
    "emailNotificationFormatType": "TEXT",
    "address": "address",
    "permissions":
    {
    "EMAIL": "GRANT"
    }
    }
    ],
    "prefix": "prefix",
    "phoneNumberDetails":
    [
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    },
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    }
    ],
    "companyName":
    {
    "division": "division",
    "companyCd": "companyCd",
    "name": "name",
    "department": "department",
    "storeId": "storeId"
    },
    "title": "title"
    },
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "location in the city",
    "suite": "suite",
    "locationInProperty": "location in the property",
    "addtionalDescriptions": "addtional descriptions",
    "department": "department",
    "roomFloor": "room or floor",
    "crossStreet": "cross street",
    "building": "building",
    "apartment": "apartment",
    "room": "room",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "codDetail":
    {
    "codCollectionType": "CASH",
    "codCollectionAmount":
    {
    "amount": 100.5,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "LB",
    "value": 10
    },
    "packageCount": 12
    },
  - "freightDirectDetail":
    {
    "freightDirectDataDetails":
    [
    {
    "type": "STANDARD",
    "transportationType": "DELIVERY",
    "eMailAddress": "raj.osv@fedex.com",
    "phoneNumberDetails":
    [
    {
    "phoneNumberType": "MOBILE",
    "phoneNumber": "XXXXXXXXX12"
    }
    ]
    }
    ]
    }
  },
- "pickupType": "DROPOFF_AT_FEDEX_LOCATION"
},
"carrierCodes":
[
- "FDXE"
],
"accountNumber":
{
- "value": "123456789"
},
"systemOfMeasureType": "METRIC"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "packageOptions":
  [
  - {
    "serviceType":
    {
    "displayText": "FedEx Ground",
    "key": "FEDEX_GROUND"
    },
    "oneRateMaxWeightAllowed":
    {
    "units": "KG",
    "value": 68
    },
    "maxWeightAllowed":
    {
    "units": "KG",
    "value": 68
    },
    "rateTypes":
    [
    "WEIGHT_BASED",
    "FLAT_BASED"
    ],
    "packagingInfoList":
    [
    {
    "dimensionText": "9-1/2” x 12-1/2",
    "description": "Letter"
    }
    ],
    "packageType":
    {
    "displayText": "FedEx Box",
    "key": "FEDEX_BOX"
    },
    "maxMetricWeightAllowed":
    {
    "units": "KG",
    "value": 68
    },
    "oneRateMaxMetricWeightAllowed":
    {
    "units": "KG",
    "value": 68
    }
    }
  ],
- "oneRate": true,
- "advancedRegulatoryPackages":
  [
  - {
    "displayText": "FedEx Ground",
    "key": "FEDEX_GROUND"
    }
  ],
- "serviceOptions":
  [
  - {
    "key": "FEDEX_GROUND",
    "displayText": "FedEx Ground"
    }
  ],
- "alerts":
  [
  - {
    "code": "code",
    "alertType": "NOTE",
    "message": "alert message"
    }
  ]
}

}

Retrieve Special Service Options

Use this endpoint to request list of all available FedEx services, shipment special, service options along with delivery signature options and return shipment types that are available between an origin and destination. You can filter the results using FedEx carrier code(s) and/or service type(s) for specific services.
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

Full_Schema_Special_Service_Options
Special_Service_Options_Domestic_Ground
Special_Service_Options_Domestic_Express
Special_Service_Options_International_Express
Special_Service_Options_International_Express_Freight

requestedShipment required	object (SpecialServicesRequestedShipment) The shipment details for which special service availability is requested.
accountNumber	object Account number associated with a Payor object. Example: Your account number
carrierCodes	Array of strings Items Enum: "FDXE" "FDXG" "FXSP" "FXFR" Optionally supplied to restrict the results to services for a specific carrier. Valid values are: FDXE, FDXG, FXSP. Example: ["FDXG", "FDXE"]

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /availability/v1/specialserviceoptions

Sandbox Server

https://apis-sandbox.fedex.com/availability/v1/specialserviceoptions

Production Server

https://apis.fedex.com/availability/v1/specialserviceoptions

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Ryan Taylor",
    "emailAddress": "sample@fedex.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "Fedex",
    "faxNumber": "123456789"
    },
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "recipient":
  {
  - "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Ryan Taylor",
    "emailAddress": "sample@fedex.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "Fedex",
    "faxNumber": "123456789"
    },
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "serviceType": "STANDARD_OVERNIGHT",
- "packagingType": "FEDEX_BOX",
- "shipDateStamp": "2019-09-01",
- "requestedPackageLineItems":
  [
  - {
    "physicalPackaging": "FEDEX_ENVELOPE",
    "groupPackageCount": 0,
    "itemDescriptionForClearance": "Item Description for Clearence",
    "customerReferences":
    [
    {
    "customerReferenceType": "DEPARTMENT_NUMBER",
    "value": "3686"
    }
    ],
    "contentRecord":
    {
    "itemNumber": "45673289",
    "receivedQuantity": 2,
    "description": "This is the part number.",
    "partNumber": "123"
    },
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "packageSpecialServices":
    {
    "signatureOptionType": "NO_SIGNATURE_REQUIRED",
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "TX64739DL7564"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "ACCESSIBLE",
    "options":
    [
    "HAZARDOUS_MATERIALS",
    "LIMITED_QUANTITIES_COMMODITIES"
    ]
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "specialServiceTypes":
    [
    "BATTERY",
    "DANGEROUS_GOODS"
    ],
    "codDetail":
    {
    "codCollectionType": "CASH",
    "codCollectionAmount":
    {
    "amount": 100.5,
    "currency": "USD"
    }
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ],
- "dropoffType": "DROP_BOX",
- "variableHandlingChargeDetail":
  {
  - "percentValue": 25.67,
  - "fixedValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE",
  - "rateTypeBasis": "ACCOUNT"
  },
- "freightShipmentDetail":
  {
  - "shipmentDimensions":
    {
    "length": 100,
    "width": 30,
    "height": 50,
    "units": "CM"
    },
  - "alternateBilling": true,
  - "lineItem":
    [
    {
    "pieces": 1,
    "volume":
    {
    "units": "CUBIC_FT",
    "value": 9.965781217890562
    },
    "handlingUnits": 1,
    "freightClass": "CLASS_050",
    "description": "Description",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packaging": "SELFPACKAGE",
    "classProvidedByCustomer": true,
    "hazardousMaterials": "HAZARDOUS_MATERIALS",
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    }
    }
    ],
  - "role": "SHIPPER",
  - "clientDiscountPercent": 10.5,
  - "fedExFreightBillingContactAndAddress":
    {
    "contactAncillaryDetail":
    {
    "emailAddresses": null,
    "prefix": "prefix",
    "phoneNumberDetails":
    [
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    },
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    }
    ],
    "companyName":
    {
    "division": "division",
    "companyCd": "companyCd",
    "name": "name",
    "department": "department",
    "storeId": "storeId"
    },
    "title": "title"
    },
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "location in the city",
    "suite": "suite",
    "locationInProperty": "location in the property",
    "addtionalDescriptions": "addtional descriptions",
    "department": "department",
    "roomFloor": "room or floor",
    "crossStreet": "cross street",
    "building": "building",
    "apartment": "apartment",
    "room": "room",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF"
    }
    },
  - "aliasID": "36839",
  - "liabilityCoverageDetail":
    {
    "coverageType": "NEW",
    "coverageAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "fedExFreightAccountNumber":
    {
    "value": "Your account number"
    },
  - "totalHandlingUnits": 0
  },
- "specialServicesRequested":
  {
  - "internationalControlledExportDetail":
    {
    "type": "DEA_036"
    },
  - "returnShipmentDetail":
    {
    "returnType": "PENDING"
    },
  - "homeDeliveryPremiumDetail":
    {
    "homedeliveryPremiumType": "APPOINTMENT"
    },
  - "returnEmailDetail":
    {
    "merchantPhoneNumber": "1234567890",
    "allowedSpecialService":
    [
    "SATURDAY_DELIVERY"
    ]
    },
  - "specialServiceTypes":
    [
    "FEDEX_EXPRESS"
    ],
  - "saturdayDeliveryDetail":
    {
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName":
    {
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "suffix": "suffix"
    },
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "companyName": "company name",
    "faxNumber": "fax number",
    "title": "title"
    }
    }
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "EMAIL",
    "address": "address",
    "permissions":
    {
    "EMAIL": "GRANT"
    }
    },
    {
    "emailNotificationFormatType": "TEXT",
    "address": "address",
    "permissions":
    {
    "EMAIL": "GRANT"
    }
    }
    ],
    "prefix": "prefix",
    "phoneNumberDetails":
    [
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    },
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    }
    ],
    "companyName":
    {
    "division": "division",
    "companyCd": "companyCd",
    "name": "name",
    "department": "department",
    "storeId": "storeId"
    },
    "title": "title"
    },
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "location in the city",
    "suite": "suite",
    "locationInProperty": "location in the property",
    "addtionalDescriptions": "addtional descriptions",
    "department": "department",
    "roomFloor": "room or floor",
    "crossStreet": "cross street",
    "building": "building",
    "apartment": "apartment",
    "room": "room",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "codDetail":
    {
    "codCollectionType": "CASH",
    "codCollectionAmount":
    {
    "amount": 100.5,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "LB",
    "value": 10
    },
    "packageCount": 12
    },
  - "freightDirectDetail":
    {
    "freightDirectDataDetails":
    [
    {
    "type": "STANDARD",
    "transportationType": "DELIVERY",
    "eMailAddress": "raj.osv@fedex.com",
    "phoneNumberDetails":
    [
    {
    "phoneNumberType": "MOBILE",
    "phoneNumber": "XXXXXXXXX12"
    }
    ]
    }
    ]
    }
  },
- "pickupType": "DROPOFF_AT_FEDEX_LOCATION",
- "shippingDocumentSpecification": "shippingDocumentSpecification"
},
"accountNumber":
{
- "value": "123456789"
},
"carrierCodes":
[
- "FDXG",
- "FDXE"
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "alerts":
  [
  - {
    "code": "code",
    "alertType": "NOTE",
    "message": "alert message"
    }
  ],
- "serviceOptionsList":
  [
  - {
    "serviceType": "INTERNATIONAL_FIRST",
    "issEnabled": true,
    "signatureOptionsList":
    [
    {
    "displayText": "Indirect Signature",
    "code:": "INDIRECT"
    }
    ],
    "packageSpecialServicesList":
    [
    {
    "displayText": "DANGEROUS_GOODS",
    "subType": "ACCESSIBLE",
    "specialServiceType": "DANGEROUS_GOODS",
    "customerIntegrationMode": "CUSTOM",
    "value": 10
    },
    {
    "displayText": "BATTERY",
    "specialServiceType": "BATTERY",
    "subType": "ACCESSIBLE",
    "customerIntegrationMode": "CUSTOM",
    "value": 10
    },
    {
    "displayText": "NON_STANDARD_CONTAINER",
    "specialServiceType": "NON_STANDARD_CONTAINER",
    "subType": "ACCESSIBLE",
    "customerIntegrationMode": "STANDARD",
    "value": 10
    },
    {
    "displayText": "DRY_ICE",
    "specialServiceType": "DRY_ICE",
    "subType": "ACCESSIBLE",
    "customerIntegrationMode": "CUSTOM",
    "value": 10
    },
    {
    "displayText": "DANGEROUS_GOODS",
    "subType": "INACCESSIBLE",
    "specialServiceType": "DANGEROUS_GOODS",
    "customerIntegrationMode"": "CUSTOM",
    "value": 10
    }
    ],
    "returnShipmentList":
    [
    "EMAIL_LABEL",
    "PRINT_RETURN_LABEL"
    ],
    "carrierCode": "FDXE",
    "batteryOptionList":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL",
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    },
    {
    "batteryMaterialType": "LITHIUM_METAL",
    "batteryPackingType": "PACKED_WITH_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    },
    {
    "batteryMaterialType": "LITHIUM_ION",
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    },
    {
    "batteryMaterialType": "LITHIUM_ION",
    "batteryPackingType": "PACKED_WITH_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    }
    ],
    "alertList":
    [
    {
    "displayText": "FedEx Ground",
    "key": "FEDEX_GROUND"
    }
    ],
    "shipmentSpecialServicesList":
    [
    {
    "value": "Returns Clearance",
    "specialServiceType": "RETURNS_CLEARANCE",
    "customerIntegrationMode": "CUSTOM",
    "astraDescription": "RC",
    "subType": "ACCESSIBLE",
    "ltlPaymentTerms":
    [
    "PREPAID",
    "COLLECT"
    ]
    },
    {
    "value": "Broker Select Option",
    "specialServiceType": "BROKER_SELECT_OPTION",
    "customerIntegrationMode": "CUSTOM",
    "astraDescription": "BSO",
    "subType": "ACCESSIBLE",
    "ltlPaymentTerms":
    [
    "COLLECT_SECTION_7_SIGNED",
    "COLLECT"
    ]
    },
    {
    "value": "International Mail Service",
    "specialServiceType": "INTERNATIONAL_MAIL_SERVICE",
    "customerIntegrationMode": "CUSTOM",
    "astraDescription": "IMS",
    "subType": "ACCESSIBLE",
    "ltlPaymentTerms":
    [
    "COLLECT_SECTION_9_SIGNED",
    "COLLECT"
    ]
    }
    ],
    "alerts":
    [
    {
    "code": "code",
    "alertType": "NOTE",
    "message": "alert message"
    }
    ]
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Service Availability API

Johdanto

Käytettävissä olevat palvelut -API:n tiedot

Näin Käytettävissä olevat palvelut -API toimii

FedEx-palvelut

FedEx-palveluvaihtoehdot

FedEx-paketointi

Yrityssäännöt

JSON API -kokoelma

Service Availability API (1.0.0)

Retrieve Services and Transit Times

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Services and Packaging Options

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Special Service Options

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in