Open Ship API

Úvod

Toto rozhraní API umožňuje vytvořit otevřenou zásilku a přidávat do ní balíky v průběhu určitého časového období, místo abyste zadávali všechny informace o zásilce a balíku najednou. Zásilka zůstane otevřená po dobu 5 dnů a během této doby povoluje přidávání a úpravy balíků. Jakmile je zásilka potvrzena, lze vygenerovat přepravní dokumenty, jako jsou štítky, AWB (letecký nákladní list) nebo reporty. Na konci pátého dne musí být zásilka potvrzena, jinak bude vyprázdněna.

Poznámka: Otevřené zásilky budou vymazány, pokud nebudou potvrzeny do konce pátého dne od vytvoření zásilky.

Podrobnosti o otevřeném API zásilky

Otevřené API zásilky se používá v případě, že chcete do zásilky přidat více balíků v určitém časovém období a nejste si jisti, kolik balíků plánujete přidat nebo kdy bude zásilka dokončena. Díky tomu můžete zásilku flexibilně připravovat v průběhu celého dne, dokud není připravena k odeslání.

Otevřené zásilky jsou často vícekusové zásilky, ale mohou to být i zásilky s jedním balíkem, označované jako jednokusové zásilky.

Chcete-li odeslat vícekusovou zásilku (MPS) jednomu příjemci, použijte otevřené API zásilky a přidejte do zásilky jednotlivé balíky nebo přidejte více balíků, pokud jsou určeny stejnému příjemci.

Služby spojené s otevřenými zásilkami:

FedEx Express^® v rámci USA a v rámci Kanady
FedEx Ground^® v rámci USA a v rámci Kanady
FedEx Home Delivery^®
FedEx International Priority^®
FedEx International Priority^® Express (IPE)
FedEx International Economy^®
FedEx Priority Overnight^TM
FedEx® Regional Economy
FedEx® Regional Economy Freight
FedEx International Connect Plus®
FedEx® First
FedEx Priority Express
FedEx Priority
FedEx Priority Express Freight
FedEx Priority Freight
FedEx Economy (pouze pro Spojené království)

Otevřené API zásilky je spojeno s následujícími funkcemi:

Správa otevřených zásilek

Tato funkce umožňuje odesílatelům vytvářet, upravovat a odstraňovat otevřené zásilky a může načíst již vytvořené otevřené zásilky pro účely kontroly nebo ověření. Umožňuje potvrdit dokončenou zásilku, přenést údaje o zásilce společnosti FedEx a vytvořit příslušné doklady o zásilce. Také identifikuje a nahlašuje případné chyby v transakci a poskytuje příslušný status.

Klíčovými informacemi v této funkci jsou accountNumber, údaje o zásilce, groupPackageCount, index pro označení hlavního balíku v zásilce. Výsledkem této funkce je zajištění odeslání dat o zásilce do systémů FedEx a vytvoření příslušných sledovacích čísel, štítků a reportů o zásilkách.

Správa balíků otevřených zásilek

Tato funkce vám umožňuje přidávat, upravovat a odstraňovat balíky v již vytvořené otevřené zásilce. Lze také načíst existující balík pro existující otevřenou zásilku.

Získání výsledků otevřené zásilky (asynchronní)

Tato funkce umožňuje asynchronní načítání potvrzených výsledků zásilek. Když je potvrzena otevřená zásilka se 40 nebo více balíky, rozhraní API zpracuje zásilku asynchronně.

Pokud je zásilka zpracovávána asynchronně, odpověď na tento požadavek pouze potvrzuje, že požadavek byl úspěšně zařazen do fronty, ačkoli zásilka nemusí být úspěšně zpracována. Jako odpověď vrátí jobId pro pozdější načtení výsledku. Tato funkce používá jobId k načtení výsledků otevřené zásilky (VYTVOŘIT, UPRAVIT A POTVRDIT), což mohou být přepravní štítky, reporty o zásilce. Také identifikuje a nahlašuje případné chyby v zásilce a poskytuje příslušný status.

Poznámka: Pokud se v asynchronní odpovědi na zásilku vyskytnou chyby, opravte je a odešlete novou žádost o odeslání zásilky.

Pracovní postupy otevřeného API zásilky

V této části jsou podrobně popsány pracovní postupy otevřeného API zásilky. Pracovní postupy pro otevřené zásilky jsou spravovány dvěma způsoby nebo s použitím dvou možností zpracování:

Pracovní postup pro 40 a méně balíků

Použijte koncový bod Vytvořit otevřenou zásilku k vytvoření otevřené zásilky se všemi požadovanými informacemi o přepravě a balení a hodnotách accountNumber a index.
Použijte koncový bod Přidat balíky otevřené zásilky pro přidání jednoho nebo více (ne více než 40) balíků do již vytvořené otevřené zásilky. Klíčovými vstupy jsou index a accountNumber otevřené zásilky, do které jsou balíky přidávány.
Použijte koncový bod Potvrdit otevřenou zásilku ke konečnému potvrzení, že všechny balíky byly přidány a zásilka je kompletní. Klíčovými vstupy pro potvrzení zásilky jsou index a accountNumber.

Koncový bod Potvrdit otevřenou zásilku je posledním koncovým bodem tohoto pracovního postupu, který ověřuje informace o zásilce a balících a úspěšně vytváří štítky a další reporty pro zásilku. Také poskytuje podrobnosti o chybách vrácených během ověřování. Tyto chyby lze opravit pomocí koncových bodů Upravit otevřenou zásilku nebo Upravit balíky otevřené zásilky a opětovným potvrzením zásilky pro úspěšný požadavek.

Pracovní postup pro více než 40 balíků

Použijte koncový bod Vytvořit otevřenou zásilku k vytvoření otevřené zásilky se všemi požadovanými informacemi o přepravě a balení a hodnotách accountNumber a index.
Použijte koncový bod Přidat balíky otevřené zásilky pro přidání jednoho nebo více (ne více než 40) balíků do již vytvořené otevřené zásilky. Klíčovými vstupy jsou index a accountNumber otevřené zásilky, do které mají být balíky přidány.
Použijte koncový bod Potvrdit otevřenou zásilku k potvrzení, že všechny balíky byly přidány a zásilka je kompletní. Klíčovými vstupy pro potvrzení zásilky jsou index a accountNumber. Protože je v tomto případě více než 40 balíků, rozhraní API zpracovává zásilku asynchronně a vrací jobId pro pozdější použití k načtení výsledků zásilky. Pokud obsahuje odpověď chyby, musí být tyto chyby opraveny s použitím koncových bodů Upravit otevřenou zásilku nebo Upravit balíky otevřené zásilky a potvrzením zásilky s použitím koncového bodu Potvrdit otevřenou zásilku.
Použijte koncový bod Získat výsledky otevřené zásilky k načtení výsledků Vytvořit, Upravit a Potvrdit otevřené zásilky, jako jsou přepravní štítky a přepravní dokumentace. Klíčovými vstupy pro potvrzenou zásilku jsou jobId a accountNumber.

Koncový bod Získat výsledky otevřené zásilky je posledním koncovým bodem tohoto pracovního postupu, který načítá potvrzené výsledky otevřené zásilky, jako jsou štítky a další reporty pro potvrzenou otevřenou zásilku. Pokud jsou v odpovědi vráceny podrobnosti o chybách, lze tyto chyby opravit s použitím koncových bodů Upravit otevřenou zásilku nebo Upravit balíky otevřené zásilky, poté potvrďte zásilku s použitím koncového bodu Potvrdit otevřenou zásilku a nakonec použijte koncový bod Získat výsledky otevřené zásilky k načtení potvrzených výsledků otevřené zásilky pro úspěšný požadavek.

Jak otevřené API zásilky funguje

Otevřené API zásilky je spojeno s následujícími funkcemi:

Vytvořit otevřenou zásilku

Tento koncový bod použijte k vytvoření otevřené zásilky s požadovanými informacemi o zásilce a definujte alespoň jeden balík v zásilce.

Požadované vstupní informace pro vytvoření otevřené zásilky:

