Returns
Mark a return as arrived
"It arrived": the parcel is back in your hands, for a courier that doesn't report the hand-back itself. Stock doesn't move until the check-in.
Path parameters
- order_idstringRequired
starts with ord_
Returns
200 OK · The return, now received. Return
- objectstring
always "return"
- order_idstring
- order_numberstring or null
- kindstring
exchange: the items an exchange order collected from the customer.
One of
return,exchange - stagestring
One of
in_transit,received - readyboolean
The courier has the parcel waiting to be picked up.
- ready_atstring or null
ISO 8601 date-time, UTC
- returned_atstring or null
ISO 8601 date-time, UTC
- received_atstring or null
ISO 8601 date-time, UTC
- original_order_idstring or null
For an exchange
- customerobject
2 child fields
- namestring or null
- phonestring or null
- courierstring or null
- tracking_codestring or null
- courier_statusstring or null
The courier's own words for the parcel's state.
- totalMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- itemsarray of objects
9 child fields
- idstring
li_… for a return, xli_… for an exchange. Pass it to check_in.
- product_idstring or null
- variant_idstring or null
- titlestring
- variant_titlestring or null
- quantityinteger
- image_urlstring or null
- tracks_stockboolean
false when the variant doesn't track stock (restocking it moves nothing).
- checked_inboolean
- livemodeboolean
Errors
Every error has the same shape. This endpoint can answer with:
