Fedex Logo
Developer Portal

Open Ship API

Bevezetés

Ez az API lehetővé teszi Önnek, hogy létrehozzon egy nyitott küldeményt, valamint azt, hogy csomagokat adjon hozzá a küldeményhez egy bizonyos időszak alatt, ahelyett, hogy egyszerre adná meg az összes küldemény- és csomaginformációt. A küldemény öt napig marad nyitva, és ez idő alatt az API lehetővé teszi csomagok hozzáadását és módosítását. Amint megerősítésre kerül a küldemény, olyan szállítási dokumentumokat lehet generálni, mint címkék, légi fuvarlevél vagy jelentések. Az ötnapos időszak végén a küldeményt véglegesíteni kell, különben törlődik.

Megjegyzés: A nyitott küldemények törlődnek, ha a küldemény létrehozásától számított ötödik napon belül nem kerülnek megerősítésre.

A Nyitott küldemény API adatai

A Nyitott küldemény API akkor használatos, amikor több csomagot szeretne hozzáadni egy küldeményhez egy bizonyos időszak alatt, és nem biztos benne, hogy mennyi csomagot tervez hozzáadni, vagy mikorra készül el a küldemény. Így rugalmasan előkészítheti küldeményét a nap folyamán, amíg készen nem áll a küldésre.

A nyitott küldemények gyakran több darabból álló küldemények, de egy csomagból álló küldemények is lehetnek, amelyeket egydarabos küldeménynek nevezünk.

Ha egy több darabból álló küldeményt (MPS) szeretne küldeni egyetlen címzettnek, akkor használja a Nyitott küldemény API-t, és adjon hozzá a küldeményhez egy-egy csomagot vagy több csomagot, ha azokat ugyanannak a címzettnek küldi.

A nyitott küldeményhez kapcsolódó szolgáltatások a következők:

  • FedEx Express® az USA-n és Kanadán belül
  • FedEx Ground® az USA-n és Kanadán belül
  • FedEx Home Delivery® (otthoni kézbesítés)
  • FedEx International Priority®
  • FedEx International Priority® Express (IPE)
  • FedEx International Economy®
  • FedEx Priority OvernightTM
  • 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 (kizárólag az Egyesült Királyság területén)

A következő funkciók kapcsolódnak a Nyitott küldemény API-hoz:

Nyitott küldemények kezelése

Ez a funkció lehetővé teszi a feladó számára a nyitott küldemények létrehozását, módosítását és törlését, valamint a már létrehozott nyitott küldemények visszakeresését áttekintés vagy ellenőrzés céljából. Lehetővé teszi az elkészült küldemény megerősítését, a küldemény adatainak átadását a FedExnek és a megfelelő szállítási dokumentumok létrehozását. Továbbá azonosítja és lejelenti lévő lehetséges hibákat a tranzakcióban, valamint megfelelő státuszt biztosít.

Jelen funkció legfontosabb információi az accountNumber, Shipment Data, groupPackageCount, index a küldeményben lévő főcsomag jelölésére. Ennek a funkciónak az eredménye biztosítja, hogy a küldeményadatok feltöltődjenek a FedEx rendszerébe, és megfelelő nyomonkövetési számok, címkék és küldeményjelentések készüljenek.

Nyitott küldeményekben lévő csomagok kezelése

Ezzel a funkcióval hozzáadhat, módosíthat és törölhet csomagokat a már létrehozott nyitott küldeményben. Továbbá le lehet kérni meglévő nyitott küldemény meglévő csomagját.

Nyitott küldemény eredményeinek lekérése (nem párhuzamos)

Ez a funkció lehetővé teszi a megerősített szállítási eredmények nem párhuzamos lekérdezését. Amikor egy 40 vagy több csomagot tartalmazó nyitott küldeményt megerősítenek, az API nem párhuzamosan dolgozza fel a küldeményt.

Ha a küldemény nem párhuzamos feldolgozása történik, a kérelemre adott válasz kizárólag azt erősíti meg, hogy a kérelem sikeresen felvételre került. Ennek ellenére a küldemény feldolgozása nem feltétlenül lesz sikeres. Válaszként a jobId elemhez vezeti vissza, hogy később lekérdezhesse az eredményt. Ez a funkció a jobId elemet használja a nyitott küldemények eredményeinek (LÉTREHOZÁS, MÓDOSÍTÁS ÉS MEGERŐSÍTÉS) lekéréséhez, amelyek lehetnek címkék vagy küldeményjelentések. Továbbá azonosítja és riportálja a küldeményben lévő lehetséges hibákat, és megfelelő állapotjelentést biztosít.

Megjegyzés: Ha a nem párhuzamos szállítási válaszban hibák vannak, javítsa ki a hibákat, és nyújtson be új szállítási kérelmet.

A Nyitott küldemény API munkamenete

Ez a szakasz részletesen bemutatja a Nyitott küldemény API munkamenetét. A Nyitott küldemény munkamenetét kétféle módon, vagyis kétféle feldolgozási lehetőséggel lehet kezelni:

Munkamenet legfeljebb 40 csomag esetén

  1. A Nyitott küldemény létrehozása végponttal hozzon létre egy nyitott küldeményt az összes kötelező szállítási adattal, csomagolási információval, valamint a következőkkel: accountNumber és index.
  2. A Nyitott küldeménycsomagok hozzáadása végponttal adjon hozzá egy vagy több (legfeljebb 40) csomagot a már létrehozott nyitott küldeményhez. Annak a nyitott küldeménynek, amelyhez hozzáadják a csomagokat, a legfontosabb beviteli adatai a következők: index és accountNumber.
  3. Végül a Nyitott küldemény megerősítése végponttal erősítse meg, hogy minden csomag hozzá van adva, és a küldemény teljes. A megerősítendő küldemény legfontosabb beviteli adatai a következők: index és accountNumber.

Ez a Nyitott küldemény megerősítése végpont az a végső végpont ebben a munkafolyamatban, amelyik ellenőrzi a küldemény és a csomag adatait, és sikeresen generálja a címkéket és az összes többi jelentést a küldeményhez. Megadja az ellenőrzés során visszaküldött hibák részleteit is. A sikeres kérelem érdekében ezek a hibák a Nyitott küldemény módosítása vagy a Nyitott küldeménycsomagok módosítása végpont használatával, majd a küldemény újbóli megerősítésével javíthatók.

Munkamenet több mint 40 csomag esetén

  1. A Nyitott küldemény létrehozása végponttal hozzon létre egy nyitott küldeményt az összes kötelező szállítási adattal, csomagolási információval, valamint a következőkkel: accountNumber és index.
  2. A Nyitott küldeménycsomagok hozzáadása végponttal adjon hozzá egy vagy több (legfeljebb 40) csomagot a már létrehozott nyitott küldeményhez. Annak a nyitott küldeménynek, amelyhez csomagokat terveznek hozzáadni, a legfontosabb beviteli adatai a következők: index és accountNumber.
  3. A Nyitott küldemény megerősítése végponttal erősítse meg, hogy minden csomag hozzá van adva, és a küldemény teljes. A megerősítendő küldemény legfontosabb beviteli adatai a következők: index és accountNumber. Ebben az esetben, mivel a csomagok száma meghaladja a 40-et, az API nem párhuzamosan dolgozza fel a küldeményt, és visszaadja a jobId elemet, amelyet később a küldemény eredményeinek lekérdezéséhez használ. Ha a válaszban hibák találhatók, akkor ezeket a hibákat a Nyitott küldemény módosítása vagy a Nyitott küldeménycsomagok módosítása végponttal kell javítani, majd meg kell erősíteni a küldeményt a Nyitott küldemény megerősítése végpont használatával.
  4. A Nyitott küldemények eredményeinek lekérése végpont használatával a nyitott küldemény létrehozásának, módosításának és megerősítésének eredményeit kérheti le, például címkéket és kézbesítési dokumentációkat. A megerősített küldemény legfontosabb beviteli adatai a következők: jobId és accountNumber.