openShipmentAction – Jedná se o akci otevřené zásilky a v tomto případě použijte hodnotu jako CREATE_PACKAGE.
accountNumber – Číslo účtu FedEx.
requestedShipment – Údaje o otevřené zásilce.
index – Jedinečná hodnota pro otevřenou zásilku. Tato hodnota je užitečná při úpravách zásilky nebo balíku. Hodnota je volitelná. Pokud není poskytnuta, pro jedinečnou identifikace zásilky lze použít hlavní sledovací číslo.

Úspěšná odpověď na tento požadavek zpracuje zásilku a vytvoří sledovací číslo, které je hlavním sledovacím číslem prvního balíku. Mějte na paměti, že v této odpovědi nebudou vytvořeny žádné štítky.

Přidat balíky otevřené zásilky

Tento koncový bod slouží k přidání jednoho nebo více balíků do stávajícího požadavku otevřené zásilky před potvrzením zásilky. Pro každý z balíků můžete při přípravě zásilky během dne odeslat samostatný požadavek na přidání balíku. V rámci požadavku na přidání balíku můžete také odeslat více kusů.

Poznámka: Celkový počet balíků zásilky nesmí překročit limit balíků pro otevřené zásilky.

Požadované vstupní informace pro přidání balíků do otevřené zásilky:

index – Jedinečná hodnota přiřazená k již vytvořené otevřené zásilce. Pokud není k dispozici, zadejte hlavní sledovací číslo.
requestedPackageLineItem – Podrobné informace o balících, které mají být přidány.
accountNumber – Číslo účtu FedEx.

Úspěšná odpověď na tento požadavek vytvoří sledovací číslo pro nově přidaný balík.

Upravit balíky otevřené zásilky

Tento koncový bod slouží k úpravě údajů o jednom nebo více balících z již existující otevřené zásilky před jejím potvrzením. To zahrnuje i hlavní balík, což je první balík přidaný do otevřené zásilky.

Níže jsou uvedeny požadované vstupní informace spojené s tímto požadavkem:

index – Jedinečná hodnota přiřazená k již vytvořené otevřené zásilce. Pokud není k dispozici, zadejte hlavní sledovací číslo.
accountNumber – Číslo účtu FedEx.
trackingId – ID pro sledování jednoho nebo více balíků otevřené zásilky, které mají být upraveny.
requestedPackageLineItem – Podrobné informace o balících, které mají být upraveny.

Úspěšný požadavek aktualizuje příslušné balíky a vrátí aktualizované údaje o zásilce.

Odstranit balíky otevřených zásilek

Tento koncový bod slouží k odstranění jednoho nebo více balíků z již vytvořené otevřené zásilky před jejím potvrzením.

Níže jsou uvedeny požadované vstupní informace spojené s tímto požadavkem:

index – Jedinečná hodnota přiřazená k již vytvořené otevřené zásilce. Pokud není k dispozici, zadejte hlavní sledovací číslo.
accountNumber – Číslo účtu FedEx.
trackingId – Id pro sledování jednoho nebo více balíků otevřené zásilky, pro které byl přijat požadavek na odstranění.

Úspěšný požadavek odstraní příslušné balíky a ve výstupu vrátí stav prvku deletedPackagesFromOpenshipment jako true.

Poznámka: Pokud je hlavní balík v zásilce odstraněn, stane se hlavním balíkem další balík v pořadí a hlavní sledovací číslo je mu znovu přiděleno a pořadové číslo se sníží o počet odstraněných balíků.

Načtení balíku otevřené zásilky

Tento koncový bod slouží k načtení jednoho nebo více balíků z již vytvořené otevřené zásilky za účelem kontroly nebo ověření.

Níže jsou uvedeny požadované vstupní informace spojené s tímto požadavkem:

index – Jedinečná hodnota přiřazená k již vytvořené otevřené zásilce. Pokud není k dispozici, zadejte hlavní sledovací číslo.
accountNumber – Číslo účtu FedEx.
trackingId – Id pro sledování jednoho nebo více balíků otevřené zásilky, pro které mají být načteny podrobnosti.

Úspěšný požadavek načte zamýšlené balíky.

Upravit otevřené zásilky

Tento koncový bod slouží k úpravě požadavku otevřené zásilky s požadovanými přepravními údaji před jejím potvrzením.

Níže jsou uvedeny požadované vstupní informace spojené s tímto požadavkem:

index – Jedinečná hodnota přiřazená k již vytvořené otevřené zásilce. Pokud není k dispozici, zadejte hlavní sledovací číslo.
accountNumber – Číslo účtu FedEx.
requestedShipment – Údaje o zásilce, pro které se upravuje otevřená zásilka.

Úspěšný požadavek aktualizuje údaje o zásilce již vytvořené otevřené zásilky a jako výstup vrátí sledovací číslo upraveného balíku (balíků) a aktualizované údaje o transakci.

Načíst otevřenou zásilku

Tento koncový bod slouží k načtení již vytvořené otevřené zásilky ke kontrole nebo ověření.

Níže jsou uvedeny požadované vstupní informace spojené s tímto požadavkem:

index – Jedinečná hodnota přiřazená k již vytvořené otevřené zásilce. Pokud není k dispozici, zadejte hlavní sledovací číslo.
accountNumber – Číslo účtu FedEx.

Úspěšný požadavek načte zamýšlené údaje o otevřené zásilce.

Odstranit otevřenou zásilku

Tento koncový bod slouží k odstranění požadavku otevřené zásilky před jejím potvrzením.

Níže jsou uvedeny požadované vstupní informace spojené s tímto požadavkem:

index – Jedinečná hodnota přiřazená k již vytvořené otevřené zásilce. Pokud není k dispozici, zadejte hlavní sledovací číslo.
accountNumber – Číslo účtu FedEx.

Úspěšný požadavek odstraní otevřenou zásilku a všechny přidružené balíky a ve výstupu vrátí stav prvku deletedOpenshipment jako true.

Potvrdit otevřenou zásilku

Tento koncový bod slouží k ověření a nahrání dat otevřené zásilky do systémů společnosti FedEx, jakmile jsou v požadavku na zásilku přidány všechny balíky.

Níže jsou uvedeny požadované vstupní informace spojené s tímto požadavkem:

index – Jedinečná hodnota přiřazená k již vytvořené otevřené zásilce. Pokud není k dispozici, zadejte hlavní sledovací číslo.
accountNumber – Číslo účtu FedEx.
labelResponseOptions – Určuje, zda má být v odpovědi vrácen kódovaný bajtový kód nebo adresa URL štítku.
Poznámka: Prvek labelResponseOptions je k dispozici pouze v žádosti o potvrzení otevřené zásilky a po potvrzení zásilky se vygenerují přepravní štítky.

Úspěšná potvrzovací odpověď pro 40 a méně balíků nahraje data o zásilce do systémů společnosti FedEx a vytvoří štítky balíků a všechny další reporty o zásilce.

Úspěšná potvrzovací odpověď pro více než 40 balíků potvrzuje, že byl požadavek úspěšně přidán do fronty, a vrací jobId pro pozdější načtení výsledku.

Poznámka: Před potvrzením zásilky musí být do otevřené zásilky přidána minimálně jedna zásilka.

Získat výsledky otevřené zásilky

Tento koncový bod slouží k získání potvrzených údajů o otevřené zásilce. Tento koncový bod může být použit pouze v případě, že zásilka má více než 40 balíků a při potvrzení otevřené zásilky je vráceno jobId.

Níže jsou uvedeny požadované vstupní informace spojené s tímto požadavkem:

resultMethodType – Určete hodnotu jako CREATE.
accountNumber – Číslo účtu FedEx.
jobId – jobId obdržené během potvrzení otevřené zásilky.

Úspěšná odpověď na tento požadavek vrátí výsledky potvrzené otevřené zásilky, jako jsou štítky balíků a všechny ostatní reporty o zásilkách pro potvrzenou otevřenou zásilku. Pokud jsou v odpovědi vráceny podrobnosti o chybách, lze tyto chyby opravit s použitím koncových bodů Upravit otevřenou zásilku nebo Upravit balíky otevřené zásilky, poté potvrďte zásilku s použitím koncového bodu Potvrdit otevřenou zásilku a nakonec použijte koncový bod Získat výsledky otevřené zásilky k načtení potvrzených výsledků otevřené zásilky pro úspěšný požadavek.

