Skip to main content
GET
Query On Hold Reasons

Authorizations

Authorization
string
header
required

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

Headers

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

All on hold reasons.

id
string<uuid>

Unique ID to identify an on hold reason.

Example:

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

name
string

Name of the on hold reason.

isMergeable
boolean

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

itemsNotUsedForPurchaseList
boolean

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