A Nyitott küldemény eredményeinek lekérése végpont az a végső végpont ebben a munkafolyamatban, amelyik lekéri a megerősített nyitott küldemény eredményeit, úgy mint a megerősített nyitott küldemény címkéi és minden egyéb jelentése. Ha a válaszban hibarészletek találhatók, akkor ezeket a hibákat a Nyitott küldemény módosítása vagy a Nyitott küldeménycsomagok módosítása végponttal lehet javítani, majd meg kell erősíteni a küldeményt a Nyitott küldemény megerősítése végponttal. Végül a Nyitott küldemény eredményeinek lekérése végponttal kérheti le a megerősített nyitott küldemény eredményeit a sikeres kérelem érdekében.

A Nyitott küldemény API működése

A következő funkciók kapcsolódnak a Nyitott küldemény API-hoz:

Nyitott küldemény létrehozása

Ezzel a végponttal létrehozhat egy nyitott küldeményt a szükséges küldeményadatokkal, és megadhat legalább egy csomagot a küldeményben.

Az alábbiakban a nyitott küldemény létrehozásához szükséges beviteli információk láthatók:

  • openShipmentAction – Ez a küldemény megnyitásának művelete, és ebben az esetben a következőként kell használni az értéket: CREATE_PACKAGE.
  • accountNumber – Ez a FedEx ügyfélazonosító.
  • requestedShipment – A nyitott küldemény küldeményadatai.
  • index – A nyitott küldemény egyedi értéke. Ez az érték a küldemény vagy a csomag módosításakor hasznos. Ez nem kötelező. Ha nem adják meg, a nyomonkövetési főszámot lehet használni a küldemény egyedi azonosítására.

A kérelemre adott sikeres válasz feldolgozza a küldeményt, és létrehozza a nyomonkövetési számot, amely az első csomag nyomonkövetési főszáma. Felhívjuk figyelmét, hogy a válaszban nem lesznek címkék generálva.

Nyitott küldeményekben lévő csomagok hozzáadása

Ezzel a végponttal egy vagy több csomagot adhat hozzá a meglévő nyitott küldemény iránti kérelemhez a küldemény megerősítése előtt. A nap folyamán a küldemény előkészítése során minden egyes csomagjára külön, csomag hozzáadása iránti kérelmet küldhet. A csomag hozzáadása iránti kérelmen belül több darabot is beküldhet.

Megjegyzés: A küldemény csomagjainak teljes száma nem haladhatja meg a nyitott küldemény csomagkorlátját.

Az alábbiakban a csomagoknak a nyitott küldeményhez való hozzáadásához szükséges beviteli információk láthatók:

  • index – Ez egy egyedi érték, amely hozzá van rendelve a már létrehozott nyitott küldeményhez. Ha ez nem érhető el, akkor adja meg a nyomonkövetési főszámot.
  • requestedPackageLineItem – A csomag(ok) részletes adatai, amelye(ke)t hozzá kell adni.
  • accountNumber – Ez a FedEx ügyfélazonosító.

A kérelemre adott sikeres válasz nyomkövetési számot generál az újonnan hozzáadott csomaghoz.

Nyitott küldeményekben lévő csomagok módosítása

Ezzel a végponttal módosíthatja csomagok egy vagy több adatát egy már meglévő nyitott küldeményből, mielőtt a küldemény megerősítésre kerül. Ez magában foglalja a főcsomagot is, amely az első csomag, amelyet a nyitott küldeményhez hozzáadtak.

Az alábbiakban a kérelemhez kapcsolódó kötelező bemeneti információkat ismertetjük:

  • index – Ez egy egyedi érték, amely hozzá van rendelve a már létrehozott nyitott küldeményhez. Ha ez nem érhető el, akkor adja meg a nyomonkövetési főszámot.
  • accountNumber – Ez a FedEx ügyfélazonosító.
  • trackingId – Nyitott küldemény egy vagy több módosítandó csomagjának nyomonkövetési azonosítója.
  • requestedPackageLineItem – A csomag(ok) részletes adatai, amelyeket módosítani kell.

A sikeres kérelem frissíti az érintett csomagokat, és visszaküldi a frissített szállítási adatokat.

Nyitott küldeményekben lévő csomagok törlése

Ezzel a végponttal törölhet egy vagy több csomagot a már létrehozott nyitott küldeményből a küldemény megerősítése előtt.

Az alábbiakban a kérelemhez kapcsolódó kötelező bemeneti információkat ismertetjük:

  • index – Ez egy egyedi érték, amely hozzá van rendelve a már létrehozott nyitott küldeményhez. Ha ez nem érhető el, akkor adja meg a nyomonkövetési főszámot.
  • accountNumber – Ez a FedEx ügyfélazonosító.
  • trackingId – Nyitott küldemény egy vagy több törlendő csomagjának nyomonkövetési azonosítója.

A sikeres kérelem törölni fogja az érintett csomagokat, és a deletedPackagesFromOpenshipment elem állapotát true változóként küldi vissza.

Megjegyzés: Ha a főcsomagot törlik a küldeményből, a sorban következő csomag lesz a főcsomag, és megkapja a nyomonkövetési főszámot, valamint a csomagszámból kivonódik a törölt csomagok száma.

Nyitott küldeményben lévő csomag lekérése

Ezzel a végponttal egy vagy több csomagot kérhet le a már létrehozott nyitott küldeményből áttekintés vagy ellenőrzés céljából.

Az alábbiakban a kérelemhez kapcsolódó kötelező bemeneti információkat ismertetjük:

  • index – Ez egy egyedi érték, amely hozzá van rendelve a már létrehozott nyitott küldeményhez. Ha ez nem érhető el, akkor adja meg a nyomonkövetési főszámot.
  • accountNumber – Ez a FedEx ügyfélazonosító.
  • trackingId – Nyitott küldemény egy vagy több olyan csomagjának nyomonkövetési azonosítója, amelynek lekérik az adatait.

A sikeres kérelem lekéri az érintett csomagokat.

Nyitott küldemény módosítása

Ezzel a végponttal módosíthatja a nyitott küldemény iránti kérelmet a szükséges szállítási információkkal a küldemény visszaigazolása előtt.

Az alábbiakban a kérelemhez kapcsolódó kötelező bemeneti információkat ismertetjük:

  • index – Ez egy egyedi érték, amely hozzá van rendelve a már létrehozott nyitott küldeményhez. Ha ez nem érhető el, akkor adja meg a nyomonkövetési főszámot.
  • accountNumber – Ez a FedEx ügyfélazonosító.
  • requestedShipment – A küldemény adatai, amelyre vonatkozóan a nyitott küldeményt módosítják.

A sikeres kérelem frissíti a küldemény adatait a már létrehozott nyitott küldeményhez, és kimenetként visszaküldi a módosított csomag(ok) nyomonkövetési számát és a tranzakció frissített küldeményadatait.

Nyitott küldemény lekérése

Ezzel a végponttal kérheti le a már létrehozott nyitott küldeményt áttekintés vagy ellenőrzés céljából.

Az alábbiakban a kérelemhez kapcsolódó kötelező bemeneti információkat ismertetjük:

  • index – Ez egy egyedi érték, amely hozzá van rendelve a már létrehozott nyitott küldeményhez. Ha ez nem érhető el, akkor adja meg a nyomonkövetési főszámot.
  • accountNumber – Ez a FedEx ügyfélazonosító.