Vícekusové otevřené zásilky (MPS)

Vícekusová otevřená zásilka (MPS) se skládá ze dvou nebo více balíků zaslaných na stejnou adresu příjemce. První balík v žádosti o odeslání zásilky je považován za hlavní balík.

Vytvoření vícekusové zásilky:

Uveďte informace na úrovni zásilky, jako jsou serviceType, packagingType, totalWeight, totalPackageCount, a requestedPackageLineItems, pro hlavní balík.Poznámka: Hodnota sequenceNumber pro hlavní balík se musí rovnat 1.
Přidejte všechny balíky do zásilky.
Potvrďte zásilku.

Po potvrzení zásilky se použije jedna z níže uvedených možností zpracování:

Synchronní zpracování zásilek

Synchronní zpracování je jednou z optimálních metod zpracování, která se interně používá, pokud má zásilka 40 nebo méně balíků (celkový počet balíků / grouppackagecount<=40) s omezeným počtem komodit v zásilce.

Požadavky na zásilky se 40 nebo méně balíky budou při potvrzení zpracovány synchronně a štítky a další dokumenty/reporty o zásilkách budou vytvořeny okamžitě. Tento postup je optimální pro odesílatele, kteří jsou omezeni časem a potřebují štítky vytisknout okamžitě po potvrzení zásilky.

Poznámka: Maximální limit 40 balíků je orientační a není pevně stanoven. Limit závisí také na kombinaci balíků a komodit v zásilce. Chcete-li získat další informace, kontaktujte tým podpory společnosti FedEx.

Příklad: Váš požadavek otevřené zásilky se skládá z 10 balíků. Při potvrzení zásilky po přidání všech 10 balíků bude zásilka zpracována synchronně. Vytvoří se 10 štítků a v odpovědi budou uvedeny buď adresy URL štítků, nebo zakódované štítky (podle požadavku).

Následující pracovní postup vysoké úrovně demonstruje synchronní zpracování otevřených zásilek:

Použijte koncový bod Vytvořit otevřenou zásilku.
Přidejte 1–40 balíků s použitím koncového bodu Přidat balíky otevřené zásilky
Použijte koncový bod Potvrdit otevřenou zásilku k potvrzení otevřené zásilky.
Úspěšná žádost by měla vytvořit štítky a výstupní odpověď bude obsahovat buď adresy URL štítků, nebo zakódované štítky (podle požadavku).
Pokud zásilka obsahuje chyby, v odpovědi budou uvedeny podrobnosti o chybách.
Po opravě všech chyb použijte koncový bod Potvrdit otevřenou zásilku pro úspěšnou odpověď.

Poznámka:

Pokud potřebujete přidat další balíky ke stávající zásilce, můžete při použití této metody přidat maximálně 40 balíků.

Asynchronní zpracování zásilek

Pokud je celkový počet balíků vyšší než 40 (tj. totalPackageCount>40), rozhraní API zpracuje zásilku asynchronně. Jedná se o velmi praktickou metodu, pokud je objem balíků velký a chcete pravidelně odesílat hromadné zásilky. Toto hromadné podání zásilek využívá různé nákladné zdroje a operace společnosti FedEx, pokud je podáno najednou. Díky této možnosti zpracování společnost FedEx interně zajišťuje snadné zpracování těchto hromadných zásilek a vy můžete pravidelně získávat údaje o štítcích.

Pokud je zásilka zpracována asynchronně, odpověď na tuto žádost pouze potvrdí, že žádost byla úspěšně zařazena do fronty, ačkoli samotná zásilka nemusí být úspěšně zpracována, a vrátí jobId pro pozdější načtení výsledku.

Poznámka: Tento proces vyžaduje určitý čas na úspěšné zpracování zásilky, než získáte výsledek.

Pro načtení výsledku asynchronního zpracování zásilky použijte koncový bod Získat výsledky otevřené zásilky a v požadavku uveďte podrobnosti jobId a accountNumber. Odpověď na tuto žádost vrátí buď údaje o výsledku zásilky s podrobnostmi o štítku, nebo údaje o chybě zásilky.

Příklad: Vaše zásilka se skládá z 45 balíků, po potvrzení bude zpracována asynchronně. V odpovědi bude vráceno jobId. Použijte koncový bod Získat výsledky otevřené zásilky k načtení výsledků zásilky a údajů o štítku.

Následující pracovní postup vysoké úrovně demonstruje asynchronní zpracování zásilek:

Použijte koncový bod Vytvořit otevřenou zásilku.
Přidejte 40 nebo více balíků s použitím koncového bodu Přidat balíky otevřené zásilky.
Použijte koncový bod Potvrdit otevřenou zásilku k potvrzení zásilky.
Po úspěšném odeslání získáte jobId.
Použijte jobId a accountNumber k načtení výsledků výstupu s použitím koncového bodu Získat výsledky otevřené zásilky.
Úspěšný výstup poskytne údaje výsledku zásilky s podrobnostmi o štítku.
Pokud výsledek obsahuje chyby, v odpovědi budou uvedeny podrobnosti o chybách.

Poznámka:

Při použití této metody je v jednom požadavku povolen maximální celkový počet balíků 300 nebo až 999 komodit.
Při použití této metody nelze po odeslání požadavku přidávat nové balíky do původního požadavku ani je upravovat a odstraňovat. Pokud jsou v odpovědi chyby, opravte je s použitím koncového bodu Upravit balíky otevřené zásilky, poté potvrďte zásilku s použitím koncového bodu Potvrdit otevřenou zásilku a získejte úspěšné výsledky výstupu s použitím koncového bodu Získat výsledky otevřené zásilky.

Přepravní štítky FedEx

Otevřené API zásilky společnosti FedEx podporuje širokou škálu štítků. Otevřené API zásilky FedEx podporuje tři možnosti typů štítků, včetně termálních štítků, štítků na obyčejném papíru a přizpůsobitelných štítků. Koncové body otevřeného API zásilky můžete použít k vytvoření široké škály štítků.

Společnost FedEx nabízí 2 formáty štítků pro podporu přepravních služeb:

Termální štítky
Laserové štítky

Termální štítky

Rozhraní API společnosti FedEx vám umožňuje tisknout přepravní štítky pro všechny typy služeb, jako jsou FedEx Express^®, FedEx Ground^® a FedEx International Ground^®, s využitím tiskáren termálních štítků.

Rozhraní API společnosti FedEx podporuje následující velikosti termálních štítků:

4'' x 6'' – bez konfigurovatelné karty dokumentu (Doc-Tab)
4'' x 6,75'' – s konfigurovatelnou kartou dokumentu nebo bez ní
4'' x 8'' – nabízí prostor pro zahrnutí grafického nebo textového souboru dle vašeho výběru
4'' x 8,5'' – s konfigurovatelnou kartou dokumentu (určeno speciálně pro identifikační štítek pneumatiky)
4'' x 9'' – nabízí prostor pro grafiku nebo text a také Doc-Tab
4'' x 10,5'' – s konfigurovatelnou kartou dokumentu (určeno speciálně pro identifikační štítek pneumatiky)

Typy zásoby štítků 4"X8,5” a 4"X10.5” obsahují kartu přiloženou k dokumentu s identickými čárovými kódy. Jeden čárový kód se zobrazí na hlavním štítku a druhý na kartě dokumentu. Tato hodnota typu zásoby štítků je užitečná pro zásilky pneumatik, protože jeden štítek může být umístěn na běhounu pneumatiky a další štítek s kartou dokumentu s duplikátem čárového kódu a provozními pokyny na bočnici pneumatiky. Používáním těchto typů štítků se snižuje počet přelepených přepravních štítků na pneumatikách a zvýšený počet rozměrových skenů optimalizuje jejich využití. Další informace o štítcích najdete ve webové záložce Typy štítků.

