Creates an order return to return one or more items.
HTTP POSTX-Customer-Key: customer-key/api/v10/storefront.return-items
{
"items" : [ { // items to return (required)
"shipment" : 739820, // shipment (id) (required) - int(1…)
"position" : 5, // position of the item in the shipment (required) - int(0…)
"quantity" : 3.00, // quantity (required) - decimal[8,2](0…)
"reason" : 7, // reason (id) (van be null) - int(1…)
"comments" : "Size is too small" // comments - string(0…200)
}, … ]
}
{
"status" : "ok",
"id" : 2204819357 // identifier of the new created order return - int(1…)
}
Field | Type | Description |
---|---|---|
create | NotAvailable | Returns are not available for this installation |
item | InvalidValue | Item with shipment <shipment> and position <position> is not returnable |
quantity | InvalidValue | Quantity of a returned item is greater than its returnable quantity |
reason | NotFound | Reason <reason> does not exist |
shipment | NotFound | Shipment <shipment> does not exist |