Rövid áttekintés
Az ügyfél az OrderWs felé 4 féle kérést indíthat, amit az alábbi metódusok írnak le:
- createOrder(): megrendelés létrehozása a Hibridlevél rendszerében
- getProof(): a megrendelés feldolgozása után a küldemény(ek)ről minta kérése
- rejectOrder(): a minták megtekintése után a megrendelés érvénytelenítése
- approveOrder(): a minták megtekintése után a megrendelés elfogadása
A megrendelés beküldésének és elfogadásának folyamat megegyezik a fent említett metódusok sorrendjével:
- először beküldésre kerül a megrendelés vagy megrendelések
- miután a minták előálltak a megrendelésben lévő küldeményekről, kétféle módon folytatódhat a folyamat:
- a minták helyesek és a megrendelés kiküldésre kerülhet vagy a minták között van hibás, ezért a megrendelés nem kerülhet kiküldésre
Részletes bemutatás
Az alábbiakban bemutatjuk, hogy a fenti 4 metódust mikor és hogyan lehet használni.
1. createOrder():
| Erőforrás neve | Kérés típusa | Url | Paraméterek | Sikeres kérés esetén a válaszkód |
|---|---|---|---|---|
| createOrder | Post | /rest/v2/order | 201 |
A folyamat első lépése, minden esetben ezzel kell kezdeni. Ezzel a kéréssel tudja az ügyfél elküldeni felénk a megrendelését, ami tartalmazza a küldeményeket. A kérésben json formátumban szerepelnie kell a megrendelés adatainak. Az adatok megadásához itt talál segítséget: Order létrehozása. A sikeres beküldést egy 201-es válasz kód jelenti. Validációs hibák esetén 400-as válasz kód fog visszamenni az ügyfél felé, valamint a hibásan megadott értékek és a javításukhoz szükséges információk.
2. getProof():
| Erőforrás neve | Kérés típusa | Url | Paraméterek | Sikeres kérés esetén a válaszkód |
|---|---|---|---|---|
| getProof | Get | /rest/v2/order/{orderId}/consignment/{consignmentSequenceNumber}/proof |
| 200 |
A beküldés utáni következő lépés. Beküldés után a rendszer az átadott adatok alapján elkészíti a küldeményekhez tartozó mintákat. A megrendelés kap egy "minta elkészült" állapotot, ezután lehet csak lekérdezni a hozzá tartozó mintát. Ezek a minták PDF típusú fájlokként jönnek létre, amit ez a metódus base64 enkódolt formátumban fog visszajuttatni a mintát lekérő felé. A visszaküldött adatokból a fogadó oldalon elő lehet állítani a minta PDF fájlt. Ez a metódus, ahol a paraméter lista is sejteti, csak 1 küldeményhez tartozó minta PDF fájlt tud visszaadni. A rendszer által visszaadott minta PDF állományokra a továbbiakban nincs szükség, nyugodtan törölhető az ügyfélnél.
3. rejectOrder():
| Erőforrás neve | Kérés típusa | Url | Paraméterek | Sikeres kérés esetén a válaszkód |
|---|---|---|---|---|
| rejectOrder | Delete | /rest/v2/order/{orderId} |
| 204 |
A minta lekérés utáni egyik lehetőség. Ha a minták nem megfelelőek, akkor ennek segítségével lehet a megrendelést visszavonni. A visszavonás az egész megrendelésre vonatkozik, nincs lehetőség arra, hogy csak egyes küldemények legyenek visszavonva az adott megrendelésből. Visszavont rendelést a későbbiekben nem lehet mégis elfogadtatni, a visszavonás egy végleges művelet.
4. approveOrder():
| Erőforrás neve | Kérés típusa | Url | Paraméterek | Sikeres kérés esetén a válaszkód |
|---|---|---|---|---|
| approveOrder | Patch | /rest/v2/order/{orderId}/approve |
| 204 |
A minta lekérés utáni másik lehetőség. Ha a minták megfelelőek voltak, akkor ennek segítségével lehet a megrendelést elfogadni. Ebben az esetben a megrendelés automatikusan továbbítva lesz a gyártás felé. Az elfogadás a teljes megrendelésre vonatkozik, ami azt jelenti, hogy az összes benne található küldemény elfogadásra kerül. Az elfogadás egy végleges művelet, nincs lehetőség elfogadás után a visszavonásra.
A folyamat egy ábrán
Overview
Content Tools