salesorder

Update Sales Order Custom Field

Update the value of a specific sales order custom field

patch/v2/salesOrders/{salesOrderId}/customfields/{customfieldId}

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
  Scopessalesorders.write
- or OAuth 2
  Client credentials
  Token URLhttps://auth.jtl-cloud.com/oauth2/token
  Scopessalesorders.write
TypeScript
https://skmtc.dev/jtl-software/apis/scx-authentication-api/docs/v2/salesOrders/:salesOrderId/customfields/:customfieldId/patch.ts
A function with typed inputs. Its response is checked against the schema.

salesOrderIdstring uuid required

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the sales order that the custom field belongs to.

customfieldIdstring uuid required

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the customfield that should be updated.

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.

valueobject

The custom field value. The object should match the custom field type.

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