Skip to main content

cancelOrderV2

Cancels a V2 order.

Transitions the order to the "canceled" state. All active fulfillments are canceled as part of this operation.

Requirements​

  • User must have orders:cancel_order permission
  • Order must exist and be a V2 order
  • Caller must have authority over the order
  • No fulfillments may be in "in_progress" or "fulfilled" state

Arguments​

  • order_id (required): The ID of the order to cancel

Behavior​

  • Cancels all active fulfillments first
  • Transitions the order to "canceled" state
  • Returns the updated order
cancelOrderV2(
  input: V2CancelOrderInput!
): V2Order!

Arguments​

cancelOrderV2.input ● V2CancelOrderInput! non-null input common​

Parameters for V2CancelOrder

Type​

V2Order object orders​

The V2 order type. This type represents a V2 order in the system with only the fields necessary for draft creation and details.