v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

return

Query Return Line Items

Query all line items for a specific return

get/v2/returns/{returnId}/lineitems

Path parameters

returnIdstring uuid required

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the return that the line items belong to.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

The requested line items.

idstring uuid

returnIdstring uuid

stateIdstring uuid

itemIdstring uuid

namestring

Name of the position.

sKUstring

SKU of the line item.

quantitynumber

The quantity of the line item.

returnReasonIdstring uuid

returnReasonCommentstring

The comment corresponding to the return line item reason.

conditionIdstring uuid

conditionCommentstring

The comment corresponding to the return line item condition.

creditboolean

Indicates whether this return line item should be credited. If omitted on creation, defaults to false.

salesOrderIdstring uuid

salesOrderLineItemIdstring uuid

deliveryNoteLineItemIdstring uuid

Example response

[
  {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "returnId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "stateId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "returnReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "conditionId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "deliveryNoteLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]