E-shop API – nastavenia
Nahrá do portálu údaje o obchode, z ktorých sa skladajú notifikácie: zapnutie jazykových mutácií, zoznam jazykov, zoznam obchodov (multistore), stavy objednávok a stavy vratiek. Pošlite len položky, ktoré chcete zmeniť — ostatné zostanú, ako sú. Odpoveď vždy vracia aktuálne hodnoty všetkých položiek.
API URL
Adresa URL používaná na odosielanie HTTP požiadaviek:
Ak sa požiadavka nedostane k cieľu, zopakujte ju na záložnom serveri backup1.bulkgate.com.
Podporované HTTP metódy
POST-application/json
Tabuľka s parametrami
| NÁZOV PARAMETRA | HODNOTA | POVINNÝ | PREDVOLENÁ HODNOTA |
|---|---|---|---|
| application_id | Aplikačný identifikátor | Áno | - |
| application_token | Aplikačný overovací token | Áno | - |
| language_mutation | Zapnutie jazykových mutácií — true alebo false |
Nie | Bez zmeny |
| languages | Jazyky obchodu — objekt kód: názov |
Nie | Bez zmeny |
| stores | Obchody (multistore) — objekt id: názov |
Nie | Bez zmeny |
| order_status_list | Stavy objednávok — objekt id: názov |
Nie | Bez zmeny |
| return_status_list | Stavy vratiek — objekt id: názov |
Nie | Bez zmeny |
Každá poslaná položka zoznam nahradí celý — položky, ktoré v ňom nepošlete, z portálu zmiznú.
Ako portál položky použije
Jazykové mutácie
Zapnuté language_mutation znamená, že zákaznícke notifikácie majú vlastný text pre každý jazyk zo zoznamu languages. Portál potom text vyberá podľa parametra language, ktorý posielate s každou udalosťou. Pri vypnutých mutáciách má každá zákaznícka notifikácia jediný text a jazyk sa ignoruje. Administrátorské notifikácie majú jeden text vždy.
Kód jazyka je to, čo posielate v parametri language — 1 až 16 znakov z písmen, číslic a podčiarkovníka, napr. sk alebo en_us. Pomlčka nie je povolená.
Obchody
Id obchodu je to, čo posielate v parametri shop_id. Notifikácie sa nastavujú pre každý obchod zvlášť. Id má 1 až 20 znakov z písmen, číslic a podčiarkovníka. Obchod bez multistore pošle jediný obchod s id 0 — udalosti bez shop_id patria práve jemu.
Názov obchodu podľa shop_id udalosti portál dosadzuje do premennej <shop_name>, ak ju nepošlete sami. Keď obchod s daným id v zozname nie je, použije sa prvý obchod zo zoznamu.
Stavy objednávok a vratiek
Pre každý stav zo zoznamu ponúkne portál v sekciách Zákaznícke SMS a Administrátorské SMS notifikáciu zmeny stavu. Id stavu je hodnota, ktorú posielate v premennej order_status_id (zmena stavu objednávky, resp. return_status_id (zmena stavu vratky. Id má 1 až 29 znakov z písmen, číslic, podčiarkovníka a pomlčky, napr. ready-for-pickup.
Zoznamy stavov smú byť prázdne, zoznam jazykov a obchodov nie. Názov každej položky je neprázdny text s najviac 255 znakmi.
Príklad požiadavky
Požiadavka vyššie nezmení stavy vratiek.
Odpoveď
V prípade úspechu vracia aktuálne hodnoty všetkých položiek. Zoznamy sú vždy objekt, aj keď sú prázdne:
Požiadavka bez položiek nič nemení a len vráti aktuálne nastavenia.
V prípade chyby:
Kde:
- type a error (popis chyby) nájdete v tabuľke typov chýb
- code je HTTP kód chyby
- detail je doplňujúca informácia o chybe
Typy chýb
Keď niektorá položka neprejde kontrolou, portál neuloží nič.
| TYP | KEDY NASTANE |
|---|---|
invalid_languages |
Zoznam jazykov je prázdny alebo obsahuje neplatný kód či názov. |
invalid_stores |
Zoznam obchodov je prázdny alebo obsahuje neplatné id či názov. |
invalid_order_status_list |
Zoznam stavov objednávok obsahuje neplatné id či názov. |
invalid_return_status_list |
Zoznam stavov vratiek obsahuje neplatné id či názov. |
invalid_input_parameters |
Neznámy parameter, zoznam zadaný inak než ako objekt (napr. ako text) alebo language_mutation, ktoré nie je pravdivostná hodnota. |
unknown_identity |
Chýba application_id alebo application_token, prípadne nie sú platné. |
Ďakujeme za spätnú väzbu.