E-shop API – orders
Order events: new order, status change, payment, tracking number, product cancellation and credit slip. Request parameters, notification selection and the response format are the same for all of them and are described in the E-shop API overview.
API URL
| ENDPOINT | NOTIFICATION EVENT |
|---|---|
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 |
If the request does not reach its destination, repeat it on the backup server backup1.bulkgate.com.
Supported HTTP methods
POST-application/json
New order
eshop/order/new triggers the notification of the order_new event. Send it when the customer completes the order.
Order status change
eshop/order/change-status looks up the notification for a specific status. It builds the event name from order_status_change_ and the value of the order_status_id variable, so always send order_status_id — without it the portal cannot match the notification to any status. Your e-shop uploads the statuses notifications can be set up for via the setup.
The request above uses the notification set up for the order_status_change_completed event.
Order payment
eshop/order/payment first looks for the order_payment_complete notification, and when it is not set up, it uses order_payment_confirmation. The customer and admin notifications are picked separately — so the customer can get order_payment_complete and the administrators order_payment_confirmation.
Tracking number
eshop/order/tracking-number triggers the order_tracking_number notification. Pass the tracking number and carrier in variables, e.g. order_carrier_tracking_number, order_carrier_name and order_carrier_url.
Product cancellation and credit slip
eshop/order/product-canceltriggers theorder_product_cancelnotification — a product was cancelled from the order.eshop/order/slip-addtriggers theorder_slip_addnotification — a credit slip was issued for the order.
Response
The meaning of the customer and admin keys, send errors and error types are described in the E-shop API overview.
Thank you for your feedback.