Poznámka: Doc-Tab je odnímatelná lepící karta s dodatečnými přepravními údaji, které lze vybrat pro zásobu štítků během tisku přepravních štítků s použitím termální tiskárny.

Prvky termálního štítku

Termální přepravní štítky obsahují tři základní prvky:

Obsah čitelný lidským okem: Tato část štítku obsahuje přepravní údaje.
Čárový kód Ground čitelný lidským okem bude standardně šifrován.
Dvourozměrný(2D) čárový kód: Dvourozměrný alfanumerický čárový kód obsahuje data pro zásilky FedEx Express a FedEx Ground s využitím standardu MH10.8.3 institutu ANSI (American National Standards Institute). 2D čárový kód je vytvořen s použitím symbolů 417 formátu PDF (Portable Data File).
Specifický čárový kód FedEx:
- ASTRA (Advanced Sorting Tracking Routing Assistance) pro zásilky FedEx Express, dokud nebude plně zaveden čárový kód FDX 1D; čárový kód 96 pro zásilky FedEx Ground a FedEx Home Delivery. FedEx Ground také umožňuje použití čárového kódu SSCC-18 00.
- Čárový kód FedEx 1D (FDX1D) pro zásilky FedEx Express je vytvářen pomocí kódu ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C).

Klíčové informace při vytváření termálního štítku

Klíčové informace vyžadované pro vytvoření termálního štítku:

LabelFormatType: Vyžadováno pro obdržení správného obrázku štítku v rozhraní API pro odpověď na otevřenou zásilku:
- COMMON2D: Typ formátu štítku pro obdržení štítku.
- LABEL_DATA_ONLY: Hodnota používaná k získání dat čárového kódu, pokud vytváříte vlastní štítek.

Platné hodnoty:

ImageType: Vyžadováno pro formátování termálního štítku pro používanou tiskárnu; nabízí typ toku dat nebo rastru, který má být vrácen.
- EPL2 – Eltron (typy zásoby štítků)
- ZPLII – Zebra (typy zásoby štítků)

Platné hodnoty:

Poznámka: Všechny štítky vyžadované pro zásilku jsou vytvářeny a vraceny v rámci jedné transakce.

Podporované termální tiskárny

Pro použití s rozhraním API společnosti FedEx se doporučují následující termální tiskárny:

Unimark
Eltron
- Orion (EPL2)
- Eclipse (EPL2)
Zebra
- LP2443 (EPL2)
- LP2844 (EPL2)
- Gk420 (ZPL)
- LP2348 Plus (EPL2/ZPL)
- Z4M Plus (ZPL or EPL)
- ZP500/ZP505 (EPL2/ZPL)
- Z4M/Z4M+ (EPL2/ZPL)
- ZM400 (EPL2/ZPL)
- ZT410 (EPL2/ZPL)
- Další tiskárny série ZT4xx (EPL2/ZPL)

Poznámka: Tyto tiskárny jsou všechny kompatibilní s režimem stránky ASCII EPL2 (Eltron Programming Language). Termální tiskárny jsou podporovány jako přímé zápisy do systémového sériového portu a jaké nainstalované tiskárny nativní pro Windows pro připojení LPT, Serial nebo USB. Verze firmwaru tiskáren poskytovaných společností FedEx se mohou v jednotlivých regionech lišit.

Počet vytištěných termálních štítků na službu

Následující tabulka uvádí počet štítků jednotlivých typů potřebný pro konkrétní speciální služby. Všechny nezbytné štítky jsou vytvořeny po volání serveru FedEx Common Label Server (CLS). Server CLS vrátí jednu transakci s výjimkou štítku pro vrácení s možností dobírky.

Počet vytištěných termálních štítků na službu v rámci USA

Typ služby	Termální štítky (server FedEx CLS vrátí příslušný počet štítků)
FedEx Express U.S.	1 přepravní štítek
FedEx Ground U.S. / FedEx Home Delivery	1 přepravní štítek

Počet vytištěných termálních štítků na službu U.S. Export International

Typ služby	Termální štítky (server FedEx CLS vrátí příslušný počet štítků)
FedEx Express U.S. Export International	1 přepravní štítek 2 štítky pro příjemce
FedEx Express U.S. Export International možnost výběru celního brokera	1 přepravní štítek 2 štítky pro příjemce
FedEx Ground U.S. Export International	1 přepravní štítek
FedEx Ground U.S. Export International dobírka	1 přepravní štítek 2 štítky pro vrácení s možností dobírky

Počet vytištěných termálních štítků na službu v rámci Kanady

Typ služby	Termální štítky (server FedEx CLS vrátí příslušný počet štítků)
FedEx Express v rámci Kanady	Bez nebezpečného zboží / zásilka suchého ledu: 1 přepravní štítek
FedEx Ground v rámci Kanady	1 přepravní štítek
FedEx Ground v rámci Kanady (dobírka)	1 přepravní štítek 2 štítky pro vrácení s možností dobírky

Počet vytištěných termálních štítků na službu Canada Export International

Typ služby	Termální štítky (server FedEx CLS vrátí příslušný počet štítků)
FedEx Express Canada Export International	Bez nebezpečného zboží / zásilka suchého ledu: 1 přepravní štítek 2 štítky pro příjemce
FedEx Express Canada Export International možnost výběru celního brokera	Bez nebezpečného zboží / zásilka suchého ledu: 1 přepravní štítek 2 štítky pro příjemce
FedEx Ground Canada (CA) Export International	1 přepravní štítek

Počet vytištěných termálních štítků na příchozí zásilky na Filipíny a do Thajska

Typ služby	Termální štítky (server FedEx CLS vrátí příslušný počet štítků)
Příchozí zásilky na Filipíny	2 přepravní štítky s vytištěným číslem účtu 1 štítek pro příjemce bez vytištěného čísla účtu 3 kopie obchodní faktury
Příchozí zásilky komodit do Thajska	3 přepravní štítky s vytištěným číslem účtu 1 štítek pro příjemce bez vytištěného čísla účtu
Příchozí dokumentové zásilky do Thajska	2 přepravní štítky s vytištěným číslem účtu 1 štítek pro příjemce bez vytištěného čísla účtu

Doc-Tab

Pokud tisknete přepravní štítky pomocí termální tiskárny, můžete si vybrat štítky, které obsahují Doc-Tab, odnímatelnou samolepicí kartu s dodatečnými přepravními informacemi. Tyto přepravní informace můžete nakonfigurovat ze svých přepravních údajů nebo se rozhodnout pro tisk konfigurovatelných údajů, které jsou specifické pro vaše přepravní potřeby.

Laserové štítky

Rozhraní API společnosti FedEx podporuje tisk štítků pomocí laserové tiskárny. Tyto štítky jsou obvykle tištěny na papíry formátu U.S. Letter nebo A4 a přeloženy, aby se vešly do standardního pouzdra na štítky společnosti FedEx. Štítky vytištěné na laserové tiskárně jsou vytvořeny ve formátu PDF a nevyžadují změnu velikosti. Další informace o zásobě štítků najdete v části Typy zásoby štítků.

Požadavky

Na štítky PDF se vztahují následující požadavky:

Pro zpracování štítků je vyžadována aplikace Adobe Reader 6.0 nebo vyšší.
Konfigurace ovladače tiskárny musí mít nastaveno škálování tiskárny na hodnotu None.
Pro zobrazení štítků PDF na obyčejném papíru v prohlížeči není nutné použít HTML wrapper.
Acrobat pro zobrazení dokumentů PDF doporučuje následující prohlížeče:
- Microsoft Internet Explorer 10 nebo vyšší
- Firefox 1.0 nebo vyšší
- Mozilla 1.7 nebo vyšší

Možnost štítku PDF eliminuje nutnost specifikovat parametr orientace obrázku (šířka a výška) nebo rozlišení obrazovky pro správné zobrazení štítku v prohlížeči.

Prvky laserového štítku

Laserové přepravní štítky obsahují tři základní prvky:

