Order Cancellation - In progress
The purpose of this document is to describe in details and give good understanding how we can cancel orders on The Range.
The Range has only one end point for Shipping & Cancelling order. The differences are into the information in the body of the request. However, this page will describe only the Cancel flow.
API Call: https://supplier.rstore.com/rest/order_event.api?supplier_id=1
API Docs: https://marketplacetherange.zendesk.com/hc/en-gb/articles/360018519698-API-Order-Event
Example call:
{
"order_number": "W000001-1D-S",
"cancel": 1,
"cancel_code": "Stock not available",
"cancel_reason": "There wasn't any stock around after all",
"item_arr": [
{
"code": "123456",
"qty": 2
},
{
"code": "654321",
"qty": 1
}
],
"mode": "Test"
}Mapping:
| Integration Field | Integration Notes | Integration required | Hemi Mapping | Hemi Notes | |
|---|---|---|---|---|---|
order_number |
the order number for which items are being despatched/cancelled. | Yes | Orders > Marketplace Order ID | ||
cancel |
determines whether the event is a cancellation or despatch. By default if not provided it is despatch. May either be 1 for cancel, or 0 for despatch. | No | If we would want to cancel order we should hardcode '1' | ||
cancel_code |
this is only used if the items are being cancelled. The following codes are acceptable: "Stock not available", "Unable to contact customer to arrange delivery", "Unable to deliver to address" | No | |||
cancel_reason |
this is only used if the items are being cancelled. This may be any free text reason for the cancellation. | No | |||
item_arr |
array of items that are being despatched/cancelled. Each entry in the array must be of the format: { "code": "123"," qty": 1} | Yes | |||
code |
product code used by you to identify a product | Yes | Order Item Line > Marketplace Order Item ID | TBD | |
qty |
quantity of being despatched or cancelled in this event. | Yes | Order Item Line > Quantity | TBD |