REST API Export údajů o produktech specifických pro pobočku V1

Tento zdroj slouží k aktualizaci údajů produktů v Quantu, které jsou specifické pro každou pobočku. Aktuálně používá JSON jako vstup i jako výstup.

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.

Automatická úloha

ID úlohy

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í údajů o produktech specifických pro pobočku zvolte atributy pro export volitelně upravte jejich JSON klíče

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 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ů
Zpoždění v sekundách před opakováním	Počet sekund, jak dlouho má čekat klient, než znovu zkusí provést export v případě dlouhé kolony požadavků na server.	celé číslo
Mapování údajů o produktech specifických pro pobočku	Mapování obsahující položku pro každý atribut, který má být exportován.	výběr
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
Sada produktů	Pomocí sady produktů můžete vybrat produkty, které požadujete exportovat.	výběr
Pobočky	Můžete zvolit, které pobočky se mají exportovat.	výběr

Nastavení

/v1/export/store-specific-product-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 JSON objekt obsahující tyto klíče:

Klíč	Hodnota
StoreIds	V rámci požadavku je potřeba uvést, pro jakou pobočku se mají produktové údaje exportovat. Vždy je možné zvolit pouze jednu pobočku. 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"}

Klíč	Hodnota
Status	Řetězec popisující výsledný stav exportu. SUCCESS = bezchybný průběh exportu PARTIAL_SUCCESS = export proběhl, ale vygeneroval jedno nebo více varování FAILURE = při exportu nastala jedna nebo více chyb
Warnings	Je volitelný, tzn. 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ň jednu chybu. Seznam řetězců s chybami.
Total Lines	Volitelný - je zahrnut pouze, pokud export neskončil se stavem "FAILURE" Počet záznamů na vstupu.
Ignored Products	Volitelný - Je zahrnut pouze, pokud export neskončil se stavem "FAILURE" Počet produktů ze vstupu, které se nevyexportovaly. Možné důvody jsou: Neexistující Id produktů a vypnuté vytváření nových produktů Id produktu se našlo mezi smazanými produkty a je zapnuté ignorování smazaných produktů

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 spustit znovu za počet sekund udávaných v hlavičce Retry-After.

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.

Zobrazit položky

curl -X POST --location "https://[VASE_SPOLECNOST].iquant.eu/v1/export/store-specific-product-data/149?debug" \

-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

-H "Accept: application/json" \

-H "Content-Type: application/json" \

-H "Cache-Control: no-cache" \

-d '[{ "Store ID": "12564"}]'

{

"Status": "SUCCESS", "Records": [

{"ID pobočky": "12564", "Primární ID produktu": "100001", "Zásoba": "12"},

{""ID pobočky": "12564", "Primární ID produktu": "100005", "Zásoba": "0"},

... ]

}