Skip to main content
GET
/
v2
/
returns
/
{returnId}
/
packages
Query Return Packages
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/returns/{returnId}/packages \
  --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": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "returnId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "trackingID": "<string>",
    "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "shippingMethodCustom": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
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-companyid
string

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

Path Parameters

​
returnId
string<uuid>
required

The id of the return that the packages belong to.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

The requested packages.

​
id
string<uuid>

Unique ID to identify a return package.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
returnId
string<uuid>

Unique ID to identify a return.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
trackingID
string

The tracking Id of the package.

​
shippingMethodId
string<uuid>

The shipping method.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
shippingMethodCustom
string

The custom shipping method name used for the return. This value may only be set if ShippingMethodId is not provided.