A sikeres kérelem lekéri a nyitott küldemény érintett adatait.

Nyitott küldemény törlése

Ezzel a végponttal törölheti a nyitott küldemény kérelmét a küldemény megerősítése előtt.

Az alábbiakban a kérelemhez kapcsolódó kötelező bemeneti információkat ismertetjük:

  • index – Ez egy egyedi érték, amely hozzá van rendelve a már létrehozott nyitott küldeményhez. Ha ez nem érhető el, akkor adja meg a nyomonkövetési főszámot.
  • accountNumber – Ez a FedEx ügyfélazonosító.

A sikeres kérelem törli a nyitott küldeményt és az összes kapcsolódó csomagot, és a deletedOpenshipment elemben lévő állapotot true változóként küldi vissza.

Nyitott küldemény megerősítése

Ezzel a végponttal ellenőrizheti, majd feltöltheti a nyitott küldemény adatait a FedEx rendszereibe, amint hozzáadott minden csomagot a küldemény kérelmében.

Az alábbiakban a kérelemhez kapcsolódó kötelező bemeneti információkat ismertetjük:

  • index – Ez egy egyedi érték, amely hozzá van rendelve a már létrehozott nyitott küldeményhez. Ha ez nem érhető el, akkor adja meg a nyomonkövetési főszámot.
  • accountNumber – Ez a FedEx ügyfélazonosító.
  • labelResponseOptions – Annak megadása, hogy a válaszban a kódolt bytecode vagy a címke URL-címe szerepeljen-e.
    Megjegyzés: A labelResponseOptions elem csak a „Nyitott küldemény megerősítése” kérésben érhető el, és a címkék a küldemény visszaigazolása után jönnek létre.

A 40 vagy annál kevesebb csomagra adott sikeres visszaigazoló válasz feltölti a küldemény adatait a FedEx rendszerébe, és létrehozza a csomagcímkéket és az összes többi küldeményjelentést.

A több mint 40 csomag esetén adott sikeres válasz megerősíti, hogy a kérelem sikeresen bekerült a sorba, és a jobId elemet küldi vissza az eredmény későbbi lekérdezéséhez.

Megjegyzés: Legalább egy csomagnak szerepelnie kell a nyitott küldeményben, mielőtt megerősíthetné a küldeményt.

Nyitott küldemény eredményeinek lekérése

Használja ezt a végpontot a megerősített nyitott küldemény adatainak lekérdezéséhez. Ez a végpont csak akkor használható, ha a küldemény több mint 40 csomagot tartalmaz, és a nyitott küldemény megerősítése tartalmazza a jobId elemet.

Az alábbiakban a kérelemhez kapcsolódó kötelező bemeneti információkat ismertetjük:

  • resultMethodType – Az értéket a következőként adja meg: CREATE.
  • accountNumber – Ez a FedEx ügyfélazonosító.
  • jobId – Ez az a jobId elem, amely visszajött a nyitott küldemény megerősítésekor.

A kérelemre adott sikeres válasz visszaküldi a megerősített nyitott küldemény eredményeit, például a csomagcímkéket és a megerősített nyitott küldeményre vonatkozó összes többi küldeményjelentést. Ha a válaszban hibarészletek találhatók, akkor ezeket a hibákat a Nyitott küldemény módosítása vagy a Nyitott küldeménycsomagok módosítása végponttal lehet javítani, majd meg kell erősíteni a küldeményt a Nyitott küldemény megerősítése végponttal. Végül a Nyitott küldemény eredményeinek lekérése végponttal kérheti le a megerősített nyitott küldemény eredményeit a sikeres kérelem érdekében.

Több darabból álló nyitott küldemény (MPS)

Egy több darabból álló küldemény (MPS) két vagy több csomagból áll, amelyeket ugyanarra a címre küldenek. A szállítási kérelemben az első csomagot tekintjük főcsomagnak.

Több darabból álló küldemény létrehozásához:

  • Adja meg a küldeményszintű információkat, úgy mint a serviceType, packagingType, totalWeight, totalPackageCount, és a requestedPackageLineItemsadatokat a főcsomaghoz.
    Megjegyzés: A sequenceNumber értéknek a főcsomag esetén egyenlőnek kell lennie 1-gyel.
  • Adja hozzá az összes csomagot a küldeményhez.
  • Erősítse meg a küldeményt.

A küldemény megerősítése után az alábbi feldolgozási lehetőségek közül egy lesz használva:

Párhuzamos küldeményfeldolgozás

A párhuzamos feldolgozás az egyik optimális feldolgozási módszer, amelyet akkor használnak a rendszeren belül, ha egy küldemény 40 vagy annál kevesebb csomagot tartalmaz (total package count/grouppackagecount<=40), és a küldeményben korlátozott árucikkek vannak.

A 40 vagy annál kevesebb csomagot tartalmazó, megerősített szállítási kérelmek feldolgozása párhuzamosan történik, és a címkék és a szállítási dokumentumok/jelentések azonnal elkészülnek. Ez az eljárás időhiány esetén optimális a feladók számára, és ha a címkéket azonnal ki kell nyomtatni a küldemény megerősítését követően.

Megjegyzés: A csomagok maximális számának 40-re való korlátozása tájékoztató jellegű, és nem rögzített határérték. A határérték a küldeményben lévő csomagok és árucikkek kombinációjától is függ. További információkért lépjen kapcsolatba a FedEx ügyféltámogatási csapatával.

Példa: Az Ön nyitott küldeményekre vonatkozó kérelme 10 csomagból áll. Amikor megerősíti a küldeményt a 10 csomag hozzáadása után, a küldemény párhuzamosan kerül feldolgozásra. A válaszban 10 címke lesz létrehozva, és a kérésnek megfelelően címke-URL-ek vagy kódolt címkék érkeznek a válaszban.

A következő magas szintű munkafolyamat a nyitott küldemények párhuzamos feldolgozását mutatja be:

  1. Használja a Nyitott küldemény létrehozása végpontot.
  2. A Nyitott küldeménycsomagok hozzáadása végpont használatával adjon hozzá 1–40 csomagot.
  3. A Nyitott küldemény megerősítése végpont használatával erősítse meg a nyitott küldeményt.
  4. A sikeres kérésnek címkéket kell generálnia, és a kimeneti válasz címke-URL-eket vagy kódolt címkéket tartalmaz a kérésnek megfelelően.
  5. Ha a küldemény hibákat eredményez, a hibák részleteit a válaszban közli a rendszer.
  6. Az összes hiba kijavítása után a sikeres válasz érdekében használja a Nyitott küldemény megerősítése végpontot.

Megjegyzés: 

  • Ha ennél a módszernél több csomagot kell hozzáadni egy meglévő küldeményhez, akkor összesen legfeljebb 40 csomagot adhat hozzá. 

Nem párhuzamos küldeményfeldolgozás

Az API a rendszeren belül nem párhuzamosan dolgozza fel a küldeményeket, ha a csomagok száma meghaladja a 40-et (azaz: totalPackageCount>40). Ez egy nagyon kényelmes módszer, ha a csomagok mennyisége nagy, és Ön rendszeresen tömeges küldeményeket szeretne feladni. Ez a tömeges küldeményfeladás több értékes FedEx-erőforrást és -műveletet használ, ha egyszerre adják fel a csomagokat. Ezzel a feldolgozási lehetőséggel a FedEx belsőleg biztosítja, hogy ezeket a tömeges küldeményeket könnyedén feldolgozzák, és Ön rendszeresen megkaphatja a címkeadatokat is.

A küldemény nem párhuzamos feldolgozása esetén az erre a kérelemre adott válasz csak azt erősíti meg, hogy a kérelmet sikeresen beütemezte a rendszer, de magát a küldeményt esetleg még nem dolgozta fel, és a válasz a jobId elemet is tartalmazza, amellyel később lekérdezhető az eredmény.

