The Range - Order Shipping & Tracking - In progress
The purpose of this page is to describe in details how we ship orders on the “The Range“ marketplace.
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 Shipping flow.
The Range ship orders, using order number, which is returned by Order Feed API call.
Also, The Range supports partial shipments.
To ship the order we should have payment record for the order, order status to be on “Ready For Shipping“ & Shipment = Pending (waiting for information to be sent to the MP). Then, to ship the order, we need to push the order number, delivery service, courier name, tracking reference and also the product codes (which are equal to our SKUs??) of the products we would want to ship.
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",
"delivery_service": "RM Saver Delivery",
"courier_name": "Royal Mail",
"earliest_delivery": "2016-05-21",
"latest_delivery": "2016-05-23",
"tracking_reference": "GB12345AB",
"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 | ||
delivery_service |
this is required only if the event is a despatch. This must contain the name of a delivery service that has been set up for this supplier in Kube | Yes | TBD | ||
courier_name |
this is required only if the event is a despatch. Free text name of the courier used for despatch. | Yes | Order Shipment > Courier | ||
earliest_delivery |
this is required only if the event is a despatch. This must contain the earliest estimated date the delivery will arrive. Must be of the format "YYYY-MM-DD". | No | TBD | ||
latest_delivery |
this is required only if the event is a despatch. This must contain the latest estimated date the delivery will arrive. Must be of the format "YYYY-MM-DD". | No | TBD | ||
tracking_reference |
this is required only if the event is a despatch. Tracking reference for the despatch | Yes | Order Shipment > Tracking Number | ||
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 | Our SKU? TBD | |
qty |
quantity of being despatched or cancelled in this event. | Yes | Order Item Line > Quantity | TBD | |
mode |
either "Test", or "Live", the expected mode the supplier account is in. | Yes |
Example success response:
Error cases: