returnable-items

Returns the items that the customer can return.

Request

HTTP POST
X-Customer-Key: customer-key
/api/v10/storefront.returnable-items

{
  "conditions" : { // returns only the returnable items …
    "shipments" : [ 739820, 732071, … ] // … that are in these shipments (id) - int(1…)
  },
  "fields" : [ "id", "number", "status", … ], // returns only these fields - string
}

Response

{
  "status" : "ok",
  "items" : [ { // items that can be returned
    "shipment" : 739820, // shipment (id) - int(1…)
    "position" : 5, // position of the item in the shipment - int(1…)
    "sku" : "A927TP", // SKU - string(0…40)
    "deliveryDate" : "2020-10-28", // date of the delivery - date
    "automaticallyApproved" : true, // indicates if returns are automatically approved - bool
    "info" : "...", // information for the customer - string(0…1000)
    "reasons" : [ { // applicable return reasons
      "id" : 7, // identifier - int(1…)
      "description": "Item damaged" // description - string(0…120)
    }, … ],
    "name" : "Shits", // name - string(0…255)
    "orderNumber" : "2020/5613", // order number - string(0…32)
    "quantity" : 3.00, // quantity - decimal[8,2](0…)
    "unitOfMeasure" : { // unit of measure
      "name" : "Kg", // name - string(0…32)
      "decimalPlaces" : 2 // decimal places - int(0…2)
    }
  }, … ]
}