Obsah čitelný lidským okem: Tato část štítku obsahuje přepravní údaje.
Čárový kód Ground čitelný lidským okem bude standardně šifrován.
Dvourozměrný(2D) čárový kód: Dvourozměrný alfanumerický čárový kód obsahuje data pro zásilky FedEx Express a FedEx Ground s využitím standardu MH10.8.3 institutu ANSI (American National Standards Institute). 2D čárový kód je vytvořen s použitím formátu 417 PDF (Portable Data File).
Specifický čárový kód FedEx:
- ASTRA (Advanced Sorting Tracking Routing Assistance) pro zásilky FedEx Express, dokud nebude plně zaveden čárový kód FDX 1D; čárový kód 96 pro zásilky FedEx Ground a FedEx Home Delivery. FedEx Ground také umožňuje případné použití čárového kódu SSCC-18 00.
- Čárový kód FedEx 1D (FDX1D) pro zásilky FedEx Express je vytvářen pomocí kódu ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C).

Klíčové informace při vytváření laserového štítku

K vytvoření laserového štítku jsou vyžadovány následující prvky rozhraní API společnosti FedEx:

LabelSpecification/LabelFormatType: Vyžadováno pro obdržení správného obrázku štítku v rozhraní API pro odpověď na otevřenou zásilku: Platné hodnoty:
- COMMON2D: Typ formátu štítku pro obdržení štítku.
- LABEL_DATA_ONLY: Hodnota používaná k získání dat čárového kódu, pokud vytváříte vlastní štítek.

LabelSpecification/ImageType: Vyžadováno pro označení formátování štítků. Typ vráceného datového toku nebo rastru:
Platné hodnoty:
- PDF – obyčejný papír
- PNG – obyčejný papír

LabelSpecification/LabelStockType: Vyžadováno pro všechny typy štítků. Určete, zda má zásoba štítků Doc-Tab na předním nebo zadním konci štítků nebo zda nemá Doc-Tab. Při použití ImageType PDF nebo PNG tyto hodnoty zobrazují štítek v laserovém formátu:
- PAPER_4X6
- PAPER_4X8
- PAPER_4X9
- PAPER_4X675
  Tyto hodnoty zobrazují přepravní štítek na obyčejném papíru:
- PAPER_7X47
- PAPER_85X11_BOTTOM_HALF_LABEL
- PAPER_85X11_TOP_HALF_LABEL
- PAPER_LETTER

Poznámka: Pokud si vyžádáte štítek na obyčejném papíru, vrácená data je obrázek štítku šifrován kódem Base64, který musí být před zobrazením souboru štítku dekódován.

Podporované laserové tiskárny

Většina laserových tiskáren je pro tento typ štítku podporována. Štítky však nebudou přijaty, pokud budou vytištěny na inkoustové tiskárně.Poznámka: Pokud používáte barevnou laserovou tiskárnu, měla by definice barev nastavena na černou, i když má tiskárna nainstalovaný pouze černý toner.

Počet laserových štítků vyžadovaných na službu

Počet vytištěných laserových štítků na službu v rámci USA

Typ služby	Laserový štítek – formát PDF
FedEx Ground / FedEx Home Delivery U.S.	1 přepravní štítek

Počet vytištěných laserových štítků na službu U.S. Export International

Typ služby	Laserový štítek – formát PDF
FedEx Express U.S. Export International	1 přepravní štítek v odpovědi; musí být vytištěny minimálně 3 štítky – 1 štítek na balíku a 2 v pouzdře na dokumenty.
FedEx Express U.S. Export International možnost výběru celního brokera	1 přepravní štítek v odpovědi; musí být vytištěny minimálně 3 štítky – 1 štítek na balíku a 2 v pouzdře na dokumenty.
FedEx Ground U.S. Export International	1 přepravní štítek
FedEx Ground U.S. Export International dobírka	1 přepravní štítek 2 štítky pro vrácení s možností dobírky

Počet vytištěných laserových štítků na službu v rámci Mexika

Typ služby

Laserový štítek – formát PDF

FedEx Express v rámci Mexika

Bez nebezpečného zboží / zásilka suchého ledu:

1 přepravní štítek

Počet vytištěných laserových štítků na službu v rámci Kanady

Typ služby	Laserový štítek – formát PDF
FedEx Express v rámci Kanady	FedEx Express v rámci Kanady Bez nebezpečného zboží / zásilka suchého ledu: 1 přepravní štítek
FedEx Ground v rámci Kanady	1 přepravní štítek
FedEx Ground v rámci Kanady (dobírka)	1 přepravní štítek 2 štítky pro vrácení s možností dobírky

Počet vytištěných laserových štítků na službu Canada Export Int'l

Typ služby	Laserový štítek – formát PDF
FedEx Express Canada Export International	FedEx Express Canada Export International Bez nebezpečného zboží / zásilka suchého ledu: 1 přepravní štítek 2 štítky pro příjemce
FedEx Express Canada Export International možnost výběru celního brokera	FedEx Express Canada Export International možnost výběru celního brokera Bez nebezpečného zboží / zásilka suchého ledu: 1 přepravní štítek 2 štítky pro příjemce
FedEx Ground Canada (CA) Export International	1 přepravní štítek

Počet vytištěných laserových štítků na službu Canada Export Int'l

Typ služby	Laserový štítek – formát PDF
FedEx Express Canada Export International	FedEx Express Canada Export International Bez nebezpečného zboží / zásilka suchého ledu: 1 přepravní štítek 2 štítky pro příjemce
FedEx Express Canada Export International možnost výběru celního brokera	FedEx Express Canada Export International možnost výběru celního brokera Bez nebezpečného zboží / zásilka suchého ledu: 1 přepravní štítek 2 štítky pro příjemce
FedEx Ground Canada (CA) Export International	1 přepravní štítek

Počet vytištěných laserových štítků na příchozí zásilky na Filipíny a do Thajska

Typ služby	Termální štítky (server FedEx CLS vrátí příslušný počet štítků)
Příchozí zásilky na Filipíny	2 přepravní štítky s vytištěným číslem účtu 1 štítek pro příjemce bez vytištěného čísla účtu 3 kopie obchodní faktury
Příchozí zásilky komodit do Thajska	3 přepravní štítky s vytištěným číslem účtu 1 štítek pro příjemce bez vytištěného čísla účtu
Příchozí dokumentové zásilky do Thajska	2 přepravní štítky s vytištěným číslem účtu 1 štítek pro příjemce bez vytištěného čísla účtu

Vlastní štítek

FedEx umožňuje přizpůsobení štítků vytvořených společností FedEx. V uživatelské části termálních štítků můžete přidat text týkající se vaší firmy a zvolit typ čárového kódu (symbologie) používaného na dokumentech a štítcích FedEx.

Pro podporu vaší přepravní aplikace nabízí otevřené API zásilky společnosti FedEx pro otevřené zásilky dvě možnosti pro přizpůsobení přepravního štítku:

Na svou zásobu přepravních štítků umístěte grafiku PNG PAPER 7'' × 4,75''. Můžete například vytvořit seznam balení na formuláři 8-1/2'' × 11''. Jako součást tohoto formuláře můžete také umístit grafiku 7'' × 4,75'' PNG PAPER namísto vytvoření vlastního přepravního štítku.
Přidejte grafiku nebo textový soubor na termální štítek 4'' x 8'' nebo 4'' x 9''. Tato velikost štítku nabízí 2 palce místa pro vaši grafiku nebo text.

Poznámka: Obsah štítku čitelný lidským okem a čárový kód v obvyklé části štítku nelze změnit.

Vlastní štítek ověření

Můžete vytvořit jiný než přepravní vlastní štítek na úrovni balíku i zásilky a určit, které vlastní informace jsou žádoucí, jak formátovat tyto informace a kam je na vlastní štítek umístit. Vlastní štítky jsou omezeny na formát termálního štítku.

Přizpůsobení termálního štítku

Rozhraní API společnosti FedEx nabízí dva formáty termálních štítků, které můžete přizpůsobit grafickým nebo textovým souborem a předejít tak nutnosti vytvoření vlastního štítku. Tyto štítky podporují všechny přepravní služby společnosti FedEx. Tyto formáty jsou:

