Skip to main content

cancelOrderPayment

Records that the payment for the order was cancelled and moves its primary payment to cancelled. The order itself keeps its state; cancel it with cancelOrder. Fails with CONFLICT when the shop's payment state machine has no direct transition from the payment's current state to cancelled, or when the order has no payment. Does nothing when the payment is already cancelled. Fires the flows configured for the state change. Returns the order.

Required scopes​

The token needs the orders:write access scope.

cancelOrderPayment(
id: ID!
): Order!

Arguments​

cancelOrderPayment.id ● ID! non-null scalar​

ID of the order whose payment was cancelled.

Type​

Order object​

A customer order.