E-shop API – returns
Return events: a customer created a new return, or its status changed. Request parameters, notification selection and the response format are described in the E-shop API overview.
API URL
| ENDPOINT | NOTIFICATION EVENT |
|---|---|
https://portal.bulkgate.com/api/1.0/eshop/return/new |
product_return |
https://portal.bulkgate.com/api/1.0/eshop/return/change-status |
return_status_change_<return_status_id> |
If the request does not reach its destination, repeat it on the backup server backup1.bulkgate.com.
Supported HTTP methods
POST-application/json
New return
eshop/return/new triggers the notification of the product_return event. Pass the return data using variables from the Return group, e.g. return_id, return_reason or return_products1.
Return status change
eshop/return/change-status looks up the notification for a specific status. It builds the event name from return_status_change_ and the value of the return_status_id variable, so always send return_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 return_status_change_3 event.
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.