v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

ReturnOrder

🔒 Create return order line item V3

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: return:update.

Create a new return order line item.

post/api/v3/returnOrders/{id}/lineItems

Path parameters

idstring required

Request body

namestring

Line item name. If not provided, the product name will be used.

descriptionstring

Line item description. If not provided, the product description will be used.

countryOfOriginstring

Country of origin for the product. If not provided, the product's country of origin will be used.

hsCodestring

Harmonized System (HS) code for the product. If not provided, the product's HS code will be used.

deliveryDatestring date

Delivery date of the line item.

deliveryDateAsCalendarWeekboolean

Whether to show the delivery date as calendar week or explicit.

internalCommentstring

Internal comment for the line item.

customerProductNumberstring

Customer product number for the line item.

unitstring

Unit of the line item (e.g., "kg", "pcs"). If not provided, the product's unit will be used.

Example request

{
  "product": {
    "id": "13"
  },
  "name": "Product X",
  "description": "Description of Product X",
  "countryOfOrigin": "DE",
  "hsCode": "0101.21",
  "deliveryDate": "2025-07-20",
  "internalComment": "This is an internal note.",
  "customerProductNumber": "CUS-10077",
  "unit": "pcs",
  "returnReason": {
    "id": "2"
  }
}

Response

Create a new 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"
    }
  }
}