v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
ReturnOrder

View return order line item V3

This endpoint requires the following scopes: return:read.

View a single return order line item.

get/api/v3/returnOrders/{id}/lineItems/{lineItemId}

Path parameters

idstring required
lineItemIdstring required

Query parameters

includestring[]

Response

View a single return order line item.

Example response

{
  "data": {
    "type": "product",
    "id": "1",
    "number": "2462-SK-D",
    "name": "Strawberry Jam",
    "description": "Delicious strawberry jam made from fresh strawberries.",
    "quantity": 2,
    "product": {
      "createdAt": "2025-03-15T09:27:00+01:00",
      "updatedAt": "2025-10-20T14:45:12+01:00"
    },
    "customFields": [
      {
        "key": "customer_category",
        "value": "Premium",
        "label": "Customer Category"
      },
      {
        "key": "priority_level",
        "value": "High",
        "label": "Priority Level"
      }
    ],
    "unit": "kg",
    "packagingUnit": "box",
    "internalComment": "This is an internal comment.",
    "customerProductNumber": "CUS-10077",
    "order": 5,
    "updatedAt": "2023-10-01T12:00:00Z",
    "createdAt": "2023-10-01T12:00:00Z",
    "salesOrderLineItem": {
      "id": "1"
    },
    "deliveredQuantity": 2,
    "reimbursementQuantity": 5.1,
    "receivedQuantity": 5.2,
    "returnReason": {
      "id": "2"
    },
    "parentLineItem": {
      "id": "1"
    },
    "deliveryNoteLineItem": {
      "id": "1"
    },
    "defaultStorageLocation": {
      "id": "1"
    }
  }
}