Nic nenalezeno

E-shop API – nastavení

Nahraje do portálu údaje o obchodě, ze kterých se skládají notifikace: zapnutí jazykových mutací, seznam jazyků, seznam obchodů (multistore), stavy objednávek a stavy vratek. Pošlete jen položky, které chcete změnit — ostatní zůstanou, jak jsou. Odpověď vždy vrací aktuální hodnoty všech položek.

API URL

Adresa URL používaná k odeslání požadavků HTTP:

https://portal.bulkgate.com/api/1.0/eshop/setup
Poznámka

Nedostane-li se požadavek k cíli, zopakujte ho na záložním serveru backup1.bulkgate.com.

Podporované HTTP metody

  • POST - application/json
POST /api/1.0/eshop/setup HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Tabulka s parametry

NÁZEV PARAMETRU HODNOTA POVINNÝ VÝCHOZÍ HODNOTA
application_id Aplikační identifikátor Ano -
application_token Aplikační ověřovací token Ano -
language_mutation Zapnutí jazykových mutací — true, nebo false Ne Beze změny
languages Jazyky obchodu — objekt kód: název Ne Beze změny
stores Obchody (multistore) — objekt id: název Ne Beze změny
order_status_list Stavy objednávek — objekt id: název Ne Beze změny
return_status_list Stavy vratek — objekt id: název Ne Beze změny

Každá poslaná položka seznam nahradí celý — položky, které v něm nepošlete, z portálu zmizí.

Jak portál položky použije

Jazykové mutace

Zapnuté language_mutation znamená, že zákaznické notifikace mají vlastní text pro každý jazyk ze seznamu languages. Portál pak text vybírá podle parametru language, který posíláte s každou událostí. Při vypnutých mutacích má každá zákaznická notifikace jediný text a jazyk se ignoruje. Administrátorské notifikace mají jeden text vždy.

Kód jazyka je to, co posíláte v parametru language — 1 až 16 znaků z písmen, číslic a podtržítka, např. cs nebo en_us. Pomlčka není povolená.

Obchody

Id obchodu je to, co posíláte v parametru shop_id. Notifikace se nastavují pro každý obchod zvlášť. Id má 1 až 20 znaků z písmen, číslic a podtržítka. Obchod bez multistore pošle jediný obchod s id 0 — události bez shop_id patří právě jemu.

Název obchodu podle shop_id události portál dosazuje do proměnné <shop_name>, pokud ji nepošlete sami. Když obchod s daným id v seznamu není, použije se první obchod ze seznamu.

Stavy objednávek a vratek

Pro každý stav ze seznamu nabídne portál v sekcích Zákaznické SMS a Administrátorské SMS notifikaci změny stavu. Id stavu je hodnota, kterou posíláte v proměnné order_status_id (změna stavu objednávky, resp. return_status_id (změna stavu vratky. Id má 1 až 29 znaků z písmen, číslic, podtržítka a pomlčky, např. ready-for-pickup.

Seznamy stavů smí být prázdné, seznam jazyků a obchodů ne. Název každé položky je neprázdný text o nejvýše 255 znacích.

Příklad požadavku

POST /api/1.0/eshop/setup HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language_mutation": true, "languages": { "cs": "Čeština", "en": "English" }, "stores": { "0": "BulkGate Shop CZ", "1": "BulkGate Shop SK" }, "order_status_list": { "processing": "Zpracovává se", "completed": "Vyřízeno", "cancelled": "Zrušeno" } }

Požadavek výše nezmění stavy vratek.

Odpověď

V případě úspěchu vrací aktuální hodnoty všech položek. Seznamy jsou vždy objekt, i když jsou prázdné:

{ "data": { "language_mutation": true, "languages": { "cs": "Čeština", "en": "English" }, "stores": { "0": "BulkGate Shop CZ", "1": "BulkGate Shop SK" }, "order_status_list": { "processing": "Zpracovává se", "completed": "Vyřízeno", "cancelled": "Zrušeno" }, "return_status_list": {} } }

Požadavek bez položek nic nemění a jen vrátí aktuální nastavení.

V případě chyby:

{ "type": "invalid_languages", "code": 400, "error": "Invalid languages", "detail": "Invalid identifier 'cs-CZ'." }

Kde:

  • type a error (popis chyby) najdete v tabulce typů chyb
  • code je HTTP kód chyby
  • detail je doplňující informace o chybě

Typy chyb

Když některá položka neprojde kontrolou, portál neuloží nic.

TYP KDY NASTANE
invalid_languages Seznam jazyků je prázdný, nebo obsahuje neplatný kód či název.
invalid_stores Seznam obchodů je prázdný, nebo obsahuje neplatné id či název.
invalid_order_status_list Seznam stavů objednávek obsahuje neplatné id či název.
invalid_return_status_list Seznam stavů vratek obsahuje neplatné id či název.
invalid_input_parameters Neznámý parametr, seznam zadaný jinak než jako objekt (např. jako text), nebo language_mutation, které není pravdivostní hodnota.
unknown_identity Chybí application_id nebo application_token, případně nejsou platné.
Byla tato stránka užitečná?