Developer Portal
Freight LTL API
Úvod
Rozhraní API pro službu LTL Classic umožňuje vytvářet méně než celovozové zásilky (LTL). Zásilka LTL je příliš velká na to, aby byla přepravována jako těžký balík, ale zároveň nevyužije celou ložnou plochu nákladního vozidla.
To vám umožní získat odhady sazeb, vytvořit jedinečné přepravní štítky pro jednotlivé manipulační jednotky a náložní listy (pokud jsou vyžadovány), naplánovat vyzvednutí a sledovat stav zásilky, zkontrolovat dostupnost a naplánovat vyzvednutí. Získáte tak vyšší efektivitu při odesílání větších a těžších zásilek.
V rámci přepravy LTL u FedEx Freight je, ve většině případů, poskytováno u vašich zásilek s více manipulačními jednotkami sledování a přehled na úrovni manipulační jednotky a také vnitrostátní přeprava bez papírového náložného listu (BOL). Náložný list lze vytvořit, pokud je vyžadován. Přestože všechny manipulační jednotky mají jedinečné podací číslo, zásilka se pohybuje na základě jednoho náložného listu, potvrzení o dodání a faktury.
Podrobnosti rozhraní API pro službu LTL Freight
Rozhraní API Freight LTL umožňuje odesílat zásilky LTL vytvářet nezbytné dokumenty, jako jsou nákladní list (pokud je vyžadován), přepravní štítky FedEx Freight a různé další přepravní dokumenty. V přepravě Freight LTL se hlavní štítek umístí na první manipulační jednotku a podřízený štítek se použije na druhou a další manipulační jednotku. Podřízené štítky mají vlastní jedinečné podací číslo, ale odkazují na hlavní podací číslo. Na jednu zásilku lze vytvořit jeden nákladní list, který se skládá ze všech manipulačních jednotek a kusů.
Každé manipulační jednotce lze přiřadit podací číslo a štítek je podobný štítku FedEx Ground nebo Express Parcel s výjimkou F, které značí nákladní zásilku.
Maximální hodnoty pro manipulační jednotky a počty manipulačních jednotek:
- Maximální počet kusů na jednu manipulační jednotku – 9 999
- Maximální počet manipulačních jednotek – 200 (při tisku štítků manipulačních jednotek po jednom).
- Maximální počet manipulačních jednotek – 40 (při tisku štítků manipulačních jednotek najednou)
Zásilky FedEx LTL Freight lze odesílat do všech 50 států a také do Portorika, na Americké Panenské ostrovy, do Kanady a Mexika. Některé zásilky vyžadují kromě přepravních štítků také náložný list. Příkladem takových zásilek jsou ty, které obsahují nebezpečné materiály.
FedEx Freight® mění sektor LTL přepravy, protože umožňuje snadné, rychlé a cenově výhodné odesílání velkých zásilek prostřednictvím jediné efektivní LTL sítě.
Toto rozhraní API nabízí následující funkce:
- Správa vyzvednutí zásilek Freight LTL
Tato funkce umožňuje získat adresy provozoven pro vyzvednutí těžkých zásilek LTL, naplánovat vyzvednutí těžkých zásilek a zrušit již naplánované vyzvednutí.
- Získat cenové nabídky pro zásilky Freight LTL
Tato funkce umožňuje získat cenové nabídky pro těžké zásilky LTL na základě polohy a vybraných možností služby.
- Odeslat zásilku Freight LTL
Tato funkce umožňuje vytvářet těžké zásilky LTL.
Rozhraní API Freight LTL poskytuje následující funkce:
- Možnost odeslat vícekusovou zásilku (MPS) pro všechny typy služeb díky tomu, že lze vygenerovat přepravní štítek(y) nebo náložný list (pokud je vyžadován).
- Možnost vytvořit vícekusovou zásilku a individuálně sledovat každou manipulační jednotku.
- Možnost vytvořit zásilky LTL pro použití služeb FedEx Freight Priority a Freight Economy.
- Příjemce obdrží informace, jako je číslo účtu, kontaktní údaje a adresa.
- Poskytněte časové razítko, typ balení, celkovou hmotnost a různé další požadované údaje uvedené ve schématu koncového bodu.
- Poskytněte štítek FedEx Label se standardním označením a podporou specifikovaných velikostí tepelných štítků.
- Možnost dostávat upozornění na přepravní transakce e-mailem nebo pomocí SMS:
- Oznámení o zásilce
- Odhadovaná doba doručení
- Oznámení o vyzvednutí
- Možnost vytvářet přepravní dokumenty, jako jsou:
- Přepravní štítky pro jednotlivé manipulační jednotky
- Náložný list
- Obchodní faktura
- Faktura pro kanadské celní úřady
- Vytvořte zásilky a tiskněte štítky po jedné manipulační jednotce nebo zpracujte všechny manipulační jednotky najednou.
- Získat cenové nabídky pro jednokusové nebo vícekusové (MPS) zásilky pro všechny typy služeb.
- Ověřte si dostupnost služby vyzvednutí, naplánujte si vyzvednutí těžké zásilky nebo zrušte již naplánované vyzvednutí.
- Vytvořte a naplánujte vyzvednutí zásilky s účty třetích stran pro alternativní fakturační adresu.
Dobírka u přepravy těžkých zásilek: Konec podpory
Přepravce zákazníkům neposkytuje službu dobírky. Přepravce neodpovídá za výběr částky na dobírku, protože se nejedná o službu poskytovanou přepravcem. Na zásilky s dobírkou se vztahují veškeré poplatky za skladování, opětovné odeslání a přepravu.
Přepravní služby Freight LTL
K dispozici jsou následující přepravní služby Freight LTL:
FedEx Freight® Priority
Služba FedEx Freight® Priority je v oboru na špičce a poskytuje včasnou a rychlou přepravu, krátkou dobu přepravy a spolehlivé doručení zásilek. Můžete se spolehnout na regionální službu pro doručení zákazníkům příští den nebo do druhého dne, to vše navíc s bezplatnou zárukou vrácení peněz. *
Charakteristiky služby FedEx Freight® Priority:
- Krátká doba přepravy se službou dodání následující den až do vzdálenosti 965 km a do druhého dne až do vzdálenosti 2 575 km
- Přímé doručení prakticky na jakékoli PSČ v USA, Kanadě a Mexiku.
- Konzistentní a spolehlivé doručení včas
- Bezplatná záruka vrácení peněz*
- Nejmodernější informační technologie a kompletní viditelnost zásilky během přepravy.
- Oddaný tým profesionálů, kteří vám pomohou se všemi požadavky týkajícími se regionální přepravy těžkých zásilek.
* Veškeré služby podléhají podmínkám sazebníku FXFR 100 Series Rules Tariff.
FedEx Freight Economy
Služba FedEx Freight® Economy poskytuje ekonomickou LTL (méně než celovozovou zásilku) přepravu určenou pro základní potřeby přepravy těžkých zásilek. Díky přepravním službám FedEx LTL, spolehlivosti včasného doručení a pečlivé manipulaci nabízíme kvalitní zákaznický servis.
Služba FedEx Freight® Economy poskytuje:
- Řešení pro ekonomickou přepravu těžkých zásilek
- Větší úspory při přepravě zásilek, které tolik nespěchají, avšak vyžadují spolehlivé doručení
- Konzistentní a spolehlivé doručení včas
- Přímé doručení prakticky na jakékoli PSČ v USA, Kanadě, Mexiku a Portoriku.
- Nejmodernější informační technologie a kompletní viditelnost zásilky během přepravy.
- Lepší viditelnost díky kompletnímu sledování zásilky
FedEx International Deferred Freight (FDF)
FedEx International Deferred Freight (FDF) je globální letecká přepravní služba pro přepravu mezinárodních leteckých zásilek s prodlouženou dobou doručení/tranzitu za výhodné ceny. Služba FDF je také k dispozici pro doručovací služby Airport-to-Airport, Door-to-Airport, Airport-to-Door a Door-to-Door.
Poznámka:
- V současné době je tato služba dostupná pouze pro vybrané trasy mezi zeměmi.
- Není povolena přeprava nebezpečného zboží (DG) a omezených komodit. Příklad: suchý led, lithium-iontové baterie. Pro více informací prosím kontaktujte zákaznickou podporu FedEx.
- Vnitrostátní zásilky v USA a vnitrostátní zásilky mimo USA nejsou povoleny.
Jak rozhraní API Freight LTL funguje
V této části jsou popsány koncové body a hlavní prvky vyžadované pro rozhraní API FedEx Freight LTL.
Poznámka: Abyste mohli používat rozhraní API FedEx Freight LTL Classic, je nutné mít povolený účet FedEx Freight LTL. Hlavní vyžadované informace jsou číslo(a) účtu(ů) FedEx Freight a správná poštovní adresa účtu kvůli zpracování zásilek LTL.
Toto rozhraní API poskytuje následující koncové body:
Odeslání Freight LTL
Tento koncový bod použijte k ověření a vytvoření těžkých zásilek FedEx LTL.
Požadované vstupní údaje pro tento požadavek jsou:
- Číslo účtu Freight
- Poštovní adresa účtu
- Zásilka vyžadující nákladní přepravu
- Možnosti odpovědi na štítky – Štítky vrácené jako zakódované nebo jako adresy URL.
- Hlavní sledovací údaje – Pouze v případě, že je třeba zpracovat vícekusovou (MPS) zásilku a štítky je třeba vytisknout každý zvlášť a ne najednou (když prvek singleShotMPS není zadán nebo přidán s hodnotou false).
Úspěšná odpověď na tento požadavek vytvoří zásilku LTL a poskytne sledovací údaje a podrobnosti výstrahy. V případě jakéhokoli selhání rovněž vrátí chyby a jejich popisy.
Poznámka: Poštovní adresa může být jiná než aktuální dodací adresa.
Ověření dostupnosti služby vyzvednutí LTL zásilky
Pomocí tohoto koncového bodu si můžete vyžádat seznam všech dostupných provozoven pro vyzvednutí těžkých zásilek s podrobnostmi o plánu vyzvednutí, jako je přepravce, nejzazší možný čas vyzvednutí, výchozí nejzazší možný čas, dostupnost pro vyzvednutí, čas, kdy má být zásilka připravena k vyzvednutí, označení, zda se jedná o adresu domácnosti, uzávěrka vyzvednutí a přístup pro řidiče, aby mohl zásilku vyzvednout.
Požadované vstupní údaje pro tento požadavek jsou:
- Podrobnosti o adrese vyzvednutí.
- Požadovaný typ vyzvednutí (např. tentýž den / následující den).
- Zda se jedná o vnitrostátní/mezinárodní vyzvednutí.
Poznámka: Použijte správnou a platnou adresu vyzvednutí.
Úspěšná odpověď na tento požadavek poskytne seznam všech dostupných provozoven pro vyzvednutá těžkých zásilek, den doručení, dostupnost (příznak), datum vyzvednutí, čas uzávěrky, čas přístupu, dostupnost pro adresy domácností (příznak), konec pracovní doby (příznak), konec pracovní doby a místní čas. V případě jakéhokoli selhání rovněž vrátí chyby a jejich popisy.
Vytvoření vyzvednutí zásilky Freight LTL
Tento koncový bod použijte k vytvoření a naplánování vyzvednutí LTL těžké zásilky.
Požadované vstupní údaje pro tento požadavek jsou:
- Číslo účtu Freight, na který bude vyzvednutí fakturováno.
- Podrobnosti o místě původu (adresa, provozovna a typ adresy vyzvednutí jako účet/odesílatel/jiný).
- Podrobnosti o adrese přidruženého účtu.
Úspěšný požadavek na vyzvednutí vrátí potvrzovací číslo vyzvednutí, oznámení o vyzvednutí a kód provozovny pro naplánované vyzvednutí. V případě jakéhokoli selhání rovněž vrátí chyby a jejich popisy.
Poznámka: Chcete-li naplánovat vyzvednutí zásilky, použijte správnou a platnou adresu pro vyzvednutí a také zadejte správnou adresu účtu uvedenou v evidenci. Při plánování vyzvednutí zásilky nesmíte zadat čas a datum, které již byly nebo jsou velmi daleko v budoucnu od aktuálního data. Anonymní vyzvednutí není povoleno. Vyzvednutí zásilky pro účty třetích stran můžete naplánovat zadáním platné alternativní adresy.
Zrušení vyzvednutí zásilky Freight LTL
Pomocí tohoto koncového bodu zrušíte požadavek na již naplánované vyzvednutí zásilky LTL. Úspěšné zrušení vyzvednutí vrátí potvrzovací číslo a potvrzovací zprávu o zrušení vyzvednutí.
Požadované vstupní údaje pro tento požadavek jsou:
- Potvrzovací kód vyzvednutí (získaný při odeslání požadavku na vyzvednutí)
- Naplánované datum (Datum vyslání kurýra pro vyzvednutí)
- Provozovna (provozovna FedEx Express odpovědná za zpracování požadavku na vyzvednutí)
Úspěšný požadavek vrátí potvrzovací číslo vyzvednutí, oznámení o vyzvednutí a kód provozovny pro naplánované vyzvednutí. V případě jakéhokoli selhání rovněž vrátí chyby a jejich popisy.
Poznámka: Chcete-li zrušit již naplánované vyzvednutí, odešlete potvrzovací číslo vyzvednutí a kód příslušné provozovny (platí pouze pro FDXE). Potvrzovací číslo vyzvednutí a kód příslušné provozovny (platí pouze pro FDXE) získáte při odeslání požadavku na vyzvednutí. Chcete-li zrušit vyzvednutí, použijte také správnou adresu uvedenou v záznamech. Jestliže se pokusíte zrušit vyzvednutí poté, co byl vyslán kurýr FedEx na místo vyzvednutí zásilky, obdržíte oznámení o neúspěšném požadavku.
Sazba Freight LTL
Tento koncový bod slouží k odeslání požadavku na seznam všech dostupných cenových nabídek pro těžké zásilky a volitelných informací o přepravě na základě vstupních údajů. Získané ceny jsou založeny na místě původu, místě určení a různých dalších vstupních údajích o zásilce. Výsledky lze dále zpřesnit pomocí dodatečných informací, jako je například kód přepravce, typ služby nebo možnosti služby.
Požadované vstupní údaje pro tento požadavek jsou:
- Číslo účtu Freight
- Zásilka vyžadující nákladní přepravu
Úspěšná odpověď na tento požadavek vrátí seznam všech možných cen a kódů provozoven umožňujících naplánovat vyzvednutí zásilky. V případě jakéhokoli selhání rovněž vrátí chyby a jejich popisy.
Vícekusová zásilka Freight LTL (MPS)
Vícekusová zásilka (MPS) se skládá ze dvou nebo více manipulačních jednotek odeslaných na stejnou adresu příjemce. První manipulační jednotka v dané zásilce je považována za hlavní.
Vytvoření vícekusové zásilky:
- Zadejte informace na úrovni zásilky, jako jsou podrobnosti v prvcích serviceType, packagingType, totalWeight, totalPackageCount, freightShipmentDetail a requestedPackageLineItems. [Poznámka: Prvek sequenceNumber pro hlavní zásilku musí být roven 1.]
- Pro tisk štítků pro manipulační jednotky uveďte hlavní sledovací údaje v prvku masterTrackingId pro všechny další manipulační jednotky.
Následují možnosti zpracování vícekusových zásilek dostupné v rámci tohoto rozhraní API:
Vytisknout štítky pro jednotlivé manipulační jednotky
Toto rozhraní API vám umožňuje zpracovat vícekusové zásilky (MPS) a získat jednotlivé přepravní štítky.
Jestliže tuto možnost pro své zásilky potřebujete, uveďte ve svém požadavku kromě všech nezbytných prvků vícekusové zásilky také prvek oneLabelAtATime as true.
Výstup prvního požadavku by měl vytvořit štítek a sledovací číslo, které je hlavním sledovacím číslem. Toto hlavní sledovací číslo zadejte do prvku masterTrackingId, aby bylo možné zpracovat následnou žádost o odeslání a vytvořit štítky se sledovacími čísly (podřízená sledovací čísla) pro definovaný celkový počet balíků (totalPackageCount).
Poznámka: Maximální počet manipulačních jednotek je 200.
Vytisknout štítky pro všechny manipulační jednotky najednou
Toto rozhraní API vám umožňuje zpracovat vícekusové zásilky (MPS) a získat najednou všechny přepravní štítky. Jedná se o ideální způsob zpracování, jestliže zásilka obsahuje maximálně 40 manipulačních jednotek (totalPackageCount<=40) určených pro jednu adresu příjemce.
V požadavku zásilky s maximálně 40 manipulačními jednotkami nastavte prvek oneLabelAtATime na hodnotu false a vytvořte přepravní štítky najednou.
Poznámka: Maximální limit 40 manipulačních jednotek je orientační a není pevně stanoven. Limit závisí také na kombinaci počtu manipulačních jednotek a komodit v zásilce. Další informace vám poskytne obchodní zástupce společnosti FedEx.
Příklad: Váš požadavek na zásilku obsahuje 10 manipulačních jednotek a při odeslání tohoto požadavku bude vytvořeno 10 štítků, přičemž odpověď bude obsahovat adresy URL pro každý štítek nebo zakódované štítky (podle požadavku).
FedEx Freight Direct
Tato služba poskytuje zákazníkům nadstandardní služby při doručování velkých a paletizovaných zásilek, včetně doručování těžkých a objemných zásilek do domácností a firem.
Služba nabízí možnosti, jako je proaktivní komunikace, flexibilní možnosti doručení a množstevní ceny, které zahrnují příplatky za služby.
Některé z funkcí, které tato služba zahrnuje:
- Umožňuje vytváření zásilek FedEx Freight Direct se základním doručením, základním doručením dle dohody, standardním doručením a prémiovým doručením a základních zpětných zásilek / zásilek se základním vyzvednutím v rámci kontinentálních Spojených států, Aljašky a Havaje.
- Nabízí možnost získat kompletní cenový odhad pro zásilky FedEx Freight Direct s použitím čísla účtu FedEx Freight Direct a možnost zrušit vyzvednutí FedEx Freight Direct.
- Nebudou vráceny odhady sazeb pro Aljašku a Havaj. Pokud si chcete vyžádat cenovou nabídku pro tyto státy, kontaktujte tým zákaznické podpory FedEx.
- Pokud chce zákazník zrušit vyzvednutí naplánované na daný den, musí zavolat na zákaznický servis FedEx.
- Umožňuje odesílání e-mailových oznámení původnímu odesílateli/příjemci, takže zákazník může:
- Naplánovat doručení
- Přijímat potvrzení o doručení a/nebo vyzvednutí
- Přijímat oznámení o předání k doručení a/nebo vyzvednutí
- Přijímat oznámení o tom, že je zásilka na cestě
- Zákaznický průzkum ohledně doručených zásilek
- Na službu FedEx Freight Direct se vztahují obchodní pravidla pro ověřování PSČ, rozměry, hmotnost kusů a hmotnost manipulačních jednotek pro určení správné kombinace služeb pravidelné nákladní dopravy a služeb prvního/posledního kroku.
Služba FedEx Freight Direct nabízí výběr z různých typů služeb.
Toto rozhraní API nabízí následující funkce služby Freight Direct:
Zjištění cen služby Freight Direct
Použijte tento koncový bod k zjištění cen a příplatků služby Freight Direct pro následující speciální možnosti služby Freight Direct: základní služba, základní služba dle dohody, standardní služba, prémiová služba.
Níže jsou uvedeny požadované údaje, které je třeba zahrnout do žádosti o zjištění cen pomocí koncového bodu Sazba Freight LTL:
- Typ služby Freight Direct (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
- Typ přepravy Freight Direct (DELIVERY, PICKUP)
- Typ telefonního čísla, pokud je zadáno (HOME, MOBILE, WORK)
- Hmotnost
- Rozměry (nezáporná délka, šířka a výška)
Vytvoření zásilky Freight Direct
Tento koncový bod můžete použít k odeslání jednokusé nebo vícekusé zásilky s následujícími speciálními možnostmi služby Freight Direct: základní služba, základní služba dle dohody, standardní služba, prémiová služba a získání přepravního štítku nebo nákladního listu, včetně požadované dokumentace pro zpracování zásilek Freight Priority.
Níže jsou uvedeny požadované údaje, které je třeba zahrnout do žádosti o zásilku prostřednictvím koncového bodu Odeslání Freight LTL:
- Typ služby Freight Direct (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
- Typ přepravy Freight Direct (DELIVERY, PICKUP)
- E-mailová adresa, telefonní číslo a typ telefonu
- Hmotnost
- Rozměry (nezáporná délka, šířka a výška)
Na výstupním nákladním listu budou vytištěny nové názvy služby Freight Direct. Níže jsou uvedeny hodnoty vytištěné na nákladním listu v závislosti na výběru služby:
- DIRECT BASIC DELIVERY
- DIRECT BASIC BY APPOINTMENT DELIVERY
- DIRECT PREMIUM DELIVERY
- DIRECT STANDARD DELIVERY
- DIRECT BASIC PICKUP
- DIRECT BASIC BY APPOINTMENT PICKUP
- DIRECT PREMIUM PICKUP
- DIRECT STANDARD PICKUP
Vyzvednutí Freight Direct
Tento koncový bod můžete použít k ověření dostupnosti služby vyzvednutí Freight LTL Freight Direct, vytvoření žádosti pro vyzvednutí zásilky nebo zrušení existujícího vyžádaného vyzvednutí.
Níže jsou uvedeny požadované údaje, které je třeba zahrnout do žádosti o vyzvednutí prostřednictvím koncového bodu Ověření dostupnosti služby Freight LTL, Vytvoření vyzvednutí zásilky Freight LTL a Zrušení vyzvednutí zásilky Freight LTL.
- Typ služby Freight Direct (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
- Typ přepravy Freight Direct (DELIVERY, PICKUP)
- E-mailová adresa (vytvoření žádosti o vyzvednutí)
- Telefonní číslo a typ telefonu (vytvoření žádosti o vyzvednutí)
- Hmotnost
Obchodní pravidla
- První manipulační jednotce zásilky Freight LTL je přiděleno hlavní podací číslo (Pro) a každé další manipulační jednotce jsou přidělena posloupná podací čísla.
- Každou manipulační jednotku zásilky lze sledovat individuálně nebo jako část celé zásilky.
- Na konkrétní zásilky se mohou vztahovat další dokumenty (např. zásilky nebezpečných materiálů [HazMat] a mezinárodní zásilky).
- Na portál FedEx Developer Portal nelze přidat účty pouze LTL Freight a účty plátce LTL Freight.
- Zákazníci mohou při používání služeb Freight Direct použít buď dlouhodobé číslo účtu LTL, nebo číslo účtu FedEx Freight Direct.
- Možnosti cen služby FedEx Freight Direct jsou k dispozici pouze v běžném rozhraní API LTL.
- Všechny nové chyby/zprávy budou pouze v angličtině.
- E-mailová adresa a telefon jsou vyžadovány jako součást žádosti o službu FedEx Freight Direct při vytváření zásilek.
Kolekce JSON API
Freight LTL API (1.0.0)
Rate Freight LTL
This endpoint providess the ability to retrieve rate quotes and optionall transitt informationnnn. The rate is calculated based on the origin and destination of the shipment. Additional information such as carrier code, service type, or service option can be used to filter the results. Applicable operating company is FedEx Freight.
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
| accountNumber required | object (LTLRootAccountNumber) This is the Account number details.
|
| rateRequestControlParameters | object (LTLRateRequestControlParameters) These are various parameters you can provide for filtering and sorting capability in the response, such as transit time and commit data, rate sort order etc. |
| freightRequestedShipment required | object (LTLRequestedShipment) This contains shipment data describing the shipment for which a freight rate quote (or rate-shopping comparison) is desired. |
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
- "accountNumber": {
- "value": "XXX61073"
- "rateRequestControlParameters": {
- "returnTransitTimes": false,
- "servicesNeededOnRateFailure": true,
- "variableOptions": "FREIGHT_GUARANTEE",
- "rateSortOrder": "SERVICENAMETRADITIONAL"
- "freightRequestedShipment": {
- "shipper": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "recipient": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "preferredCurrency": "USD",
- "shippingChargesPayment": {
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number"
- "accountNumber": {
- "value": "123456789"
- "paymentType": "SENDER"
- "rateRequestType": [
- "LIST"
- "shipDateStamp": "2019-09-06",
- "requestedPackageLineItems": [
- {
- "subPackagingType": "BAG",
- "groupPackageCount": 1,
- "contentRecord": [
- {
- "itemNumber": "string",
- "receivedQuantity": 0,
- "description": "string",
- "partNumber": "string"
- "declaredValue": {
- "amount": "100",
- "currency": "USD"
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "associatedFreightLineItems": [
- {
- "id": "string"
- "totalPackageCount": 3,
- "totalWeight": 87,
- "freightShipmentDetail": {
- "role": "CONSIGNEE",
- "accountNumber": {
- "value": "XXXXX6789"
- "declaredValueUnits": "string",
- "shipmentDimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "lineItem": [
- {
- "handlingUnits": 0,
- "nmfcCode": "string",
- "subPackagingType": "BAG",
- "description": "string",
- "weight": {
- "units": "KG",
- "value": 68.25
- "pieces": 0,
- "volume": {
- "units": "CUBIC_FT",
- "value": 0
- "freightClass": "CLASS_050",
- "purchaseOrderNumber": "string",
- "id": "string",
- "hazardousMaterials": "HAZARDOUS_MATERIALS",
- "dimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "clientDiscountPercent": 0,
- "fedExFreightBillingContactAndAddress": {
- "address": {
- "streetLines": [
- "string",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "string",
- "postalCode": "string",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "aliasID": "string",
- "hazardousMaterialsOfferor": "string",
- "declaredValuePerUnit": {
- "amount": "100",
- "currency": "USD"
- "totalHandlingUnits": 0,
- "alternateBillingParty": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "accountNumber": {
- "value": "XXX61073"
- "freightShipmentSpecialServices": {
- "freightGuaranteeDetail": {
- "freightGuaranteeType": "GUARANTEED_DATE",
- "guaranteeTimestamp": "string"
- "specialServiceTypes": [
- "FREIGHT_GUARANTEE"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "STANDARD",
- "transportationType": "DELIVERY",
- "emailAddress": "abc@def.com",
- "phoneNumberDetails": [
- {
- "phoneNumberType": "MOBILE",
- "phoneNumber": "XXXXXXXXX12"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "transactionId": "63a21b84-ad5c-4da2-b788-f615e5cafaa3",
- "output": {
- "alerts": [
- {
- "code": "MIXED.MEASURING.UNITS.INCLUDED",
- "message": "Package 1 - Mixed measuring units are provided for weight and dimensions.",
- "alertType": "WARNING",
- "parameterList": [
- {
- "key": "Package Index",
- "value": "1"
- "rateReplyDetails": [
- {
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "commit": {
- "dateDetail": {
- "dayOfWeek": "Fri",
- "dayFormat": "2020-12-04T17:00:00-06:00"
- "transitDays": {
- "minimumTransitTime": "TWO_DAYS",
- "description": "2 Business Days"
- "saturdayDelivery": false
- "ratedShipmentDetails": [
- {
- "quoteNumber": "1100739606",
- "rateType": "ACCOUNT",
- "freightChargeBasis": "MINIMUM",
- "ratedWeightMethod": "FREIGHT_MINIMUM",
- "totalDiscounts": 0,
- "totalBaseCharge": 805,
- "totalNetCharge": 996.59,
- "totalNetFedExCharge": 996.59,
- "shipmentLegRateDetails": [
- {
- "rateScale": "*FXF PZONE 01/04/21 LD 11122",
- "totalBaseCharge": 0,
- "totalNetCharge": 996.59
- "shipmentRateDetail": {
- "dimDivisor": 0,
- "fuelSurchargePercent": 23.8,
- "totalSurcharges": 191.59,
- "totalFreightDiscount": 0,
- "surCharges": [
- {
- "type": "FUEL",
- "description": "Fuel Surcharge",
- "level": "SHIPMENT",
- "amount": 191.59
- "totalBillingWeight": {
- "units": "LB",
- "value": 331
- "totalDimWeight": {
- "units": "LB",
- "value": 0
- "currency": "USD",
- "rateScale": "*FXF PZONE 01/04/21 LD 11122"
- "currency": "USD"
- "operationalDetail": {
- "originLocationNumbers": [ ],
- "deliveryDate": "2020-12-04T17:00:00-06:00",
- "deliveryDay": "FRI",
- "commitDate": "2020-12-04T17:00:00-06:00",
- "commitDays": [
- "FRI"
- "transitTime": "TWO_DAYS",
- "ineligibleForMoneyBackGuarantee": true
- "freightTransitLocationDetail": {
- "originLocation": {
- "contactAndAddress": {
- "contact": {
- "personName": "DAWN THIELHART",
- "phoneNumber": "800-218-6293"
- "address": {
- "streetLines": [
- "6952 E HILLSBOROUGH AVE",
- ""
- "city": "TAMPA",
- "stateOrProvinceCode": "FL",
- "postalCode": "33610-4136",
- "countryCode": "US",
- "residential": false
- "locationId": "TPA"
- "destinationLocation": {
- "contactAndAddress": {
- "contact": {
- "personName": "TED CLAY",
- "phoneNumber": "214-333-4544"
- "address": {
- "streetLines": [
- "1501 N WALTON WALKER BLVD",
- ""
- "city": "DALLAS",
- "stateOrProvinceCode": "TX",
- "postalCode": "75211",
- "countryCode": "US",
- "residential": false
- "locationId": "SDA"
- "distance": {
- "units": "MI",
- "value": 1139
- "quoteDate": "2020-12-02",
- "encoded": false
Ship Freight LTL
This endpoint helps you to create a Freight LTL Shipment request with the required Freight LTL Shipment information, and to retrieve information for an already in process shipment. It also allows you to confirm and validate 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-FreightShipment
- FreightShipment_ShipTo_Freight_Account
- FreightShipment_BillTo_Freight_Account
- FreightShipment_International_SingleShot_MPS_ShipTo_Freight_Account
- FreightShipment_OneLabelAtATime_MPS_Master_ShipTo_Freight_Account
- FreightShipment_OneLabelAtATime_MPS_Child_ShipTo_Freight_Account
| freightRequestedShipment required | object (FreightRequestedShipment_Freight2020) The descriptive data for the FreightShipment being tendered to FedEx. |
| labelResponseOptions required | string Enum: "URL_ONLY" "LABEL" If the value is LABEL, the encoded label will be included in the response and if the value is URL_ONLY, the response will include the URLs. Note: With URL_ONLY option, the URL once created will be active for 24 hours. |
| accountNumber required | object (ShipperAccountNumber) The account number associated with the shipment. |
| oneLabelAtATime | boolean If the value is false, it uses single shot MPS shipments where in all the packages are processed in the same transaction and can generate number of labels for the handling units all at once. If the value is true, the MPS shipment processes packages and labels one at a time. Default value is false.
|
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
- "freightRequestedShipment": {
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "FEDEX_FREIGHT_ECONOMY",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20,
- "preferredCurrency": "USD",
- "shipper": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": "1234567",
- "stateTaxId": "1234567",
- "fedralTaxId": "11-N-1745"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "recipient": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": "1234567",
- "stateTaxId": "1234567",
- "fedralTaxId": "11-N-1645"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "deliveryInstructions": "delivery instructions"
- "soldTo": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "91",
- "phoneNumber": "1234567890",
- "companyName": "Fedex"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "accountNumber": {
- "value": "XXXXX6789"
- "origin": {
- "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"
- "shippingChargesPayment": {
- "paymentType": "SENDER",
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number",
- "stateTaxId": "state tax identifier",
- "fedralTaxId": "11-N-1745"
- "accountNumber": {
- "value": "801472842"
- "billingDetails": {
- "billingCode": "123876",
- "billingType": "billingType",
- "aliasId": "aliasId",
- "accountNickname": "accountNickname",
- "accountNumber": "801472842",
- "accountNumberCountryCode": "US"
- "freightShipmentSpecialServices": {
- "specialServiceTypes": [
- "THIRD_PARTY_CONSIGNEE",
- "PROTECTION_FROM_FREEZING"
- "freightGuaranteeDetail": {
- "freightGuaranteeType": "GUARANTEED_DATE",
- "guaranteeTimestamp": "2009-12-04"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "STANDARD",
- "transportationType": "DELIVERY",
- "emailAddress": "abc@def.com",
- "phoneNumberDetails": [
- {
- "phoneNumberType": "MOBILE",
- "phoneNumber": "XXXXXXXXX12"
- "customDeliveryWindowDetail": {
- "requestDate": "2023-05-15",
- "requestTime": "10:00:00",
- "requestRange": {
- "begins": "12-01-2020",
- "ends": "22-01-2020"
- "type": "AFTER"
- "emailNotificationDetail": {
- "aggregationType": "PER_PACKAGE",
- "emailNotificationRecipients": [
- {
- "name": "Joe Smith",
- "emailNotificationRecipientType": "SHIPPER",
- "emailAddress": "jsmith3@aol.com",
- "notificationFormatType": "TEXT",
- "notificationType": "EMAIL",
- "locale": "en_US",
- "notificationEventType": [
- "ON_PICKUP_DRIVER_ARRIVED",
- "ON_SHIPMENT"
- "personalMessage": "your personal message here"
- "freightShipmentDetail": {
- "role": "CONSIGNEE",
- "specialServicePayments": [
- {
- "specialService": "Special Service",
- "paymentType": "COLLECT"
- "liabilityCoverageDetail": {
- "coverageType": "USED_OR_RECONDITIONED",
- "coverageAmount": {
- "amount": 12.45,
- "currency": "USD"
- "fedExFreightAccountNumber": {
- "value": "Your account number"
- "declaredValueUnits": "LBS",
- "printedReferences": [
- {
- "printedReferenceType": "BILL_OF_LADING",
- "value": "1"
- "hazardousMaterialsEmergencyContactNumber": {
- "areaCode": "901",
- "localNumber": "3575012",
- "extension": "200",
- "countryCode": "US",
- "personalIdentificationNumber": "98712345"
- "lineItem": [
- {
- "handlingUnits": 12,
- "nmfcCode": "nmfcCode",
- "subPackagingType": "BUNDLE",
- "description": "description",
- "weight": {
- "units": "KG",
- "value": 68.25
- "pieces": 12,
- "volume": {
- "units": "CUBIC_FT",
- "value": 9.965781217890562
- "freightClass": "CLASS_050",
- "purchaseOrderNumber": "50",
- "id": "123",
- "hazardousMaterials": "HAZARDOUS_MATERIALS",
- "dimensions": {
- "length": 25,
- "width": 10,
- "height": 12,
- "units": "IN"
- "classProvidedByCustomer": true
- "clientDiscountPercent": 5.12,
- "coupons": [
- "coupons"
- "fedExFreightBillingContactAndAddress": {
- "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"
- "aliasID": "981234",
- "collectTermsType": "NON_RECOURSE_SHIPPER_SIGNED",
- "hazardousMaterialsOfferor": "offeror",
- "declaredValuePerUnit": {
- "amount": 12.45,
- "currency": "USD"
- "totalHandlingUnits": 12,
- "alternateBillingParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXX2345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "variableHandlingChargeDetail": {
- "rateType": "PREFERRED_CURRENCY",
- "percentValue": 12.45,
- "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
- "fixedValue": {
- "amount": 24.45,
- "currency": "USD"
- "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
- "customsClearanceDetail": {
- "regulatoryControls": [
- "NOT_IN_FREE_CIRCULATION",
- "USMCA"
- "brokers": [
- {
- "broker": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": 1234567
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "deliveryInstructions": "deliveryInstructions"
- "type": "IMPORT"
- "commercialInvoice": {
- "originatorName": "originator Name",
- "comments": [
- "optional comments for the commercial invoice"
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "taxesOrMiscellaneousCharge": {
- "amount": 12.45,
- "currency": "USD"
- "taxesOrMiscellaneousChargeType": "COMMISSIONS",
- "freightCharge": {
- "amount": 12.45,
- "currency": "USD"
- "packingCosts": {
- "amount": 12.45,
- "currency": "USD"
- "handlingCosts": {
- "amount": 12.45,
- "currency": "USD"
- "declarationStatement": "declarationStatement",
- "termsOfSale": "FCA",
- "specialInstructions": "specialInstructions\"",
- "shipmentPurpose": "REPAIR_AND_RETURN",
- "emailNotificationDetail": {
- "emailAddress": "neena@fedex.com",
- "type": "EMAILED",
- "recipientType": "SHIPPER"
- "freightOnValue": "OWN_RISK",
- "dutiesPayment": {
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "billingDetails": {
- "billingCode": "billingCode",
- "billingType": "billingType",
- "aliasId": "aliasId",
- "accountNickname": "accountNickname",
- "accountNumber": "Your account number",
- "accountNumberCountryCode": "US"
- "paymentType": "SENDER"
- "commodities": [
- {
- "unitPrice": {
- "amount": 12.45,
- "currency": "USD"
- "additionalMeasures": [
- {
- "quantity": 12.45,
- "units": "KG"
- "numberOfPieces": 12,
- "quantity": 125,
- "quantityUnits": "Ea",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "countryOfManufacture": "US",
- "cIMarksAndNumbers": "87123",
- "harmonizedCode": "0613",
- "description": "description",
- "name": "non-threaded rivets",
- "weight": {
- "units": "KG",
- "value": 68.25
- "exportLicenseNumber": "26456",
- "exportLicenseExpirationDate": "2025-04-10T14:49:20Z",
- "partNumber": "167",
- "purpose": "BUSINESS",
- "usmcaDetail": {
- "originCriterion": "A"
- "isDocumentOnly": true,
- "recipientCustomsId": {
- "type": "PASSPORT",
- "value": "123"
- "customsOption": {
- "description": "Description",
- "type": "COURTESY_RETURN_LABEL"
- "importerOfRecord": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "generatedDocumentLocale": "en_US",
- "exportDetail": {
- "destinationControlDetail": {
- "endUser": "dest country user",
- "statementTypes": "DEPARTMENT_OF_COMMERCE",
- "destinationCountries": [
- "USA",
- "India"
- "b13AFilingOption": "NOT_REQUIRED",
- "exportComplianceStatement": "12345678901234567",
- "permitNumber": "12345"
- "totalCustomsValue": {
- "amount": 12.45,
- "currency": "USD"
- "partiesToTransactionAreRelated": true,
- "declarationStatementDetail": {
- "usmcaLowValueStatementDetail": {
- "countryOfOriginLowValueDocumentRequested": true,
- "customsRole": "EXPORTER"
- "insuranceCharge": {
- "amount": 12.45,
- "currency": "USD"
- "labelSpecification": {
- "labelFormatType": "COMMON2D",
- "labelOrder": "SHIPPING_LABEL_FIRST",
- "customerSpecifiedDetail": {
- "maskedData": [
- "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
- "regulatoryLabels": [
- {
- "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
- "type": "ALCOHOL_SHIPMENT_LABEL"
- "additionalLabels": [
- {
- "type": "CONSIGNEE",
- "count": 1
- "docTabContent": {
- "docTabContentType": "BARCODED",
- "zone001": {
- "docTabZoneSpecifications": [
- {
- "zoneNumber": 0,
- "header": "string",
- "dataField": "string",
- "literalValue": "string",
- "justification": "RIGHT"
- "barcoded": {
- "symbology": "UCC128",
- "specification": {
- "zoneNumber": 0,
- "header": "string",
- "dataField": "string",
- "literalValue": "string",
- "justification": "RIGHT"
- "printedLabelOrigin": {
- "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"
- "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
- "labelRotation": "UPSIDE_DOWN",
- "imageType": "PDF",
- "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
- "returnedDispositionDetail": true,
- "resolution": 300
- "shippingDocumentSpecification": {
- "generalAgencyAgreementDetail": {
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "op900Detail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "signatureName": "Signature Name",
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "usmcaCertificationOfOriginDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "certifierSpecification": "EXPORTER",
- "importerSpecification": "UNKNOWN",
- "producerSpecification": "SAME_AS_EXPORTER",
- "producer": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "blanketPeriod": {
- "begins": "12-01-2020",
- "ends": "22-01-2020"
- "certifierJobTitle": "Manager"
- "usmcaCommercialInvoiceCertificationOfOriginDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "certifierSpecification": "EXPORTER",
- "importerSpecification": "UNKNOWN",
- "producerSpecification": "SAME_AS_EXPORTER",
- "producer": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "certifierJobTitle": "Manager"
- "shippingDocumentTypes": [
- "RETURN_INSTRUCTIONS",
- "DANGEROUS_GOODS_SHIPPERS_DECLARATION"
- "certificateOfOrigin": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "commercialInvoiceDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "freightAddressLabelDetail": {
- "copies": 25,
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "startingPosition": "BOTTOM_LEFT"
- "freightBillOfLadingDetail": {
- "format": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "rateRequestType": [
- "LIST",
- "PREFERRED"
- "totalPackageCount": 25,
- "masterTrackingId": {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "requestedPackageLineItems": [
- {
- "sequenceNumber": "1",
- "subPackagingType": "BUCKET",
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "declaredValue": {
- "amount": 12.45,
- "currency": "USD"
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 100,
- "width": 50,
- "height": 30,
- "units": "CM"
- "physicalPackaging": "class line",
- "groupPackageCount": 25,
- "itemDescriptionForClearance": "description",
- "contentRecord": [
- {
- "itemNumber": "2876",
- "receivedQuantity": 256,
- "description": "Description",
- "partNumber": "456"
- "itemDescription": "item description for the package",
- "variableHandlingChargeDetail": {
- "rateType": "PREFERRED_CURRENCY",
- "percentValue": 12.45,
- "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
- "fixedValue": {
- "amount": 24.45,
- "currency": "USD"
- "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
- "associatedFreightLineItems": [
- {
- "id": "98712345"
- "labelResponseOptions": "LABEL",
- "accountNumber": {
- "value": "Your account number"
- "oneLabelAtATime": true
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b55xxxxx492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "transactionShipments": [
- {
- "serviceType": "FEDEX_FREIGHT_ECONOMY",
- "shipDatestamp": "2010-03-04",
- "serviceCategory": "FREIGHT",
- "shipmentDocuments": [
- {
- "contentKey": "content key",
- "copiesToPrint": 10,
- "contentType": "COMMERCIAL_INVOICE",
- "trackingNumber": "794953535000",
- "docType": "PDF",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "encodedLabel": "encoded label",
- "pieceResponses": [
- {
- "netChargeAmount": 21.45,
- "transactionDetails": [
- {
- "transactionDetails": "transactionDetails",
- "transactionId": "12345"
- "packageDocuments": [
- {
- "contentKey": "content key",
- "copiesToPrint": 10,
- "contentType": "COMMERCIAL_INVOICE",
- "trackingNumber": "794953535000",
- "docType": "PDF",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "encodedLabel": "encoded label",
- "acceptanceTrackingNumber": "794953535000",
- "serviceCategory": "EXPRESS",
- "listCustomerTotalCharge": "listCustomerTotalCharge",
- "deliveryTimestamp": "2012-09-23",
- "trackingIdType": "FEDEX",
- "additionalChargesDiscount": 621.45,
- "netListRateAmount": 1.45,
- "baseRateAmount": 321.45,
- "packageSequenceNumber": 215,
- "netDiscountAmount": 121.45,
- "masterTrackingNumber": "794953535000",
- "acceptanceType": "acceptanceType",
- "trackingNumber": "794953535000",
- "successful": true,
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "serviceName": "FedEx Freight® Economy",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "completedShipmentDetail": {
- "completedPackageDetails": [
- {
- "sequenceNumber": 256,
- "operationalDetail": {
- "astraHandlingText": "astraHandlingText",
- "barcodes": {
- "binaryBarcodes": [
- {
- "type": "COMMON-2D",
- "value": "string"
- "stringBarcodes": [
- {
- "type": "ADDRESS",
- "value": "1010062512241535917900794953544894"
- "operationalInstructions": [
- {
- "number": 17,
- "content": "content"
- "signatureOption": "DIRECT",
- "trackingIds": [
- {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "groupNumber": 567,
- "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
- "packageRating": {
- "effectiveNetDiscount": 0,
- "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
- "packageRateDetails": [
- {
- "ratedWeightMethod": "DIM",
- "totalFreightDiscounts": 44.55,
- "totalTaxes": 3.45,
- "minimumChargeType": "minimumChargeType",
- "baseCharge": 45.67,
- "totalRebates": 4.56,
- "rateType": "PAYOR_RETAIL_PACKAGE",
- "billingWeight": {
- "units": "KG",
- "value": 68
- "netFreight": 4.89,
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 22.56,
- "netFedExCharge": 12.56,
- "netCharge": 121.56,
- "currency": "USD"
- "dryIceWeight": {
- "units": "KG",
- "value": 68
- "hazardousPackageDetail": {
- "regulation": "IATA",
- "accessibility": "ACCESSIBLE",
- "labelType": "II_YELLOW",
- "containers": [
- {
- "qvalue": 2,
- "hazardousCommodities": [
- {
- "quantity": {
- "quantityType": "GROSS",
- "amount": 24.56,
- "units": "Kg"
- "options": {
- "quantity": {
- "quantityType": "GROSS",
- "amount": 24.56,
- "units": "Kg"
- "innerReceptacles": [
- {
- "quantity": {
- "quantityType": "NET",
- "amount": 34.56,
- "units": "Kg"
- "options": {
- "labelTextOption": "APPEND",
- "customerSuppliedLabelText": "Customer Supplied Label Text."
- "description": {
- "sequenceNumber": 9812,
- "processingOptions": [
- "INCLUDE_SPECIAL_PROVISIONS"
- "subsidiaryClasses": [
- "Subsidiary Classes"
- "labelText": "labelText",
- "technicalName": "technicalName",
- "packingDetails": {
- "packingInstructions": "packing Instructions",
- "cargoAircraftOnly": true
- "authorization": "authorization",
- "reportableQuantity": true,
- "percentage": 12.45,
- "id": "123",
- "packingGroup": "I",
- "properShippingName": "properShippingName",
- "hazardClass": "hazard Class"
- "description": {
- "sequenceNumber": 876,
- "packingInstructions": "packingInstructions",
- "subsidiaryClasses": [
- "Subsidiary Classes"
- "labelText": "labelText",
- "tunnelRestrictionCode": "UN2919",
- "specialProvisions": "specialProvisions",
- "properShippingNameAndDescription": "properShippingNameAndDescription",
- "technicalName": "technicalName",
- "symbols": "symbols",
- "authorization": "authorization",
- "attributes": [
- "attributes"
- "id": "1234",
- "packingGroup": "packingGroup",
- "properShippingName": "properShippingName",
- "hazardClass": "hazardClass"
- "netExplosiveDetail": {
- "amount": 10,
- "units": "units",
- "type": "NET_EXPLOSIVE_WEIGHT"
- "massPoints": 2
- "cargoAircraftOnly": true,
- "referenceId": "123456",
- "radioactiveTransportIndex": 2.45
- "operationalDetail": {
- "originServiceArea": "A1",
- "serviceCode": "010",
- "airportId": "DFW",
- "postalCode": "38010",
- "scac": "scac",
- "deliveryDay": "TUE",
- "originLocationId": "678",
- "countryCode": "US",
- "astraDescription": "SMART POST",
- "originLocationNumber": 243,
- "deliveryDate": "2001-04-05",
- "deliveryEligibilities": [
- "deliveryEligibilities"
- "ineligibleForMoneyBackGuarantee": true,
- "maximumTransitTime": "SEVEN_DAYS",
- "destinationLocationStateOrProvinceCode": "GA",
- "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
- "destinationLocationId": "DALA",
- "transitTime": "TWO_DAYS",
- "stateOrProvinceCode": "GA",
- "destinationLocationNumber": 876,
- "packagingCode": "03",
- "commitDate": "2019-10-15",
- "publishedDeliveryTime": "10:30A",
- "ursaSuffixCode": "Ga",
- "ursaPrefixCode": "XH",
- "destinationServiceArea": "A1",
- "commitDay": "TUE",
- "customTransitTime": "ONE_DAY"
- "carrierCode": "FDXE",
- "completedHoldAtLocationDetail": {
- "holdingLocationType": "FEDEX_STAFFED",
- "holdingLocation": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "tollFreePhoneNumber": "6127812",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "91",
- "faxNumber": "1234567890",
- "pagerNumber": "6127812",
- "companyName": "Fedex",
- "title": "title"
- "completedEtdDetail": {
- "folderId": "0b0493e580dc1a1b",
- "type": "COMMERCIAL_INVOICE",
- "uploadDocumentReferenceDetails": [
- {
- "documentType": "PRO_FORMA_INVOICE",
- "documentReference": "DocumentReference",
- "description": "PRO FORMA INVOICE",
- "documentId": "090927d680038c61"
- "packagingDescription": "description",
- "masterTrackingId": {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "serviceDescription": {
- "serviceType": "FEDEX_1_DAY_FREIGHT",
- "code": "80",
- "names": [
- {
- "type": "long",
- "encoding": "UTF-8",
- "value": "F-2"
- "operatingOrgCodes": [
- "FXE"
- "astraDescription": "2 DAY FRT",
- "description": "description",
- "serviceId": "EP1000000027",
- "serviceCategory": "freight"
- "usDomestic": true,
- "hazardousShipmentDetail": {
- "hazardousSummaryDetail": {
- "smallQuantityExceptionPackageCount": 10
- "adrLicense": {
- "licenseOrPermitDetail": {
- "number": "12345",
- "effectiveDate": "2019-08-09",
- "expirationDate": "2019-04-09"
- "dryIceDetail": {
- "totalWeight": {
- "units": "KG",
- "value": 68
- "packageCount": 10,
- "processingOptions": {
- "options": [
- "options"
- "shipmentRating": {
- "actualRateType": "PAYOR_LIST_SHIPMENT",
- "shipmentRateDetails": [
- {
- "rateZone": "US001O",
- "ratedWeightMethod": "ACTUAL",
- "totalDutiesTaxesAndFees": 24.56,
- "pricingCode": "LTL_FREIGHT",
- "totalFreightDiscounts": 1.56,
- "totalTaxes": 3.45,
- "totalDutiesAndTaxes": 6.78,
- "totalAncillaryFeesAndTaxes": 5.67,
- "taxes": [
- {
- "amount": 10,
- "level": "level",
- "description": "description",
- "type": "type"
- "totalRebates": 1.98,
- "fuelSurchargePercent": 4.56,
- "currencyExchangeRate": {
- "rate": 25.6,
- "fromCurrency": "Rupee",
- "intoCurrency": "USD"
- "totalNetFreight": 9.56,
- "totalNetFedExCharge": 88.56,
- "shipmentLegRateDetails": [
- {
- "rateZone": "rateZone",
- "pricingCode": "pricingCode",
- "taxes": [
- {
- "amount": 10,
- "level": "level",
- "description": "description",
- "type": "type"
- "totalDimWeight": {
- "units": "KG",
- "value": 68
- "totalRebates": 2,
- "fuelSurchargePercent": 6,
- "currencyExchangeRate": {
- "rate": 25.6,
- "fromCurrency": "Rupee",
- "intoCurrency": "USD"
- "dimDivisor": 6,
- "rateType": "PAYOR_RETAIL_PACKAGE",
- "legDestinationLocationId": "legDestinationLocationId",
- "dimDivisorType": "dimDivisorType",
- "totalBaseCharge": 6,
- "ratedWeightMethod": "ratedWeightMethod",
- "totalFreightDiscounts": 9,
- "totalTaxes": 12.6,
- "minimumChargeType": "minimumChargeType",
- "totalDutiesAndTaxes": 17.78,
- "totalNetFreight": 6,
- "totalNetFedExCharge": 3.2,
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 5,
- "totalBillingWeight": {
- "units": "KG",
- "value": 68
- "freightDiscounts": [
- {
- "amount": 8.9,
- "rateDiscountType": "COUPON",
- "percent": 28.9,
- "description": "description"
- "rateScale": "6702",
- "totalNetCharge": 253,
- "totalNetChargeWithDutiesAndTaxes": 25.67,
- "currency": "USD"
- "dimDivisor": 0,
- "rateType": "RATED_ACCOUNT_SHIPMENT",
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 9.88,
- "totalBillingWeight": {
- "units": "KG",
- "value": 68
- "freightDiscounts": [
- {
- "amount": 8.9,
- "rateDiscountType": "COUPON",
- "percent": 28.9,
- "description": "description"
- "rateScale": "00000",
- "totalNetCharge": 3.78,
- "totalBaseCharge": 234.56,
- "totalNetChargeWithDutiesAndTaxes": 222.56,
- "currency": "USD"
- "documentRequirements": {
- "requiredDocuments": [
- "COMMERCIAL_OR_PRO_FORMA_INVOICE",
- "AIR_WAYBILL"
- "prohibitedDocuments": [
- "CERTIFICATE_OF_ORIGIN"
- "generationDetails": [
- {
- "type": "COMMERCIAL_INVOICE",
- "minimumCopiesRequired": 3,
- "letterhead": "OPTIONAL",
- "electronicSignature": "OPTIONAL"
- "exportComplianceStatement": "12345678901234567",
- "accessDetail": {
- "accessorDetails": [
- {
- "password": "password",
- "role": "role",
- "emailLabelUrl": "emailLabelUrl",
- "userId": "userId"
- "shipmentAdvisoryDetails": {
- "regulatoryAdvisory": {
- "commodityClarifications": [
- {
- "commodityIndex": 25,
- "suggestions": [
- {
- "description": "description",
- "harmonizedCode": "harmonized Code"
- "prohibitions": [
- {
- "derivedHarmonizedCode": "01",
- "advisory": {
- "code": "code",
- "text": "Text",
- "parameters": [
- {
- "id": "message ID",
- "value": "Message value"
- "localizedText": "localizedText"
- "commodityIndex": 12,
- "source": "source",
- "categories": [
- "categories"
- "type": "type",
- "waiver": {
- "advisories": [
- {
- "code": "code",
- "text": "Text",
- "parameters": [
- {
- "id": "message ID",
- "value": "Message value"
- "localizedText": "localizedText"
- "description": "description",
- "id": "id"
- "status": "status"
- "masterTrackingNumber": "794953535000"
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
Check Freight LTL Pickup Availability
This endpoint allows you to check the availability of an Freight LTL pickup service. The pickup availability depends on two factors, the cut off time and the access time.
Cut off time - The latest time allowed for a pickup to be scheduled. The time is local to the pickup postal code.
Access time - The time between the pickup ready time (when the package is ready to be picked) and the time when the driver is ready to pick up the package.
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-FreightPickupAvailability
- MinimumSamplePayload-FreightPickupAvailability
| pickupAddress required | object (PickupAddress) The address for which pickup availability inquiry is made. |
| packageReadyTime | string The time that the package will be ready for pickup. The time format is HH:MM:SS and it refers to the local timezone. The driver should pick up the package/shipment by the given pickup time. |
| customerCloseTime | string The latest time the driver gets access to pick up the package. The time format is in HH:MM:SS and it refers to the local timezone. The driver should pick up the package by the given pickup time. |
| shipmentAttributes | object (ShipmentAttributes) Indicates the shipment details such as service type, packaging type, weight and dimensions. |
| freightPickupSpecialServiceDetail | object (FullSchemaFreightPickupAvailability_freightPickupSpecialServiceDetail) |
| dispatchDate | string Indicates the date, the package is to be picked up. The format is YYYY-MM-DD. If the field is left blank, the system considers current date as dispatch date. |
| numberOfBusinessDays | integer <int32> Number of business days to consider when checking availability. |
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
- "pickupAddress": {
- "streetLines": [
- "123 Ship Street"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "packageReadyTime": "15:30:00",
- "customerCloseTime": "18:00:00",
- "shipmentAttributes": {
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "weight": {
- "units": "KG",
- "value": 20
- "packagingType": "YOUR_PACKAGING",
- "dimensions": {
- "length": 7,
- "width": 8,
- "units": "CM",
- "height": 9
- "freightPickupSpecialServiceDetail": {
- "shipmentSpecialServicesRequested": {
- "freightGuaranteeDetail": {
- "time": "10:00"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "BASIC",
- "transportationType": "DELIVERY",
- "emailAddress": "a@fedex.com",
- "phoneNumberDetails": [
- {
- "phoneNumber": "XXXXXXXX43",
- "phoneNumberType": "WORK"
- "specialServiceTypes": [
- "FOOD",
- "POISON",
- "OVER_LENGTH",
- "EXTREME_LENGTH",
- "LIFTGATE_PICKUP",
- "LIFTGATE_DELIVERY"
- "dispatchDate": "2019-10-14",
- "numberOfBusinessDays": 1
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "closeTime": "12:00:00-05:00",
- "closeTimeType": "DEFAULT",
- "localTime": "19:20",
- "options": [
- {
- "carrier": "FXFR",
- "available": true,
- "pickupDate": "2019-01-20",
- "cutOffTime": "18:30:00",
- "accessTime": {
- "hours": 1,
- "minutes": 30
- "residentialAvailable": true,
- "scheduleDay": "SAME_DAY"
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
Create Freight LTL Pickup
This endpoint helps you to create a freight pickup request for a package to be picked up.
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-CreatePickup
- MinimumSamplePayload-CreateFreightPickup
- MinimumSamplePayload-FreightBillToPickup
| associatedAccountNumber required | object The associated account number, which is invoiced for the freight pickup. |
| originDetail required | object The origin address if different than the one associated with the shipper account. This element value is required when the package is to be picked up from an address other than the shipper account address. |
| totalWeight | Array of objects (TotalWeight) The total weight of the packages for the pickup. Unit of measure is LB and KG. |
| packageCount | integer <int32> The total number of packages for the pickup. |
| remarks | string This is a placeholder for any message to be passed to the FedEx pickup. courier. |
| countryRelationships | string Enum: "DOMESTIC" "INTERNATIONAL" Describes the country relationship among the shipments being picked up. |
| trackingNumber | string This is a tracking number for FedEx packages used for tracking a single package or group of packages. |
| commodityDescription | string Description of the commodity being shipped. |
| freightPickupDetail required | object This provides the Freight LTL pickup detailed information. |
| oversizePackageCount | integer <int32> The number of oversize packages that are tendered to FedEx Ground. |
| pickupNotificationDetail | object This object allows user to request for pickup confirmation email. User can specify upto 5 email addresses. |
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
- "associatedAccountNumber": {
- "value": "Your account number"
- "originDetail": {
- "pickupAddressType": "ACCOUNT",
- "pickupLocation": {
- "contact": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "phone extension"
- "address": {
- "streetLines": [
- "123 Ship Street",
- "Suite 302"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "accountNumber": {
- "value": "XXX289837"
- "deliveryInstructions": "deliveryInstructions"
- "readyDateTimestamp": "2020-04-02T11:00:00Z",
- "customerCloseTime": "18:00:00",
- "pickupDateType": "SAME_DAY",
- "packageLocation": "FRONT",
- "buildingPart": "APARTMENT",
- "buildingPartDescription": "111",
- "earlyPickup": false,
- "suppliesRequested": "Supplies requested by customer",
- "geographicalPostalCode": "geographicalPostalCode"
- "totalWeight": [
- {
- "units": "LB",
- "value": 1
- "packageCount": 5,
- "remarks": "Please ring bell at loading dock.",
- "countryRelationships": "DOMESTIC",
- "trackingNumber": "795803657326",
- "commodityDescription": "This field contains CommodityDescription",
- "freightPickupDetail": {
- "accountNumber": {
- "value": "Freight Account Number"
- "role": "SHIPPER",
- "payment": "SENDER",
- "submittedBy": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "string",
- "emailAddress": "sample@company.com"
- "lineItems": [
- {
- "trackingNumber": {
- "trackingNumber": "123456789012",
- "trackingQualifier": "insightBest~200300400525~FDFR",
- "trackingCarrier": "FDXE",
- "trackingUniqueId": "245822~123456789012~FDEG"
- "service": "FEDEX_FREIGHT_PRIORITY",
- "sequenceNumber": 2,
- "totalHandlingUnits": 2,
- "justOneMore": false,
- "description": "strings",
- "packaging": "BUNDLE",
- "pieces": 4,
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 7,
- "width": 8,
- "height": 9,
- "units": "CM"
- "destination": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "shipmentSpecialServicesRequested": {
- "freightGuaranteeDetail": {
- "time": "10:00"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "BASIC",
- "transportationType": "DELIVERY",
- "emailAddress": "a@fedex.com",
- "phoneNumberDetails": [
- {
- "phoneNumber": "XXXXXXXX43",
- "phoneNumberType": "WORK"
- "specialServiceTypes": [
- "FOOD",
- "POISON",
- "OVER_LENGTH",
- "EXTREME_LENGTH",
- "LIFTGATE_PICKUP",
- "LIFTGATE_DELIVERY"
- "alternateBilling": {
- "contact": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "phone extension"
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "accountNumber": {
- "value": "Alternate Billing Account Number"
- "deliveryInstructions": "deliveryInstructions"
- "userMessage": "This is the user message"
- "oversizePackageCount": 2,
- "pickupNotificationDetail": {
- "emailDetails": [
- {
- "address": "sample@gmail.com",
- "locale": "en_US"
- "format": "HTML",
- "userMessage": "This is the user message"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "pickupConfirmationCode": "20201012COS455402",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
Cancel Freight LTL Pickup
Use this endpoint to cancel the already scheduled freight pickup request. Note a failure notification will be sent if you attempt to cancel a pickup after the FedEx courier has been dispatched to the pickup location.
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-CancelFreightPickup
- MinimumSamplePayload-FreightCancel
| associatedAccountNumber required | object (AccountNumber_2) Specify the FedEx Account number. |
| pickupConfirmationCode required | string The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested. |
| remarks | string Specify the additional information to be passed on the pickup courier. |
| reason required | string Specify the reason for cancellation of pickup. |
| contactName required | string Specify the contact name. |
| scheduledDate | string Specifies the date when pickup dispatch occurs. |
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
- "associatedAccountNumber": {
- "value": "Your account number"
- "pickupConfirmationCode": "20201007MEM628005",
- "remarks": "This is my remarks",
- "reason": "This is my reason",
- "contactName": "This is my contactName",
- "scheduledDate": "2019-10-15"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "pickupConfirmationCode": "20201007MEM628005",
- "cancelConfirmationMessage": "Requested pickup has been cancelled Successfully.",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
