POST
/
api-order
/
orders
/
user
/
cancel
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/user/cancel \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "cancellationCode": "2001",
  "cancellationMessage": "Customer not interested"
}'
{
  "orderId": "8568-9704-74294",
  "status": "Successfully cancelled order"
}

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

​
Authorization
string
required

Query Parameters

​
orderId
string
required
Required string length: 15

Body

application/json
​
cancellationCode
string
required
​
cancellationMessage
string

Response

200
application/json
Successfully canceled order
​
orderId
string
​
status
string

Was this page helpful?

Return payment by orderIdAdd shipment bulk to order