Skip to main content

Cancel

POST 
/v1/fulfillment/orders/:orderId/cancel

Cancel the whole order when items is omitted, or selected SKU quantities when items are supplied. The required reasonCode comes from the channel-specific cancel-reasons read.

Requires orders.write.

Request and response fields at a glance
  • Path parameters: orderId (integer, required).
  • Request body (application/json): items (array), reasonCode (string, required).
  • 201 response (application/json): orderId (number, required), outcome (string, required), cancelledAt (mixed, required), cancelReasonCategory (mixed, required).

Request​