Nič sa nenašlo

E-shop API – objednávky

Udalosti objednávky: nová objednávka, zmena stavu, platba, číslo zásielky, zrušenie produktu a dobropis. Parametre požiadavky, výber notifikácie a tvar odpovede sú pre všetky rovnaké a popisuje ich prehľad E-shop API.

API URL

ENDPOINT UDALOSŤ NOTIFIKÁCIE
https://portal.bulkgate.com/api/1.0/eshop/order/new order_new
https://portal.bulkgate.com/api/1.0/eshop/order/change-status order_status_change_<order_status_id>
https://portal.bulkgate.com/api/1.0/eshop/order/payment order_payment_complete, order_payment_confirmation
https://portal.bulkgate.com/api/1.0/eshop/order/tracking-number order_tracking_number
https://portal.bulkgate.com/api/1.0/eshop/order/product-cancel order_product_cancel
https://portal.bulkgate.com/api/1.0/eshop/order/slip-add order_slip_add
Poznámka

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
POST /api/1.0/eshop/order/new HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Nová objednávka

eshop/order/new spustí notifikáciu udalosti order_new. Pošlite ju vo chvíli, keď zákazník objednávku dokončí.

POST /api/1.0/eshop/order/new HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language": "sk", "shop_id": "0", "variables": { "order_id": "10045", "order_total_paid": "1 290", "order_currency": "CZK", "order_payment": "Dobierka", "customer_firstname": "Ján", "customer_lastname": "Novák", "customer_email": "jan.novak@example.com", "customer_mobile": "777777777", "customer_country_id": "cz" } }

Zmena stavu objednávky

eshop/order/change-status hľadá notifikáciu pre konkrétny stav. Názov udalosti skladá z order_status_change_ a hodnoty premennej order_status_id, takže order_status_id posielajte vždy — bez nej portál notifikáciu k žiadnemu stavu nepriradí. Stavy, pre ktoré sa dá notifikácia nastaviť, nahrá váš e-shop cez nastavenia.

POST /api/1.0/eshop/order/change-status HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language": "sk", "variables": { "order_id": "10045", "order_status_id": "completed", "order_status": "Vybavená", "customer_mobile": "777777777", "customer_country_id": "cz" } }

Požiadavka vyššie použije notifikáciu nastavenú pre udalosť order_status_change_completed.

Platba objednávky

eshop/order/payment hľadá najprv notifikáciu order_payment_complete, a keď nastavená nie je, použije order_payment_confirmation. Zákaznícku a administrátorskú notifikáciu vyberá každú zvlášť — zákazník tak môže dostať order_payment_complete a administrátori order_payment_confirmation.

Číslo zásielky

eshop/order/tracking-number spustí notifikáciu order_tracking_number. Číslo zásielky a dopravcu odovzdajte v premenných, napr. order_carrier_tracking_number, order_carrier_name a order_carrier_url.

POST /api/1.0/eshop/order/tracking-number HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language": "sk", "variables": { "order_id": "10045", "order_carrier_name": "Packeta", "order_carrier_tracking_number": "Z1234567890", "customer_mobile": "777777777", "customer_country_id": "cz" } }

Zrušenie produktu a dobropis

  • eshop/order/product-cancel spustí notifikáciu order_product_cancel — produkt bol z objednávky zrušený.
  • eshop/order/slip-add spustí notifikáciu order_slip_add — k objednávke bol vystavený dobropis.

Odpoveď

{ "data": { "customer": [ { "status": "accepted", "message_id": "tmpde1bcd4b1d1", "part_id": ["tmpde1bcd4b1d1"], "number": "420777777777", "channel": "sms" } ] } }

Význam kľúčov customer a admin, chyby pri odoslaní a typy chýb nájdete v prehľade E-shop API.

Bola táto stránka užitočná?