4'' x 8'' termální štítek bez Doc-Tab
4'' x 9'' termální štítek s Doc-Tab

Tyto typy přepravních štítků nabízejí dvoupalcovou část pro přizpůsobení. Tato možnost platí pouze pro termální štítky vytištěné na termální tiskárně nastavené na 203 DPI nebo 300 DPI.

Pravidla pro vlastní štítky

Pravidla pro používání formátů štítků:

Přizpůsobit lze pouze přepravní štítek. Pokud například vytisknete přepravní štítek 4'' x 8'' Express s logem, na sekundárních štítcích pro příjemce se nezobrazí.
Grafika nebo text pro přizpůsobení nesmí překračovat 2 palce na výšku a 4-1/2 palců na šířku.
Společnost FedEx nenabízí žádné opravy. Grafika a/nebo text se vytiskne tak, jak byly odeslány v rámci přepravní služby.
Pokud nejsou k dispozici všechny potřebné údaje pro tisk grafiky a/nebo textu (např: souřadnice X a Y), je vrácen platný přepravní štítek bez přizpůsobených údajů. Pokud se pokusíte znovu vytvořit jiný štítek s grafikou a/nebo textem, musíte zásilku reprezentovanou tímto štítkem zrušit.
Pokud při rozlišení tiskárny 203 DPI (8 bodů/mm) jde o umístění na souřadnicích X a Y, souřadnice bodu vložení je průsečíkem horního a levého okraje termálního štítku o rozměrech 4,00" x 6,75" se spodní kartou dokumentu. Pro termální štítek o rozměrech 4,00" x 6,75" s horní kartou dokumentu zvyšte hodnoty souřadnic bodu vložení Y o 164 bodů. Pro štítek o rozměrech 4,00" x 6,00" bez karty dokumentu zvyšte hodnoty souřadnic bodu vložení Y o 8 bodů. Atributy prvků termálních štítků jsou založeny na rozlišení tiskárny 203 DPI (8 bodů/mm).
Pokud při rozlišení tiskárny 300 DPI (12 bodů/mm) jde o umístění na souřadnicích X a Y, souřadnice bodu vložení je průsečíkem horního a levého okraje termálního štítku o rozměrech 4,00" x 6,75" se spodní kartou dokumentu. Pro termální štítek o rozměrech 4,00" x 6,75" s horní kartou dokumentu zvyšte hodnoty souřadnic bodu vložení Y o 246 bodů. Pro štítek o rozměrech 4,00" x 6,00" bez karty dokumentu zvyšte hodnoty souřadnic bodu vložení Y o 12 bodů. Atributy prvků termálních štítků jsou založeny na rozlišení tiskárny 300 DPI (12 bodů/mm).
Poznámka:
- Pro čárový kód FXD1D je rozměr X (šířka nejužšího pruhu symbolu) 15 mil (3 body) pro tiskárnu s rozlišením 203 DPI a 13,3 mil (4 body) pro tiskárnu s rozlišením 300 DPI.
- Pro čárový kód 2D PDF-417 je rozměr X 10 mil (2 body) pro tiskárnu s rozlišením 203 DPI. Pro získání nejbližšího ekvivalentního rozměru X pro tiskárnu s rozlišením 300 DPI je třeba použít 9,99 mil (3 body).
- V případě bloku Odesílatel/Různé v horní části štítku a bloku Reference odesílatele pod informacemi o příjemci, kde se používají velmi malá písma, musí tvůrci štítků nahlédnout do programovací příručky ZPL, aby mohli porovnat charakteristiky sad písem a vybrat ekvivalentně fungující sadu písem pro různá jiná rozlišení tiskových hlav.
Bod vložení znaku je levý horní roh prvního znaku v řetězci na horním řádku.
Omezení tiskárny vyžadují umístění počátku v levém horním kvadrantu přední strany. Proto je možné, aby údaje začínaly v přizpůsobitelné části štítku a zapisovaly se do části štítku společnosti FedEx (skutečné údaje na termálním štítku). V takovém případě bude vaše logo nebo text přepsán informacemi na štítku FedEx. Chcete-li takový přepravní štítek použít, musíte toto umístění opravit.
Přidání informací Doc-Tab na štítek o rozměrech 4'' x 9'' musí být nakonfigurováno stejným postupem jako u standardního termálního štítku Doc-Tab o rozměrech 4'' x 6''.

Poznámka: Měly by se přidávat pouze jednobarevné obrázky, protože štítky se budou tisknout černobíle.

Prvky grafických položek na vlastním štítku

Rozhraní API nabízí obrázky ve formátu PNG (Portable Network Graphic) pro štítky FedEx Express a FedEx Ground labels. Grafika ve formátu PNG je replikou termálních štítků nebo štítků na obyčejném papíru podporovaných rozhraním API. Tato možnost štítku vám umožňuje umístit grafiku ve formátu PNG na zásobu štítků, díky čemuž se předejde nutnosti vytvoření vlastního štítku.

Při použití grafiky ve formátu PNG o rozměrech 4'' x 6'' vložené do přepravního dokladu platí následující požadavky:

Zásoba štítků
Tiskárna
Škálování

Zásoba štítků

Štítky PNG 4'' x 6'' mohou být použity pouze se zásobou nalepovacích štítků. Týmy pro certifikaci štítků FedEx Ground a FedEx Express odmítnou přepravní štítky PNG o rozměrech 4'' × 6'', které nejsou v zásobě nalepovacích štítků, včetně štítků vytištěných na obyčejném papíře.

Tiskárna

Pro tisk přepravních štítků se doporučují laserové tiskárny. Inkoustové tiskárny by neměly být používány z důvodu jejich nekonzistence při vytváření snímatelných čárových kódů. Štítek PNG o rozměrech 4'' x 6'' nelze vytisknout na barevné tiskárně, pokud není specifikace barev nastavena na černou, a to ani v případě, že je v tiskárně nainstalován pouze černý toner. Toto nastavení je nezbytné pro dosažení správné definice čárového kódu pro skenování v přepravních centrech FedEx.

Škálování

Obrázek vrácený v přepravním procesu má 200 bodů na palec (DPI) a rozměry 4'' (Š) x 6'' (V) nebo 800 x 1200 pixelů. Tento přepravní štítek má vertikální orientaci a je určen pro tisk na plochu o rozměrech 4'' x 6''. Vytištěný štítek by měl mít rozměry 4'' × 6''.

Chcete-li vytvořit přepravní štítek a čárové kódy v požadovaném DPI, musíte před tiskem změnit měřítko (nebo velikost) obrázku. Způsob změny měřítka obrázku závisí na aplikaci, kterou používáte k zobrazení a tisku štítku. Změna měřítka obrázku PNG pro přepravní štítek 4'' x 6'' v palcích: použijte přesně šířku 4'' a délku 6''.

Kontrolní seznam pro štítky

Všechny čárové kódy

Vyžadováno pro ověření:

Ochranná zóna: Nad i pod čárovým kódem musí být vždy alespoň 0,1'' bílé plochy.
Ochranná zóna: Vlevo i vpravo od čárového kódu musí být vždy alespoň 0,2'' bílé plochy.
Ověřte, že všechny čárové kódy splňují požadavky na minimální výšku.

Kvalita tisku

Běžné problémy, které způsobují odmítnutí štítků:

Rozdělené kódy
Vybledlý tisk / bílá prázdná místa
Opakující se bílá prázdná místa (problém s válečkem)
Rozmazávání (termotransfer)
Odlupování (laserové) indikuje problém se sléváním toneru
Zmačkaný tisk (termotransfer)
Kontrast tisku pro přímé termální štítky musí být alespoň 90 %

Podrobnosti čitelné lidským okem pro štítky Ground

Pro podrobnosti čitelné lidským okem na štítcích FedEx Ground jsou pro ověření vyžadovány následující údaje:

