JTjtl-software
onholdreason

Query On Hold Reasons

Query all on hold reasons for sales orders

get/v2/onHoldReasons

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesorders.read, invoices.read
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesorders.read, invoices.read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

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

Returns all payment methods.

idstring uuid
namestring

Name of the on hold reason.

isMergeableboolean

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

itemsNotUsedForPurchaseListboolean

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

Example response

[
  {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.