input CancelOrderInput

Fields

Field	Type	Description
`customer_account_id`	`String`	Use this when you are a 3PL acting on behalf of one of your customers.
`order_id`	`String`!	The id of the order you want to modify.
`reason`	`String`	Human-readable reason for this order.
`cancel_on_platform`	`Boolean`	Whether to also cancel the order on the connected sales platform. The order is always canceled in ShipHero regardless of this flag. Defaults to true when omitted. When set to false, the connected sales platform cancellation is skipped and void_on_platform is ignored.
`void_on_platform`	`Boolean`	Shopify-only. Whether to attempt to reverse the order's payment on the sales platform when cancelling the order; ignored when cancel_on_platform is false. For Shopify orders, if the payment was authorized but not yet captured, the authorization is voided; if the payment was already captured, a refund is issued instead.
`force`	`Boolean`	Cancel an order even if it has valid labels and completed shipments.

Referenced By

order_cancel Mutation

Example

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