Data odpovídají čárovému kódu
Logo FedEx Ground: Loga jsou k dispozici ke stažení na webových webu FedEx Identity fedex.com.
Logo FedEx Home Delivery: Štítky musí mít velké H v rámečku do 1' od adresy příjemce. H musí mít rozměry alespoň 0,25'' x 0,70''.
Popis služby
Informace o odesílateli
Informace o příjemci
Poštovní směrovací číslo a směrování
Datum odeslání
Skutečná hmotnost
Informace o automatizačním zařízení zákazníka (měřič, aplikace/systém, verze)
Rozměry
Různé referenční informace
Sledovací číslo a ID formuláře (sledovací číslo musí mít 14 znaků)
ID letištní rampy
PSČ

Podrobnosti čitelné lidským okem pro štítky Express

Aby mohl být štítek ověřen, musí na něm být vytištěny následující prvky:

Logo FedEx Express: Loga jsou k dispozici ke stažení na webových webu FedEx Identity fedex.com.
Popis služby
Typ balení, pokud se jedná o mezinárodní zásilku
Den doručení v týdnu (příklad: MON pro pondělí)
Datum doručení
Číslo měřiče
Datum odeslání
Formát počtu kusů, slovní popis hlavního štítku, slovní popis štítku CRN na všech MPS
ID letištní rampy
Poštovní směrovací číslo a směrování
Předpona a přípona směrování URSA
Kódy manipulace
Oblast dostupnosti služby
Telefonní čísla příjemce a odesílatele
Hmotnost
Rozměry (v příslušných případech)
Referenční pole, pokud se jedná o zásilku alkoholu
Sledovací číslo a ID formuláře (sledovací číslo musí mít 14 znaků)
Na štítku ASTRA se 12místné sledovací číslo nachází na pozicích 17 až 28 32znakového čárového kódu. V novém čárovém kódu FDX 1D se sledovací číslo nachází na pozicích 21 až 34. Sledovací číslo FedEx Express bude mít nadále 12 znaků. Na prvních dvou pozicích se budou nacházet nuly.

Obchodní pravidla

Na otevřené API zásilky se vztahují následující pravidla:

Otevřená zásilka může být také vytvořena a potvrzena s jedním balíkem.
Otevřené zásilky budou vymazány, pokud nebudou potvrzeny do konce pátého dne od vytvoření zásilky.
Jakmile je zásilka potvrzena, nelze do otevřené zásilky přidávat další balíky.

Kolekce JSON API

Open Ship API (1.0)

Create Open Shipment

This endpoint helps you to create an openn shipment request with the required shipping 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

FullSchema-createOpenShipment
MinimumSamplePayload-CreateOpenshipment
MinimumSamplePayload-CreateOpenshipmentAsynchronous

requestedShipment required	object (OpenshipmentRequestedShipment) The detailed transaction data for the requested Open Shipment.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
openShipmentAction	string (OpenShipAction) Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Indicates the optional actions that can be performed during the modification of packages in Open Shipment. Here are the values: CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment. STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed). WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.
index	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Note: If index is not provided while create open shipment then the master tracking id of create open ship will act as index for the shipment. Example: Test1234

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/create

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/create

Production Server

https://apis.fedex.com/ship/v1/openshipments/create

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "PRIORITY_OVERNIGHT",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20.6,
- "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",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
  },
- "recipients":
  [
  - {
    "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"
    },
    "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": "Your account number"
    }
  },
- "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": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
  },
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
  - "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
  - "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
  - "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "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"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "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"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "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"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
  - "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
  - "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
  },
- "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"
  },
- "expressFreightDetail":
  {
  - "bookingConfirmationNumber": "123456789812",
  - "shippersLoadAndCount": 123,
  - "packingListEnclosed": true
  },
- "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",
  - "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-02T11:35:49Z",
    "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"
    }
  },
- "smartPostInfoDetail":
  {
  - "ancillaryEndorsement": "RETURN_SERVICE",
  - "hubId": "5015",
  - "indicia": "PRESORTED_STANDARD",
  - "specialServices": "USPS_DELIVERY_CONFIRMATION"
  },
- "blockInsightVisibility": true,
- "rateRequestType":
  [
  - "LIST",
  - "PREFERRED"
  ],
- "preferredCurrency": "USD",
- "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"
    },
    "groupPackageCount": 2,
    "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"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ]
},
"accountNumber":
{
- "value": "Your account number"
},
"openShipmentAction": "CREATE_PACKAGE",
"index": "Test1234"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624dxxx6-b709-470c-8c39-4b55xxxxx492",
"customerTransactionId": "order123xxxx89",
"output":
{
- "asynchronousProcessingResultsDetail": "SYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "serviceName": "FedEx 2 Day Freight",
    "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": 25.3,
    "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."
    }
  ]
}

}

Modify Open Shipment

This endpoint helps you to modify an Open shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-modifyOpenShipment
MinimumSamplePayload-modifyOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
requestedShipment required	object (OpenshipmentRequestedShipment) The detailed transaction data for the requested Open Shipment.
openShipmentAction	string (OpenShipAction) Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Indicates the optional actions that can be performed during the modification of packages in Open Shipment. Here are the values: CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment. STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed). WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/

Production Server

https://apis.fedex.com/ship/v1/openshipments/

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"requestedShipment":
{
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "PRIORITY_OVERNIGHT",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20.6,
- "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",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
  },
- "recipients":
  [
  - {
    "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"
    },
    "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": "Your account number"
    }
  },
- "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": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
  },
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
  - "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
  - "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
  - "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "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"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "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"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "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"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
  - "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
  - "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
  },
- "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"
  },
- "expressFreightDetail":
  {
  - "bookingConfirmationNumber": "123456789812",
  - "shippersLoadAndCount": 123,
  - "packingListEnclosed": true
  },
- "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",
  - "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-02T11:35:49Z",
    "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"
    }
  },
- "smartPostInfoDetail":
  {
  - "ancillaryEndorsement": "RETURN_SERVICE",
  - "hubId": "5015",
  - "indicia": "PRESORTED_STANDARD",
  - "specialServices": "USPS_DELIVERY_CONFIRMATION"
  },
- "blockInsightVisibility": true,
- "rateRequestType":
  [
  - "LIST",
  - "PREFERRED"
  ],
- "preferredCurrency": "USD",
- "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"
    },
    "groupPackageCount": 2,
    "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"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ]
},
"openShipmentAction": "CREATE_PACKAGE",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "string",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "asynchronousProcessingResultsDetail": "SYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "serviceName": "FedEx 2 Day Freight",
    "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": 25.3,
    "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."
    }
  ]
}

}

Confirm Open Shipment

Use this endpoint to validate and upload the Open Ship shipment data to FedEx Systems once all packages are added in the Shipment request.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-confirmOpenShipment
MinimumSamplePayload-confirmOpenShipment

labelResponseOptions required	string (LABELRESPONSEOPTIONS) Enum: "URL_ONLY" "LABEL" Specify whether the encoded bytecode or the label URL to be returned in the response. Valid values: LABEL – Indicates request is for encoded bytecode. URL_ONLY – Indicates label URL request. Note: For asynchronous shipment (More than 40 packages) request only the value LABEL is suported. Note: With URL_ONLY option, the URL once created will be active for 12 hours.
edtRequestType	string Enum: "ALL" "NONE" Indicate whether to have estimated duties and taxes provided with the rate quotes on this shipment. Only applies for International Shipment.
labelSpecification required	object (LabelSpecification) These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking data on the label.
index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shippingDocumentSpecification	object (ShippingDocumentSpecification) Use this object to provide all data required for additional (non-label) shipping documents to be produced.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/

Production Server

https://apis.fedex.com/ship/v1/openshipments/

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"labelResponseOptions": "LABEL",
"edtRequestType": "ALL",
"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
},
"index": "Test1234",
"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"
    }
  },
- "returnInstructionsDetail":
  {
  - "customText": "This is additional text printed on Return instr",
  - "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": "PNG"
    }
  },
- "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": "22-01-2020",
    "ends": "2-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"
  ],
- "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"
    }
  }
},
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "string",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "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",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "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",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "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,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "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": 25.3,
    "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."
    }
  ]
}

}

Modify Open Shipment Packages