Megjegyzés: Némi időt igényel, amíg a küldeményt sikeresen feldolgozza a rendszer, mielőtt lekérdezhetné az eredményt.

A nem párhuzamos küldeményeredmények lekéréséhez használja a Nyitott küldemény eredményeinek lekérése végpontot, és adja meg a jobId és a accountNumber elemet a kérelemben. A kérelemre adott válasz vagy a küldemény eredményadatait küldi vissza a címke részleteivel, vagy a küldemény hibájának részleteit.

Példa: Az Ön küldeménye 45 csomagból áll, és a kérelem megerősítésekor a csomagok nem párhuzamosan lesznek feldolgozva. A válaszban a jobId elem érkezik. Majd a küldeményadatok és a címkeadatok lekéréséhez használja a Nyitott küldemény eredményeinek lekérése végpontot.

A következő magas szintű munkafolyamat a küldemények nem párhuzamos feldolgozását mutatja be:

  1. Használja a Nyitott küldemény létrehozása végpontot.
  2. Adjon hozzá 40 vagy több csomagot a Nyitott küldeménycsomagok hozzáadása végponttal.
  3. Erősítse meg a küldeményt a Nyitott küldemény megerősítése végponttal.
  4. Sikeres beküldés esetén a jobId elem jelenik meg a válaszban.
  5. A jobId és az accountNumber elemek használatával lekérheti a kimeneti eredményeket a Nyitott küldemény eredményeinek lekérése végponton keresztül.
  6. A sikeres kimenet a küldemény eredményadatait adja meg a címke részleteivel együtt.
  7. Ha az eredmény hibákat tartalmaz, a hibák részleteit a válaszban közli a rendszer.

Megjegyzés:

  • Ennél a módszernél egyetlen kérelemben a maximálisan engedélyezett csomagok száma 300 vagy legfeljebb 999 árucikk. 
  • Ennél a módszernél a kérelem elküldése után nem lehet új csomagokat hozzáadni, illetve módosítani vagy törölni az eredeti kérelemben szereplő csomagokat. Ha hibák vannak a válaszban, javítsa ki azokat a Nyitott küldemény csomagjainak módosítása végponttal, majd erősítse meg a küldeményt a Nyitott küldemény megerősítése végponttal, ezután pedig kérje le a sikeres kimeneti eredményeket a Nyitott küldemény eredményeinek lekérése végponttal.

A FedEx fuvarlevél-címkéi

A FedEx API rengeteg különféle címkét támogat. A FedEx API háromféle címkefajtát támogat, például a thermo, a sima papíros és a testre szabható címkéket. A Nyitott küldemény API végpontjai segítségével sokféle címkét készíthet.

A FedEx 2 címkeformátumot kínál a szállítási szolgáltatásokhoz:

  • Thermo címkék
  • Lézercímkék

Thermo címkék

A FedEx API lehetővé tesz, hogy fuvarlevél-címkéket nyomtasson az összes szállítási típushoz, mint például a FedEx Express®, a FedEx Ground® és a FedEx International Ground® típushoz több fajta termikus címkenyomtatóval.

A FedEx API a thermo címkéket a következő méretekben támogatja:

  • 4 hüvelyk x 6 hüvelyk – konfigurálható dokumentumfül (Doc-Tab) nélkül
  • 4 hüvelyk x 6,75 hüvelyk – Doc-Tabbal vagy anélkül
  • 4 hüvelyk x 8 hüvelyk – helyet biztosít az Ön által választott grafikai vagy szöveges fájl elhelyezésére
  • 4'' x 8,5'' – konfigurálható dokumentumlappal (kifejezetten a gumiabroncs-azonosító címke számára)
  • 4 hüvelyk x 9 hüvelyk – helyet biztosít grafikák vagy szöveg, valamint egy Doc-Tab számára
  • 4'' x 10,5'' – konfigurálható dokumentumlappal (kifejezetten a gumiabroncs-azonosító címke számára)

A 4'' x 8,5''-es és a 4'' x 10,5''-es címkelaptípushoz extra dokumentumlap tartozik, megegyező vonalkódokkal. Az egyik vonalkód a főcímkén, a másik pedig a dokumentumlapon jelenik meg. Ez a címkelaptípus-érték hasznos a gumiabroncs-csomagok esetében, mivel az egyik címke elhelyezhető a gumiabroncs futófelületén, míg a további, a vonalkód és az üzemeltetési utasítások másolatát tartalmazó dokumentumlap-címke a gumiabroncs oldalfalára kerülhet. Ezen címkelaptípusok használata csökkenti a gumiabroncsok újracímkézésének szükségességét, a megnövelt szkennelési méret pedig optimalizálja a beolvasást. A címkelapokkal kapcsolatos további információkért tekintse meg a Címkelaptípusokat.

Megjegyzés: A Doc-Tab egy levehető tapadós lap, amely további szállítási információkat tartalmaz, és amely kiválasztható a címkelaphoz a fuvarlevél-címkék hőnyomtatóval való nyomtatása során.

Thermo címke elemei

A thermo fuvarlevél-címkék három alapvető elemet tartalmaznak:

  • Ember által olvasható tartalom: A címke ezen része a szállítási információkat tartalmazza.
  • A Ground-csomagokon lévő, ember által olvasható vonalkód alapértelmezés szerint titkosítva van.
  • Kétdimenziós (2D) vonalkód: a kétdimenziós alfanumerikus vonalkód a FedEx Express és FedEx Ground szolgáltatással küldött küldemények adatait tárolja az Amerikai Nemzeti Szabványügyi Hivatal (ANSI) MH10.8.3 szabványa alapján. A 2D vonalkód a PDF-fájlok 417-es szimbolikájának használatával jön létre.
  • FedEx-specifikus vonalkód:
    • ASTRA (Advanced Sorting Tracking Routing Assistance) bevezetésre került a FedEx Express küldemények esetében a FDX 1D vonalkódig; valamint a FedEx Ground és a FedEx Home Delivery esetében a 96-os vonalkódig . A FedEx Ground lehetővé teszi az SSCC-18 „00“ vonalkód használatát is.
    • A FedEx Express-küldemények FedEx 1D (FDX1D) vonalkódja az ANSI/AIM BC4-1995 (egységes szimbólumspecifikáció CODE-128C) alapján készül.

A thermo címke létrehozásához szükséges legfontosabb információk

A thermo címke létrehozásához szükséges legfontosabb információk a következők:

  • LabelFormatType: Ahhoz szükséges, hogy a megfelelő címkeképet lehessen fogadni a Nyitott küldeményre adott válasz API-ban:
    • COMMON2D: A címke formátumának típusa a címke fogadásához.
    • LABEL_DATA_ONLY: A vonalkódadatok fogadására használt érték, ha egyéni címkét hoz létre.
  • Érvényes értékek:

  • ImageType: A thermo címke formázásához szükséges az Ön által használt nyomtató számára; megadja a visszaküldendő adatfolyam vagy bitkép típusát.

    • EPL2 – Eltron (címkelaptípusok)
    • ZPLII – Zebra (címkelaptípusok)
  • Érvényes értékek:

    Megjegyzés: A küldeményhez szükséges összes címke egyetlen pufferben kerül generálásra és visszaküldésre.

Támogatott hőnyomtatók

