REST API Import náhrad produktů
Tento zdroj slouží k importu náhrad produktů do Quantu. Vstupním i výstupním formátem je JSON.
Pro vytvoření a nastavení importu 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ů náhrad 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 |
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ů |
Nahradit v připravených planogramech | Určuje, zda se náhrady mají provést i v připravených planogramech. | ano/ne |
Čas implementace ve dnech | Čas implementace ve dnech pro nahrazený implementovaný planogram. | ano/ne |
Vyžadovat fotku implementace | Určuje, zda se má vyžadovat fotka implementace při náhradě v implementovaném planogramu. | ano/ne |
Mapovací atribut | Atribut produktu v Quantu, pomocí kterého se budou párovat položky z importu s produkty v Quantu. | výběr |
Zpoždění v sekundách před opakováním | Doporučená prodleva v sekundách před opakováním požadavku v případě chyby 503. | celé číslo |
Mapování atributů náhrad | Mapování obsahující položku pro každý atribut, který má být importován. | komplexní typ |
Požadavek
/v1/import/product-replacement/{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ů náhrad.
Odpověď
Klíč | Hodnota |
Status | Řetězec popisující výsledný stav importu.
|
Warnings | Je volitelný, tzn. 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. |
Total Lines | Volitelný - je zahrnut pouze, pokud import neskončil se stavem "FAILURE" Počet záznamů na vstupu. |
Missing Products | Volitelný - je zahrnut pouze, pokud import neskončil se stavem "FAILURE" Počet záznamů, které byly přeskočeny, protože se nenašel produkt, na který záznam odkazuje. |
Duplicated Products | Volitelný - je zahrnut pouze, pokud import neskončil se stavem "FAILURE" Počet záznamů, které byly přeskočeny, protože tento produkt již byl importován ve stejném požadavku. |
Number of Missing Stores | Volitelný - je zahrnut pouze, pokud import neskončil se stavem "FAILURE" Počet záznamů, kde se nenašla odkazovaná pobočka. |
Empty IDs | Volitelný - je zahrnut pouze, pokud import neskončil se stavem "FAILURE" Počet záznamů, kde některá ID byla prázdná. |
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 "http://[VASE_SPOLECNOST].iquant.eu/v1/import/product-replacements/54?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '[{ "Primary Product ID": "100001", "Replacement ID": "12345"", "Store ID": "Praha 1" }]'
Odpověď
{
"Status": "SUCCESS",
"Total Lines": 1,
"Missing Products": 0,
"Empty IDs": 0,
"Duplicated Products": 0,
"Number of Missing Stores": 0
}