This endpoint helps you to modify packages in Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-modifyPackageInOpenShipment
MinimumSamplePayload-modifyPackageInOpenShipment

requestedPackageLineItem required	object Contains the data for the package that is to be modified in the open shipment.
index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shipAction	string Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Allowed values are STRONG_VALIDATION
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingId required	object (TrackingId) Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedPackageLineItem":
{
- "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"
  },
- "groupPackageCount": 2,
- "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"
  },
- "packageSpecialServices":
  {
  - "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
  - "signatureOptionType": "SERVICE_DEFAULT",
  - "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
  - "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
  - "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
  - "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
  - "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "pieceCountVerificationBoxCount": 0,
  - "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
  - "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
  }
},
"index": "Test1234",
"shipAction": "STRONG_VALIDATION",
"accountNumber":
{
- "value": "Your account number"
},
"trackingId":
{
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "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",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "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",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "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,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "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": 25.3,
    "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."
    }
  ]
}

}

Add Open Shipment Packages

This endpoint helps you to add packages to Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-addPackagesToOpenShipment
MinimumSamplePayload-addPackagesInOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shipAction	string Enum: "CONFIRM" "TRANSFER" There are Ship actions as part of processing the shipment.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
requestedPackageLineItems required	Array of objects (RequestedPackageLineItem) These are package line item details in the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"shipAction": "STRONG_VALIDATION",
"accountNumber":
{
- "value": "Your account number"
},
"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"
    },
  - "groupPackageCount": 2,
  - "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"
    },
  - "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
  }
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "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",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "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",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "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,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "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": 25.3,
    "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."
    }
  ]
}

}

Delete Open Shipment Packages

This endpoint helps you to delete packages from Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-deletePackagesFromOpenShipment
MinimumSamplePayload-deletePackagesOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingIds required	Array of objects (TrackingId) One or more tracking IDs, for which the packages to be removed from the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages/delete

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
},
"trackingIds":
[
- {
  - "formId": "0201",
  - "trackingIdType": "EXPRESS",
  - "uspsApplicationId": "92",
  - "trackingNumber": "49092000070120032835"
  }
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "deletedPackagesFromOpenshipment": true,
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Retrieve Open Shipment Package

This endpoint helps the user to RETRIEVE specific package request details of the Open Shipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-retrievePackageInOpenShipment
MinimumSamplePayload-retrievePackageInOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingId required	object (TrackingId) Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages/retrieve

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/retrieve

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
},
"trackingId":
{
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestedpackageLineItem":
  {
  - "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"
    },
  - "groupPackageCount": 2,
  - "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"
    },
  - "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

OpenShipmentDelete V1

This endpoint helps you to delete a Openshipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-deleteOpenShipment
MinimumSamplePayload-deleteOpenShipment

index required	string This is a unique value for the shipment (must be unique for stand-alone open shipments, or unique within consolidation if consolidation key is provide). Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/delete

Production Server

https://apis.fedex.com/ship/v1/openshipments/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "deletedOpenshipment": true,
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Retrieve Open Shipment

This endpoint helps the user to RETRIEVE the entire shipment request details of the OpenShipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-RetrieveOpenShipment
MinimumSamplePayload-RetrieveOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /ship/v1/openshipments/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/retrieve

Production Server

https://apis.fedex.com/ship/v1/openshipments/retrieve

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "XXX_ORDERXXXX789",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestedShipment":
  {
  - "shipDatestamp": "2019-10-14",
  - "totalDeclaredValue":
    {
    "amount": 12.45,
    "currency": "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",
    "phoneExtension": "91",
    "phoneNumber": "XXXX567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "recipients":
    [
    {
    "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"
    },
    "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"
    }
    ],
  - "recipientLocationNumber": "1234567",
  - "pickupType": "USE_SCHEDULED_PICKUP",
  - "serviceType": "PRIORITY_OVERNIGHT",
  - "packagingType": "YOUR_PACKAGING",
  - "totalWeight": 20.6,
  - "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": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
    },
  - "shipmentSpecialServices":
    {
    "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
    "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
    "returnShipmentDetail":
    {
    "returnEmailDetail":
    {
    "merchantPhoneNumber": "19012635656",
    "allowedSpecialService":
    [
    "SATURDAY_DELIVERY"
    ]
    },
    "rma":
    {
    "reason": "Wrong Size or Color"
    },
    "returnAssociationDetail":
    {
    "shipDatestamp": "2019-10-01",
    "trackingNumber": "123456789"
    },
    "returnType": "PRINT_RETURN_LABEL"
    },
    "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "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"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
    "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
    "pendingShipmentDetail":
    {
    "pendingShipmentType": "EMAIL",
    "processingOptions":
    {
    "options":
    [
    "ALLOW_MODIFICATIONS"
    ]
    },
    "recommendedDocumentSpecification":
    {
    "types": "ANTIQUE_STATEMENT_EUROPEAN_UNION"
    },
    "emailLabelDetail":
    {
    "recipients":
    [
    {
    "emailAddress": "neena@fedex.com",
    "optionsRequested":
    {
    "options":
    [
    "PRODUCE_PAPERLESS_SHIPPING_FORMAT",
    "SUPPRESS_ACCESS_EMAILS"
    ]
    },
    "role": "SHIPMENT_COMPLETOR",
    "locale": "en_US"
    }
    ],
    "message": "your optional message"
    },
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "expirationTimeStamp": "2020-01-01"
    },
    "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "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"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
    "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "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"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "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"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
    "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
    "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
    },
  - "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"
    },
  - "expressFreightDetail":
    {
    "bookingConfirmationNumber": "123456789812",
    "shippersLoadAndCount": 123,
    "packingListEnclosed": true
    },
  - "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",
    "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-02T11:35:50Z",
    "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"
    }
    },
  - "smartPostInfoDetail":
    {
    "ancillaryEndorsement": "RETURN_SERVICE",
    "hubId": "5015",
    "indicia": "PRESORTED_STANDARD",
    "specialServices": "USPS_DELIVERY_CONFIRMATION"
    },
  - "blockInsightVisibility": true,
  - "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"
    }
    },
    "returnInstructionsDetail":
    {
    "customText": "This is additional text printed on Return instr",
    "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": "PNG"
    }
    },
    "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": "22-01-2020",
    "ends": "2-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"
    ],
    "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"
    }
    }
    },
  - "rateRequestType":
    [
    "LIST",
    "PREFERRED"
    ],
  - "preferredCurrency": "USD",
  - "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"
    },
    "groupPackageCount": 2,
    "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"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
    ]
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Get Open Shipment Results

This endpoint enables you to finalize the Open Shipment. Once an Open Shipment is confirmed, no further changes can be done.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-getOpenShipmentResults
MinimumSamplePayload-getConfirmOpenShipmentResults
MinimumSamplePayload-getCreateOpenShipmentResults
MinimumSamplePayload-getModifyOpenShipmentResults

resultMethodType required	string Enum: "CREATE" "MODIFY" "CONFIRM" The use of this method is to retrieve the results of the CREATE, MODIFY and CONFIRM events of Asynchronous flow. CREATE- Customer will create Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Create OpenShipment. MODIFY- Customer will modify Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Modify OpenShipment. CONFIRM- Customer will confirm Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Confirm OpenShipment.
jobId required	string Indicates the job under which the deferred shipment artifacts must be identified in the subsequent retrieval request. Example: '89sxxxxx233ae24ff31xxxxx'
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/results

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/results

Production Server

https://apis.fedex.com/ship/v1/openshipments/results

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"resultMethodType": "CREATE",
"jobId": "89sxxxxx233ae24ff31xxxxx",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "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",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "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",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "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,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "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": 25.3,
    "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."
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Open Ship API

Úvod

Podrobnosti o otevřeném API zásilky

Pracovní postupy otevřeného API zásilky

Jak otevřené API zásilky funguje

Vícekusové otevřené zásilky (MPS)

Přepravní štítky FedEx

Obchodní pravidla

Kolekce JSON API

Open Ship API (1.0)

Create Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Modify Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Modify Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Add Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Open Shipment Package

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

OpenShipmentDelete V1

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Open Shipment Results

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in