A következő hőnyomtatók ajánlottak a FedEx API esetén:

  • Unimark
  • Eltron
    • Orion (EPL2)
    • Eclipse (EPL2)
  • Zebra
    • LP2443 (EPL2)
    • LP2844 (EPL2)
    • Gk420 (ZPL)
    • LP2348 Plus (EPL2/ZPL)
    • Z4M Plus (ZPL vagy EPL)
    • ZP500/ZP505 (EPL2/ZPL)
    • Z4M/Z4M+ (EPL2/ZPL)
    • ZM400 (EPL2/ZPL)
    • ZT410 (EPL2/ZPL)
    • Egyéb ZT4xx sorozatú nyomtatók (EPL2/ZPL)

Megjegyzés: Ezek a nyomtatók mind kompatibilisek az ASCII Eltron programozási nyelv (EPL2) lapmódjával. A hőnyomtatók támogatottak mind a rendszer soros portjához csatlakoztatott nyomtatóra történő közvetlen íráshoz, mind pedig a Windowsra telepített natív nyomtatóként LPT-, soros vagy USB-csatlakozásokhoz. A FedEx által biztosított nyomtatók firmware-verziói régiónként eltérőek lehetnek.

A nyomtatott thermo címkék száma szolgáltatásonként

A következő táblázat az egyes különleges szolgáltatásokhoz szükséges címketípusok számát tartalmazza. Az összes szükséges címkét a FedEx Common Label Server (CLS) hívásával lehet generálni, és a CLS a COD-visszárucímkék kivételével egyetlen puffert küld vissza.

A nyomtatott thermo címkék száma USA-beli szolgáltatásonként

Szolgáltatásfajta

Thermo címkék (a FedEx CLS a megfelelő számú címkét küldi vissza a válaszban)

FedEx Express U.S.

1 fuvarlevél-címke

FedEx Ground U.S. / FedEx Home Delivery (otthoni kézbesítés)

1 fuvarlevél-címke

A nyomtatott thermo címkék száma USA-beli kiviteli célú nemzetközi szolgáltatásonként

Szolgáltatásfajta

Thermo címkék (a FedEx CLS a megfelelő számú címkét küldi vissza a válaszban)

FedEx Express U.S. Export International

1 fuvarlevél-címke

2 címzettcímke

FedEx Express U.S. Export International vámbrókerválasztási lehetőséggel

1 fuvarlevél-címke

2 címzettcímke

FedEx Ground U.S. Export International

1 fuvarlevél-címke

FedEx Ground U.S. Export International COD

1 fuvarlevél-címke

2 COD-visszárucímke

A nyomtatott thermo címkék száma Kanadán belüli szolgáltatásonként

Szolgáltatásfajta

Thermo címkék (a FedEx CLS a megfelelő számú címkét küldi vissza a válaszban)

FedEx Express Kanadán belül

Nem DG (veszélyes áruk)/szárazjeges küldemény:

1 fuvarlevél-címke

FedEx Ground Kanadán belül

1 fuvarlevél-címke

FedEx Ground Kanadán belül, COD

1 fuvarlevél-címke

2 COD-visszárucímke

A nyomtatott thermo címkék száma kanadai kiviteli célú nemzetközi szolgáltatásonként

Szolgáltatásfajta

Thermo címkék (a FedEx CLS a megfelelő számú címkét küldi vissza a válaszban)

FedEx Express Canada Export International

Nem DG/szárazjeges küldemény:

1 fuvarlevél-címke

2 címzettcímke

FedEx Express Canada Export International vámbrókerválasztási lehetőséggel

Nem DG/szárazjeges küldemény:

1 fuvarlevél-címke

2 címzettcímke

FedEx Ground Canada (CA) Export International

1 fuvarlevél-címke

A nyomtatott thermo címkék száma a Fülöp-szigetekre és Thaiföldre menő küldeményenként

Szolgáltatásfajta

Thermo címkék (a FedEx CLS a megfelelő számú címkét küldi vissza a válaszban)

A Fülöp-szigetekre menő küldemények

2 fuvarlevél-címke az ügyfél-azonosító feltüntetésével

1 címzettcímke az ügyfél-azonosító nélkül

Kereskedelmi számla 3 példányban

Thaiföldre menő árucikk-küldemények

3 fuvarlevél-címke az ügyfél-azonosító feltüntetésével

1 címzettcímke az ügyfél-azonosító nélkül

Thaiföldre menő dokumentumküldemények

2 fuvarlevél-címke az ügyfél-azonosító feltüntetésével

1 címzettcímke az ügyfél-azonosító nélkül

Doc-Tab

Ha hőnyomtatóval nyomtat fuvarlevél-címkéket, választhat olyan címkelapot, amely tartalmaz Doc-Tab részt, egy eltávolítható tapadós lapot, amely további szállítási információkat tartalmaz. Ezeket a szállítási információkat konfigurálhatja a szállítási adatokból, vagy választhatja a szállítási igényeinek megfelelő, konfigurálható adatok nyomtatását.

Lézercímkék

A FedEx API támogatja a lézernyomtatóval történő címkenyomtatást. Ezeket a címkéket általában U.S. Letter vagy A4 méretű papírra nyomtatják, és félbehajtják, hogy beférjenek a FedEx szabványos címketasakjába. A lézernyomtatóval nyomtatott címkék PDF-formátumban készülnek, és nem kell méretezni vagy átméretezni őket. A címkelapokkal kapcsolatos további információkért lásd a címkelaptípusok című részt.

Előfeltételek

A PDF-címkékre a következő követelmények vonatkoznak:

  • A címke feldolgozásához az Adobe Reader 6.0-os vagy újabb verziója szükséges.
  • A nyomtató illesztőprogramjának konfigurációjában a nyomtatóméretezést ki kell kapcsolni.
  • HTML wrapper használata nem szükséges a sima papír PDF-címke böngészőben történő megjelenítéséhez.
  • Az Acrobat a következő böngészőket ajánlja a PDF-dokumentumok megtekintéséhez:
    • Microsoft Internet Explorer 10 vagy újabb
    • Firefox 1.0 vagy újabb
    • Mozilla 1.7 vagy újabb

A PDF-címke lehetőséggel nem kell megadni a kép tájolási paraméterét (szélesség és magasság) vagy a képernyőfelbontást ahhoz, hogy a címke megfelelően jelenjen meg a böngészőben.

Lézercímke elemei

A lézernyomtatott fuvarlevél-címkék három alapvető elemet tartalmaznak:

  • Ember által olvasható tartalom – A címke ezen része a szállítási információkat tartalmazza.
  • A Ground-csomagokon lévő, ember által olvasható vonalkód alapértelmezés szerint titkosítva van.
  • Kétdimenziós (2D) vonalkód – A kétdimenziós alfanumerikus vonalkód a FedEx Express és FedEx Ground szolgáltatással küldött küldemények adatait tárolja az Amerikai Nemzeti Szabványügyi Hivatal (ANSI) MH10.8.3 szabványa alapján. A 2D vonalkód a PDF-fájlok 417-es formátumának használatával jön létre.
  • FedEx-specifikus vonalkód:
    • ASTRA (Advanced Sorting Tracking Routing Assistance) bevezetésre került a FedEx Express küldemények esetében az FDX 1D vonalkódig; valamint a FedEx Ground és a FedEx Home Delivery (otthoni kézbesítés) szolgáltatással szállított küldemények esetében a 96-os vonalkód. A FedEx Ground adott esetben lehetővé teszi az SSCC-18 „00“ vonalkód használatát is.
    • A FedEx Express-küldemények FedEx 1D (FDX1D) vonalkódja az ANSI/AIM BC4-1995 (egységes szimbólumspecifikáció CODE-128C) alapján készül.

A lézercímke létrehozásához szükséges legfontosabb információk

