Returns
Check returns in
Like checking a box in on the Returns window: each item goes back to stock or is written off with a reason. Without lines, every item still open goes back to stock (or, with all_as: damaged, is written off as damaged). Stock moves only here, and it shows in the stock history under the key's name. All or nothing: if one return can't be checked in, none is.
Then the couriers that want it (the Ecotrack family) are told the parcels reached you; courier reports their answers. A courier that doesn't answer never undoes the check-in.
Body
- returnsarray of objectsRequired
up to 200 items · at least 1 item
3 child fields
- order_idstringRequired
starts with ord_
- all_asstring
Without lines
One of
restock,damaged - linesarray of objects
up to 100 items · at least 1 item
5 child fields
- idstringRequired
The item's id from the return.
- restockinteger
0–9999
- write_offinteger
0–9999
- reasonstring
Required with write_off.
One of
damaged,missing,used,wrong_item,other - notestring
up to 500 characters
Returns
200 OK · What was checked in. ReturnCheckIn
- objectstring
always "return_check_in"
- returnsinteger
- completedinteger
Returns with every item now checked in.
- restockedinteger
- written_offinteger
- courierobject
What the couriers said when told the parcels arrived (only couriers that ask for it).
5 child fields
- confirmedinteger
- not_eligibleinteger
- not_foundinteger
- failedinteger
- errorstring or null
Errors
Every error has the same shape. This endpoint can answer with:
