Skip to main content
GET
/
v1
/
onHoldReasons
Query On Hold Reasons
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/onHoldReasons \
  --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,
    "Name": "<string>",
    "IsMergeable": true,
    "ItemsNotUsedForPurchaseList": true
  }
]

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-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.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Response

Returns all payment methods.

​
Id
integer<int32>
required

Unique ID to identify an on hold reason.

​
Name
string
required

Name of the on hold reason.

​
IsMergeable
boolean
required

Indicates if orders with an on hold reason are allowed to be merged with other orders from the same customer.

​
ItemsNotUsedForPurchaseList
boolean
required

If this option is enabled, then the items in this order are not used for calculating the purchase list.