A következő FedEx API-elemek szükségesek a lézercímke generálásához:

  • LabelSpecification/LabelFormatType: Ahhoz szükséges, hogy a megfelelő címkeképet lehessen fogadni a Nyitott küldeményre adott válasz API-ban: Érvényes értékek:
    • COMMON2D – A címke formátumának típusa a címke fogadásához.
    • LABEL_DATA_ONLY – A vonalkódadatok fogadására használt érték, ha egyéni címkét hoz létre.
  • LabelSpecification/ImageType: A címke formázásának feltüntetéséhez szükséges. A visszaküldendő adatfolyam vagy bitkép típusa:

    Érvényes értékek:

    • PDF – sima papír
    • PNG – sima papír
  • LabelSpecification/LabelStockType: Az összes címketípushoz szükséges. Megadható, hogy a címkelap elején vagy végén legyen-e Doc-Tab. PDF vagy PNG típusú ImageType használata esetén ezek az értékek lézeres formátumú címkét jelenítenek meg:
    • PAPER_4X6
    • PAPER_4X8
    • PAPER_4X9
    • PAPER_4X675
      Ezek az értékek sima papír formátumú fuvarlevél-címkét jelenítenek meg:
    • PAPER_7X47
    • PAPER_85X11_BOTTOM_HALF_LABEL
    • PAPER_85X11_TOP_HALF_LABEL
    • PAPER_LETTER

Megjegyzés: Ha sima papírcímkét kér, a visszaküldött adat egy Base64-kódolt címkekép, amelyet a címkefájl megjelenítése előtt Base64-dekódolással kell dekódolni.

Támogatott lézernyomtatók

A legtöbb lézernyomtató támogatott ezen címketípus esetén; a tintasugaras nyomtatóval nyomtatott címkék azonban nem fogadhatók el.Megjegyzés: Ha színes lézernyomtatót használ, a színbeállítást feketére kell állítani, még akkor is, ha a nyomtatóba csak fekete patron van behelyezve.

Szolgáltatásonként szükséges lézercímkék száma

A következő táblázat az egyes különleges szolgáltatásokhoz szükséges címketípusok számát tartalmazza. Az összes szükséges címkét a FedEx Common Label Server (CLS) hívásával lehet generálni, és a CLS a COD-visszárucímkék kivételével egyetlen puffert küld vissza.

A nyomtatott lézercímkék száma USA-beli szolgáltatásonként

Szolgáltatásfajta

Lézercímke – PDF-formátum

FedEx Ground/FedEx Home Delivery (otthoni kézbesítés) U.S.

1 fuvarlevél-címke

A nyomtatott lézercímkék száma USA-beli kiviteli célú nemzetközi szolgáltatásonként

Szolgáltatásfajta

Lézercímke – PDF-formátum

FedEx Express U.S. Export International

1 fuvarlevél-címke a válaszban; legalább 3 címkét kell nyomtatni – 1 címkét a csomagra és 2 címkét a dokumentumtasakba.

FedEx Express U.S. Export International vámbrókerválasztási lehetőséggel

1 fuvarlevél-címke a válaszban; legalább 3 címkét kell nyomtatni – 1 címkét a csomagra és 2 címkét a dokumentumtasakba.

FedEx Ground U.S. Export International

1 fuvarlevél-címke

FedEx Ground U.S. Export International COD

1 fuvarlevél-címke

2 COD-visszárucímke

A nyomtatott lézercímkék száma Mexikón belüli szolgáltatásonként

Szolgáltatásfajta

Lézercímke – PDF-formátum

FedEx Express Mexikón belül

FedEx Express Mexikón belül

Nem DG (veszélyes áruk)/szárazjeges küldemény:

1 fuvarlevél-címke

A nyomtatott lézercímkék száma Kanadán belüli szolgáltatásonként

Szolgáltatásfajta

Lézercímke – PDF-formátum

FedEx Express Kanadán belül

FedEx Express Kanadán belül

Nem DG (veszélyes áruk)/szárazjeges küldemény:

1 fuvarlevél-címke

FedEx Ground Kanadán belül

1 fuvarlevél-címke

FedEx Ground Kanadán belül, COD

1 fuvarlevél-címke

2 COD-visszárucímke

A nyomtatott lézercímkék száma kanadai kiviteli célú nemzetközi szolgáltatásonként

Szolgáltatásfajta

Lézercímke – PDF-formátum

FedEx Express Canada Export International

FedEx Express Canada Export International

Nem DG/szárazjeges küldemény:

1 fuvarlevél-címke

2 címzettcímke

FedEx Express Canada Export International vámbrókerválasztási lehetőséggel

FedEx Express Canada Export International vámbrókerválasztási lehetőséggel

Nem DG/szárazjeges küldemény:

1 fuvarlevél-címke

2 címzettcímke

FedEx Ground Canada (CA) Export International

1 fuvarlevél-címke

A nyomtatott lézercímkék száma kanadai kiviteli célú nemzetközi szolgáltatásonként

Szolgáltatásfajta

Lézercímke – PDF-formátum

FedEx Express Canada Export International

FedEx Express Canada Export International

Nem DG/szárazjeges küldemény:

1 fuvarlevél-címke

2 címzettcímke

FedEx Express Canada Export International vámbrókerválasztási lehetőséggel

FedEx Express Canada Export International vámbrókerválasztási lehetőséggel

Nem DG/szárazjeges küldemény:

1 fuvarlevél-címke

2 címzettcímke

FedEx Ground Canada (CA) Export International

1 fuvarlevél-címke

A nyomtatott lézercímkék száma a Fülöp-szigetekre és Thaiföldre menő küldeményenként

Szolgáltatásfajta

Thermo címkék (a FedEx CLS a megfelelő számú címkét küldi vissza a válaszban)

A Fülöp-szigetekre menő küldemények

2 fuvarlevél-címke az ügyfél-azonosító feltüntetésével

1 címzettcímke az ügyfél-azonosító nélkül

Kereskedelmi számla 3 példányban

Thaiföldre menő árucikk-küldemények

3 fuvarlevél-címke az ügyfél-azonosító feltüntetésével

1 címzettcímke az ügyfél-azonosító nélkül

Thaiföldre menő dokumentumküldemények

2 fuvarlevél-címke az ügyfél-azonosító feltüntetésével

1 címzettcímke az ügyfél-azonosító nélkül

Egyéni címke

A FedEx lehetővé teszi a FedEx által generált címkék testreszabását. A thermo címkék egyéni részében hozzáadhatja a vállalkozására vonatkozó szöveget, és kiválaszthatja a FedEx-dokumentumokon és -címkéken használt vonalkód (szimbolika) típusát.

A FedEx Nyitott küldemény API-ja az Ön szállítási alkalmazásának támogatása érdekében két lehetőséget biztosít a fuvarlevél-címke testreszabásához:

  • A PNG PAPER típusú, 7 hüvelyk x 4,75 hüvelyk méretű grafikát a címkelapra helyezheti. Például létrehozhat egy rakodási listát egy 8-1/2 hüvelyk x 11 hüvelyk méretű űrlapon. A formanyomtatvány részeként a 7 hüvelyk x 4,75 hüvelyk méretű PNG PAPER típusú grafikát is elhelyezheti, ahelyett, hogy saját egyedi címkét készítene.
  • Grafikai vagy szöveges fájlt adhat hozzá a 4 hüvelyk x 8 hüvelyk vagy 4 hüvelyk x 9 hüvelyk méretű thermo címkéhez. Ez a címkeméret 2 hüvelyknyi helyet biztosít a grafikának vagy szövegnek.

Megjegyzés: A címke ember által olvasható tartalma és a címke közös részén található vonalkód nem módosítható.

Egyéni érvényesítő címke

