JTjtl-software
salesorder

Cancel Sales Order

Cancel a specific sales order

post/v2/salesOrders/{salesOrderId}/cancel

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

Path parameters

salesOrderIdstring uuid required
Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the sales order to cancel.

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.

Request body

cancellationReasonIdstring uuid
cancellationCommentstring

A comment that adds further information to the cancellation.

Example request

{
  "cancellationReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

Changes

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