Skip to main content
POST
/
v1
/
salesOrders
/
{salesOrderId}
/
cancel
Cancel Sales Order
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v1/salesOrders/{salesOrderId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "CancellationReasonId": 123,
  "CancellationComment": "<string>"
}
'
{
  "ErrorCode": "<string>",
  "ValidationErrors": {},
  "Errors": {},
  "ErrorMessage": "<string>",
  "Stacktrace": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Path Parameters

​
salesOrderId
integer<int32>
required

The id of the sales order to cancel.

Body

application/json

The details for the cancellation to be performed.

Model Class: CreateSalesOrderCancellationDetails

​
CancellationReasonId
integer<int32>
required

The id of the reason for cancelling the sales order.

​
CancellationComment
string

A comment that adds further information to the cancellation.

Response