Egyéni, nem fuvarlevél típusú címkéket hozhat létre csomag- és küldeményszinten egyaránt, ami során megadhatja, milyen egyéni információkat szeretne, hogyan formázza a rendszer az információkat, és hol helyezze el azokat az egyéni címkén. Egyedi címkék csak a thermo címkék esetén állíthatók be.

Thermo címke testreszabása

A FedEx API két thermocímke-formátumot biztosít, amelyeket grafikus vagy szöveges fájl segítségével testre szabhat, így nem kell egyedi címkét készítenie. Ezek a címkék támogatják a FedEx összes szállítási szolgáltatását. A formátumok a következők:

  • 4 hüvelyk x 8 hüvelyk méretű thermo címke Doc-Tab nélkül
  • 4 hüvelyk x 9 hüvelyk méretű thermo címke Doc-Tabbal

Ezek a címketípusok egy két hüvelykes testreszabható részt biztosítanak. Ez a funkció a 203 DPI vagy 300 DPI értékre beállított hőnyomtatóval nyomtatott hőcímkék esetén alkalmazható.

Az egyéni címkével kapcsolatos szabályok

A címkeformátumok használatával kapcsolatos szabályok a következők:

  • Csak a fuvarlevél-címke szabható testre. Ha például Express-küldeményhez egy 4 hüvelyk x 8 hüvelyk méretű fuvarlevélcímkét nyomtat a logójával, a másodlagos címzettcímkéken nem jelenik meg a logó.
  • A testreszabható grafika vagy szöveg nem haladhatja meg a 2 hüvelyk magasságot és a 4-1/2 hüvelyk szélességet.
  • A FedEx nem biztosít korrekciót. A grafika és/vagy a szöveg a szállítási szolgáltatásban megadott módon nyomtatódik ki.
  • Ha nincs megadva a grafika és/vagy a szöveg nyomtatásához szükséges összes adat (például: X- és Y-koordináták), az érvényes fuvarlevél-címkét a testreszabott adatok nélkül küldi vissza a rendszer. Az adott címke által jelölt küldeményt le kell mondania, ha megpróbál egy másik címkét újra elkészíteni a grafikával és/vagy szöveggel.
  • 203 DPI-s (8 pont/mm) nyomtatófelbontás esetén az X- és Y-koordinátákon való elhelyezést illetően, a beszúrási pont koordináta-adatpontja az alsó Doc-Tabbal rendelkező, 4,00 hüvelyk x 6,75 hüvelyk méretű thermo címke felső és bal szélének metszéspontja. A 4,00 hüvelyk x 6,75 hüvelyk méretű, felső Doc-Tabbal ellátott thermo címke esetében a beszúrási pont Y-koordinátaértékét 164 ponttal növelje. 4,00 hüvelyk x 6,00 hüvelyk méretű, Doc-Tabbal nem rendelkező címke esetén növelje a beszúrási pont Y-koordinátaértékét 8 ponttal. A thermo címke elemeinek attribútumai a 203 DPI (8 pont/mm) nyomtatófelbontáson alapulnak.
  • 300 DPI-s (12 pont/mm) nyomtatófelbontás esetén az X- és Y-koordinátákon való elhelyezést illetően, a beszúrási pont koordináta-adatpontja az alsó Doc-Tabbal rendelkező, 4,00 hüvelyk x 6,75 hüvelyk méretű thermo címke felső és bal szélének metszéspontja. A 4,00 hüvelyk x 6,75 hüvelyk méretű, felső Doc-Tabbal ellátott thermo címke esetében a beszúrási pont Y-koordinátaértékét 246 ponttal növelje. 4,00 hüvelyk x 6,00 hüvelyk méretű, Doc-Tabbal nem rendelkező címke esetén növelje a beszúrási pont Y-koordinátaértékét 12 ponttal. A thermo címke elemeinek attribútumai a 300 DPI-s (12 pont/mm) nyomtatófelbontáson alapulnak.
    Megjegyzés:
    • Az FXD1D vonalkód esetében az X-méret (a szimbólum legkeskenyebb vonalának szélessége) 15 mil (3 pont) 203 DPI-s nyomtató esetén, és 13,3 mil (4 pont) 300 DPI-s nyomtató esetén.
    • A 2D PDF-417 vonalkód esetében az X-méret 10 mil (2 pont) 203 DPI-s nyomtató esetén. A 300 DPI-s nyomtatóhoz legközelebbi egyenértékű X-méret eléréséhez 9,99 milt (3 pont) kell használni.
    • A címke tetején található Feladó/Egyéb rész és a címzettre vonatkozó információk alatti Feladói referencia rész esetében, ahol nagyon kis betűtípusokat használnak, a címkefejlesztőknek a ZPL programozási útmutató információival kell összevetniük a betűkészlet jellemzőit, hogy a különböző nyomtatófej-felbontásokhoz egyenértékű teljesítményű betűkészletet válasszanak.
  • A karakterbeszúrási pont a karakterlánc első karakterének bal felső sarka, a betűmagasságot jelző vonalnál.
  • A nyomtató korlátozásai miatt az előlap bal felső negyedében kell elhelyezni a kiindulási pontot. Ezért lehetséges, hogy az adatok a címke testreszabható részében kezdődnek, és a címke FedEx-részébe íródnak tovább (a thermo címke tényleges adatai). Ha ez történik, az Ön logóját vagy szövegét felülírják a FedEx-címkeinformációk. A fuvarlevél-címke használatához javítani kell ezt a pozicionálást.
  • A Doc-Tab információinak hozzáadását a 4 hüvelyk x 9 hüvelyk méretű címkéhez ugyanolyan eljárással kell konfigurálni, mint a normál 4 hüvelyk x 6 hüvelyk méretű, Doc-Tabbal ellátott thermo címkék esetében.

Megjegyzés: Csak egybites színű képeket érdemes hozzáadni, mivel a címkék fekete-fehéren kerülnek nyomtatásra.

Egyedi címke megadott grafikus elemei

Az API PNG-formátumú (Portable Network Graphic) képeket biztosít a FedEx Express- és FedEx Ground-címkékhez. A PNG-címkegrafika az API által támogatott thermo vagy sima papírcímkék másolata. Ez a címkeopció lehetővé teszi, hogy a PNG-címkegrafikát a címkelapra helyezze, így nincs szükség egyéni címke létrehozására.

A fuvarozási dokumentumba ágyazott 4 hüvelyk x 6 hüvelyk méretű PNG-grafika használata esetén a következő követelmények érvényesek:

  • Címkelap
  • Nyomtató
  • Átméretezés

Címkelap

A 4 hüvelyk x 6 hüvelyk méretű PNG-címkék csak öntapadós címkelappal használhatók. A FedEx Ground és FedEx Express címketanúsító csapatai elutasítják azokat a 4 hüvelyk x 6 hüvelyk méretű PNG-címkéket, amelyek nem öntapadós címkelapra készültek, ideértve a sima papírra nyomtatott címkéket is.

Nyomtató

A címkék nyomtatásához lézernyomtatók ajánlottak. A tintasugaras nyomtatók nem használhatók, mert nem következetesek a beolvasható vonalkódok létrehozásában. A 4 hüvelyk x 6 hüvelyk méretű PNG-címke csak akkor nyomtatható színes nyomtatóval, ha a színbeállítást fekete színre állította, még akkor is, ha a nyomtatóba csak fekete patron van behelyezve. Erre a beállításra azért van szükség, hogy a FedEx elosztóközpontjaiban történő beolvasáshoz megfelelő vonalkódélességet kapjon.

Átméretezés

A fuvarozási tranzakcióban visszaküldött kép 200 pont per hüvelyk (DPI) felbontású és 4 hüvelyk (sz) x 6 hüvelyk (h) vagy 800 x 1200 pixel méretű. Ez a címke függőleges tájolású, és 4 hüvelyk x 6 hüvelyk méretű címkefelületre nyomtatható. Nyomtatás után a címkének 4 hüvelyk x 6 hüvelyk méretűnek kell lennie.

