REST API Import akčních produktů
Tento zdroj slouží k importu akčních produktů do Quantu. Prostřednictvím tohoto importu lze v Quantu zakládat různé promoční událost, které ovlivňují například objednávky nebo umístění produktů v planogramech. Vytvoření akcí můžete také použít pro tisk připravených cenovek. Pobočky si tak mohou změněné cenovky vytisknout ještě před zahájením prodeje akčních produktů. 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ů akčních produktů zvolte atributy pro import a volitelně upravte jejich JSON klíče.
- Dále doporučujeme vyplnit Emaily k notifikacím, kde zadáte jednu či více e-mailových adres, na které budou zasílány e-maily s chybovými stavy.
- 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 |
Emaily 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ždení v sekundách před opakováním | Počet sekund, jak dlouho má klient čekat, než znovu zkusí provést import v případě dlouhé kolony požadavků na server. | celé číslo |
Mapování atributů akčních produktů | Mapování obsahující položku pro Název akce, typ akce, datum zahájení a ukončení, ID poboček a ID produktů. | 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 oddělující jednotlivé položky v seznamu. | výběr |
Všechny pobočky pro prázdný seznam poboček | Označte, pokud požadujete, aby se v případě nevyplnění žádné pobočky, akce nastavila na všechny pobočky. | ano/ne |
Přepsat obsažené produkty a pobočky | Před importem budou všechny produkty obsažených poboček promazány a do akce budou znovu přiřazeny pouze produkty obsažené v daném běhu úlohy. | ano/ne |
Odstranit počáteční nuly z ID pobočky | Odstraní všechny nuly na začátku ID pobočky - např. z ID 0012 při importu vznikne ID 12. | ano/ne |
- Požadavek
/v1/import/action-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 | 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ů akčních produktů.
Je důležité, aby požadavek odpovídal standardům pro JSON formát. Kompletní definici těchto standardů najdete zde. Hodnoty číselných atributů prosím posílejte bez uvozovek viz příklad.
- 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 chybami. |
- 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 to spustit znova za počet sekund udávaných v hlavičce Retry-After. |
- Nejnovější logy
V Quantu lze vedle nastavení úlohy prohlížet záznamy jednotlivých importů, včetně statistik, chyb a varování.
Vybereme-li konkrétní záznam, můžeme zobrazit jeho detaily tlačítkem Stáhnout soubory.
- Požadavek
curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/import/action-products/311028?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[{"Datum zahájení":"1.11.24","Datum ukončení":"31.12.24","Primární ID produktu":"100006","Název":"Promo 2 2024","Pobočky":"12,12564", "Typ akce":"Letak","Akce platná do (Specifické pro pobočku)":"1.11.24","Základní prodejní cena":15.5,"Základní prodejní cena (Výchozí)":20},
{"Datum zahájení":"1.11.24","Datum ukončení":"31.12.24","Primární ID produktu":"100030","Název":"Promo 2 2024","Pobočky":"12,12564", "Typ akce":"Letak"}
]"
- Odpověď
{
"Status": "SUCCESS",
}