REST API Import objednávek
Tento zdroj slouží k importu dat o objednávkách v Quantu. Vstupním i výstupním formátem je JSON.
Pro vytvoření a nastavení importu použijte dialog Automatické úlohy. Po vytvoření bude v seznamu úloh ID, které předáte v URL požadavku.
- Nastavení
Před použitím API je nutno upravit tyto atributy v záložce Nastavení:
- Zaškrtněte atribut Zapnuto pro povolení úlohy
- V atributu Uživatelé s povoleným přístupem pro API zvolte jednoho nebo více uživatelů s rolí Robot, kteří budou mít oprávnění úlohu spouštět
- V atributu Mapování atributů objednávkových dat zvolte atributy pro import a volitelně upravte jejich JSON klíče
Atributy
Atribut | Popis | Typ |
Zapnuto | Určuje, zda je daná automatické úloha aktivní a mohou přes ní být posílána data. | ano/ne |
Nadpis | Vlastní název automatické úlohy. | text |
Popis | Vlastní popis funkce automatické úlohy. | formátovaný text |
Poznámky | Poznámky. | dlouhý text |
E-maily k notifikacím | Jedna nebo více e-mailových adres, na které budou zasílány e-maily s chybovými stavy. | seznam řetězců |
Uživatelé s povoleným přístupem pro API | Uživatelé s rolí Robot, kteří jsou oprávněni úlohu spouštět. | seznam uživatelů |
Zpoždění v sekundách před opakováním | Počet sekund, jak dlouho má čekat klient, než znovu zkusí provést import v případě dlouhé kolony požadavků na server. | celé číslo |
Mapování atributů objednávkových dat | Mapování obsahující položku pro Id produktu, QID a Schválené množství. | komplexní typ |
Jednotka rozměru | Měrná jednotka jako cm, mm atd. | výběr |
Formát dat | Formát zápisu data, např. 31.12.19 | výběr |
Formát datumu a času | Formát zápisu data a času, např. 31.12.19 23:59:59 | výběr |
Oddělovač položek seznamu | Znak pro rozdělení položek seznamu hodnot. | znak |
- Požadavek
/v1/import/order-data/{id_ulohy}
Parametr | Hodnota |
URL | ?debug přidaný do URL zobrazí v odpovědi i varování. Bez toho se vypisují pouze chyby. |
Hlavička | Accept: application/json |
Hlavička | Content-type: application/json |
Hlavička | Authorization: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (viz. Přihlášení). |
Metoda | POST |
Obsahem požadavku je pole JSON objektů obsahující klíče definované v nastavení Mapování atributů objednávkových dat, konkrétně QID objednávky, primární ID produktu a schválené množství.
Odpověď
Klíč | Hodnota |
Status | Řetězec popisující výsledný stav importu.
|
Warnings | Volitelný - je zahrnut pouze, pokud je v URL parametr ?debug a import vygeneroval alespoň jedno varování. Seznam řetězců s varováními. |
Errors | Volitelný - je zahrnut pouze, pokud import vygeneroval alespoň jednu chybu. Seznam řetězců s varováními. |
Na základě požadavku Quant nastaví schválené množství všem produktům zaslaných v rámci dané objednávky. U produktů, které byly součastí objednávky, ale neobdrželi jsme informaci o schváleném množství, nastaví Quant schválené množtsví na 0. Současně změní stav objednávky na Objednáno. I po změně stavu objednávky je možné do objednávky přidat přes REST API import objednávek schválené množství dalšího produktu.
Stavové kódy
Stav | Význam |
200 OK | Import proběhl úspěšně s výsledným stavem "SUCCESS" nebo "PARTIAL_SUCCESS". Odpověď může obsahovat varování nebo nezávažné chyby. |
400 Bad Request | Chybné nastavení úlohy, nebo chybný požadavek. |
401 Unauthorized | Autorizační token je neplatný, nebo uživatel, který je tokenem přihlášen, nemá oprávnění spouštět tuto úlohu. |
404 Not Found | Nebyla nalezena úloha s ID daným v URL. |
500 Internal Server Error | Během importu nastala kritická chyba na straně serveru. |
503 Service Unavailable | Import již běží. Zkuste spustit znovu za počet sekund udávaných v hlavičce Retry-After. |
Záznam průběhu
V Quantu vedle nastavení úlohy lze prohlížet i záznamy průběhů jednotlivých importů, včetně statistik, chyb a varování.
Vybereme-li konkrétní záznam, můžeme zobrazit jeho detaily tlačítkem Zobrazit položky.
Požadavek
curl -X POST --location "https://[VASE_SPOLECNOST].iquant.eu/v1/import/order-data/54?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '[{"QID":"932554","Primární Id":"100034","Schválené množství":150}]'
Odpověď
{
"Status": "SUCCESS",
}