Ahhoz, hogy a címkét és a vonalkódokat a kívánt DPI-értékben tudja létrehozni, a képet nyomtatás előtt méretezni (vagy átméretezni) szükséges. A kép méretezése attól az alkalmazástól függ, amelyet a címke megtekintésére és nyomtatására használ. A PNG-kép méretezése egy 4 hüvelyk x 6 hüvelyk méretű címke esetében hüvelykben: adjon meg pontosan 4 hüvelyket a szélességnek és 6 hüvelyket a hosszúságnak.

Ellenőrző lista címkékhez

Minden vonalkód

Érvényesítéshez szükséges:

  • Üres zóna: Mindenképpen kell lennie egy 0,1 hüvelyk méretű üres területnek a vonalkód alatt és felett.
  • Üres zóna: Mindenképpen kell lennie egy 0,2 hüvelyk méretű üres területnek a vonalkód jobb és bal oldalán.
  • Győződjön meg róla, hogy minden vonalkód eléri a minimális magasságot.

Nyomtatási minőség

A címkék elutasítását eredményező gyakori problémák:

  • Nem folytonos vonalak
  • Lekopott festék/üres területek
  • Ismétlődő üres területek (nyomtatóhenger problémája)
  • Maszatolás (hőátvitel)
  • Lepattogzás (lézer) – tonerfúziós problémát jelez
  • Gyűrött a nyomtatásban (hőátvitel)
  • A közvetlen thermo címkék nyomtatási kontrasztjának legalább 90%-osnak kell lennie

Ember által olvasható adatok a Ground-címkék esetén

A FedEx Ground-címkék ember által olvasható adatai esetén a következők szükségesek az érvényesítéshez:

  • Az adatok egyeznek a vonalkóddal
  • FedEx Ground logó: A logók letölthetők a FedEx Identity weboldalról (fedex.com).
  • FedEx Home Delivery (otthoni kézbesítés) logó: A címkén egy nagy „H“-nak kell szerepelnie egy mezőben, amely 1 hüvelyk távolságra van a szállítási címtől. A „H“-nak legalább 0,25 hüvelyk x 0,70 hüvelyknek kell lennie.
  • Szolgáltatás leírása
  • Feladó adatai
  • Címzett adatai
  • Irányítószám és útvonal
  • Szállítás dátuma
  • Tényleges tömeg
  • Ügyfél-automatizálási eszköz információi (mérő, alkalmazás/rendszer, verziószám)
  • Méretek
  • Egyéb referenciainformációk
  • Nyomonkövetési szám és űrlap-azonosító (a nyomkövetési számnak 14 számjegyűnek kell lennie)
  • Repülőtéri rámpa azonosítója
  • Irányítószám

Ember által olvasható adatok az Express-címkék esetén

A következő elemeket kötelező a címkére nyomtatni, hogy átmenjen a hitelesítési folyamaton:

  • FedEx Express logó: A logók letölthetők a FedEx Identity weboldalról (fedex.com).
  • Szolgáltatás leírása
  • Csomagtípus, ha International
  • A kézbesítés napja a hét napjai közül (pl. MON a hétfő esetén)
  • Kézbesítési határidő
  • Mérő száma
  • Szállítás dátuma
  • A formátum a darabszám, a főcímke szövegezése és (az ügyfél hivatkozási számát tartalmazó) CRN-címke szövegezése esetén minden több darabból álló küldeményen
  • Repülőtéri rámpa azonosítója
  • Irányítószám és útvonal
  • URSA-útvonal előtagja és utótagja
  • Kezelési kódok
  • Szolgáltatási területtel kapcsolatos vállalás
  • Címzett és feladó telefonszáma
  • Tömeg
  • Méretek, adott esetben
  • Referenciamező (alkoholszállítmány esetén)
  • Nyomonkövetési szám és űrlap-azonosító (a nyomkövetési számnak 14 számjegyűnek kell lennie)
  • Az ASTRA címkén a 12 számjegyű nyomonkövetési szám a 32 karakteres vonalkód 17-28. pozícióiban található. Az új FDX 1D vonalkódban a nyomonkövetési szám a 21-34. pozíciót foglalja el. A FedEx Express nyomonkövetési száma továbbra is 12 számjegyű marad. A két kezdőpozíciót nullák foglalják el.

Üzleti szabályok

A következő szabályok vonatkoznak a Nyitott küldemény API-ra:

  • Nyitott küldemény létrehozható és megerősíthető egyetlen csomaggal is.
  • A nyitott küldemények törlődnek, ha a küldemény létrehozásától számított ötödik napon belül nem kerülnek megerősítésre.
  • Amint a küldemény megerősítésre kerül, a nyitott küldeményhez több csomag nem adható hozzá.

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.


EXPAND ALLCOLLAPSE ALL
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 - Create Open Shipment

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "requestedShipment":
    {
    },
  • "accountNumber":
    {
    },
  • "openShipmentAction": "CREATE_PACKAGE",
  • "index": "Test1234"
}

Response samples - Create Open Shipment

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

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.


EXPAND ALLCOLLAPSE ALL
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 - Modify Open Shipment

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "requestedShipment":
    {
    },
  • "openShipmentAction": "CREATE_PACKAGE",
  • "accountNumber":
    {
    }
}

Response samples - Modify Open Shipment

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "string",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

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.


EXPAND ALLCOLLAPSE ALL
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 - Confirm Open Shipment

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "labelResponseOptions": "LABEL",
  • "edtRequestType": "ALL",
  • "labelSpecification":
    {
    },
  • "index": "Test1234",
  • "shippingDocumentSpecification":
    {
    },
  • "accountNumber":
    {
    }
}

Response samples - Confirm Open Shipment

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "string",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

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.


EXPAND ALLCOLLAPSE ALL
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 - Modify Open Shipment Packages

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "requestedPackageLineItem":
    {
    },
  • "index": "Test1234",
  • "shipAction": "STRONG_VALIDATION",
  • "accountNumber":
    {
    },
  • "trackingId":
    {
    }
}

Response samples - Modify Open Shipment Packages

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

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.


EXPAND ALLCOLLAPSE ALL
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 - Add Open Shipment Packages

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "shipAction": "STRONG_VALIDATION",
  • "accountNumber":
    {
    },
  • "requestedPackageLineItems":
    [
    ]
}

Response samples - Add Open Shipment Packages

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

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.


EXPAND ALLCOLLAPSE ALL
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 - Delete Open Shipment Packages

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "accountNumber":
    {
    },
  • "trackingIds":
    [
    ]
}

Response samples - Delete Open Shipment Packages

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

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.


EXPAND ALLCOLLAPSE ALL
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 - Retrieve Open Shipment Package

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "accountNumber":
    {
    },
  • "trackingId":
    {
    }
}

Response samples - Retrieve Open Shipment Package

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

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.


EXPAND ALLCOLLAPSE ALL
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 - OpenShipmentDelete V1

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "accountNumber":
    {
    }
}

Response samples - OpenShipmentDelete V1

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

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.


EXPAND ALLCOLLAPSE ALL
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 - Retrieve Open Shipment

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "accountNumber":
    {
    }
}

Response samples - Retrieve Open Shipment

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "XXX_ORDERXXXX789",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

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.


EXPAND ALLCOLLAPSE ALL
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 - Get Open Shipment Results

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "resultMethodType": "CREATE",
  • "jobId": "89sxxxxx233ae24ff31xxxxx",
  • "accountNumber":
    {
    }
}

Response samples - Get Open Shipment Results

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

Response

Copy