Skip to main content
GET
/
returns
/
{returnId}
/
lineitems
Query Return Line Items
curl --request GET \
  --url https://api.jtl-cloud.com/erp/returns/{returnId}/lineitems \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "Id": 123,
    "ReturnId": 123,
    "StateId": 123,
    "ItemId": 123,
    "Name": "<string>",
    "SKU": "<string>",
    "Quantity": 123,
    "ReturnReasonId": 123,
    "ConditionId": 123,
    "ConditionComment": "<string>",
    "Credit": true,
    "SalesOrderId": 123,
    "SalesOrderLineItemId": 123,
    "DeliveryNoteLineItemId": 123,
    "ReturnReasonComment": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

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

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

​
returnId
integer<int32>
required

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

Response

The requested line items.

​
Id
integer<int32>
required

Unique ID to identify a return line item.

​
ReturnId
integer<int32>
required

Unique ID to identify a return.

​
StateId
integer<int32>
required

The id of the return line item state.

​
ItemId
integer<int32>
required

Unique ID to identify an item.

​
Name
string
required

Name of the position.

​
SKU
string
required

SKU of the line item.

​
Quantity
number<decimal>
required

The quantity of the line item.

​
ReturnReasonId
integer<int32>
required

Unique ID to identify a return reason.

​
ConditionId
integer<int32>
required

Unique ID to identify a condition.

​
ConditionComment
string
required

The comment corresponding to the return line item condition.

​
Credit
boolean
required

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

​
SalesOrderId
integer<int32>
required

Unique ID to identify a sales order file.

​
SalesOrderLineItemId
integer<int32>
required

Unique ID to identify a sales order item.

​
DeliveryNoteLineItemId
integer<int32>
required

Unique ID to identify a delivery note item.

​
ReturnReasonComment
string

The comment corresponding to the return line item reason.