input CancelOrderInput

Fields

FieldTypeDescription
customer_account_idString

Use this when you are a 3PL acting on behalf of one of your customers.

order_idString!

The id of the order you want to modify.

reasonString

Human-readable reason for this order.

void_on_platformBoolean

Whether or not to void the order on the sales platform.

forceBoolean

Cancel an order even if it has valid labels and completed shipments.

Referenced By

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "order_id": "T3JkZXI6MTIzNA==",
  "reason": "Customer requested expedited handling.",
  "void_on_platform": true,
  "force": true
}