REST API Export umístěných produktů V1
Tento zdroj slouží k exportu produktů umístěných v planogramech v Quantu. Vstupním i výstupním formátem je JSON.
Pro vytvoření a nastavení exportu použijte sekci 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ů umístěných produktů zvolte atributy pro export 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 |
Titul | Vlastní název automatické úlohy. | text |
Popis | Vlastní popis funkce automatické úlohy. | formátovaný text |
Poznámky | Poznámky. | dlouhý text |
E-maily pro notifikace | 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ů |
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 |
Mapovací atribut umístěného produktu | Mapování obsahující položku pro každý atribut umístěného produktu, který má být exportován. | komplexní typ |
Pobočky | Filtr určující, které pobočky jsou zahrnuty v exportu. | komplexní typ |
Úroveň kumulace | Výběr kumulace dle úrovně Blok / Police / Vybavení / Pobočka / Stav. Více o nastavení Úrovně kumulace naleznete v manuálu Export do excelu. | výběr |
Umístěné produkty | V exportu budou zahrnuty produkty umístěné v planogramech. | ano/ne |
Neumístěné produkty | V exportu budou zahrnuty produkty umístěné v šabloně planogramu, ale nikoli v planogramu (přeškrtnuté v šabloně). | ano/ne |
Neumístěné produkty z příručního skladu | V exportu budou zahrnuty neumístěn produkty, které mají zároveň na bloku nastaveno, že jsou v příručním skladu. | ano/ne |
Typ prostoru | Výběr, zda chcete vidět prostorové údaje jako m, m2 či m3. | výběr |
Úroveň normalizované kategorie | Úroveň kategorií v rámci hierarchie, kterou chcete zobrazit v exportu. | číslo |
Požadavek
/v1/export/placed-products/{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 (volitelná) | Accept-Encoding: gzip, deflate, br |
Hlavička | Authorization: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (viz. Přihlášení). |
Metoda | POST |
Obsahem požadavku je JSON objekt obsahující tyto klíče:
Klíč | Hodnota |
PlanogramStates | Samostatný řetězec nebo pole řetězců určující, které stavy planogramů budou exportem zpracovány. Možné hodnoty: PREPARED / WAITING / IMPLEMENTED Příklady: { "PlanogramStates": "PREPARED" } { "PlanogramStates": [ "PREPARED", "WAITING" ] } |
StoreIds | Volitelné pole řetězců určující, které pobočky budou exportem zpracovány. Id pobočky musí být vždy zadáno jako řetězec, i když se jedná pouze o jednu pobočku. Je-li vyplněna pouze prázdná hodnota, provede se export všech poboček zadaných v nastavení automatické úlohy. Pokud v nastavení automatický úlohy není například pobočka s Id "12" zahrnuta a pošle se požadavek na tuto pobočku exportuje se pouze prázdná hodnota. Příklady: { "StoreIds": [ "12" ] } { "StoreIds": [ "12", "135","209" ] } |
Odpověď
Klíč | Hodnota |
Status | Řetězec popisující výsledný stav exportu.
|
Warnings | Volitelný - je zahrnut pouze, pokud je v URL parametr ?debug a export vygeneroval alespoň jedno varování. Seznam řetězců s varováními. |
Errors | Volitelný - je zahrnut pouze, pokud export vygeneroval alespoň jedno chybu. Seznam řetězců s chybami. |
Records | Volitelný - je zahrnut pouze, pokud export neskončil se stavem "FAILURE". Seznam exportovaných objektů. Každý objekt obsahuje klíče definované mapováním v nastavení úlohy. |
Stavové kódy
Stav | Význam |
200 OK | Export 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 exportu nastala kritická chyba na straně serveru. |
503 Service Unavailable | Export již běží. Zkuste to spustit znova 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 exportů, 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 "http://localhost:4150/v1/export/placed-products/10?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '{ "PlanogramStates": ["PREPARED", "WAITING"] , "StoreIds": [ "12" ] }'
Odpověď
{
"Status": "SUCCESS", "Records": [
{"Planogram ID": "166882", "Primary Product ID": "100001", "Fixture ID": "1231"},
{"Planogram ID": "166850", "Primary Product ID": "100005", "Fixture ID": "1232"},
... ]
}