v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Return

View return

Return details of an existing return

get/api/v1/returns/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

One return.

Example response

{
  "data": {
    "id": "1",
    "date": "2023-03-16",
    "salesOrder": {
      "id": "1"
    },
    "positions": [
      {
        "id": "1",
        "quantity": 3,
        "salesOrderPosition": {
          "id": "1"
        },
        "product": {
          "id": "1",
          "number": "SKU-700010",
          "name": "Product name"
        },
        "returnReason": {
          "designation": "Damaged"
        }
      }
    ]
  }
}