Description

Cancel an order.

Permission bit: "orders.cancel"

Topic: Orders

Arguments

data: OrderCancel!

Main argument for mutations.

order_id: String!

Unique order identifier. See also: Unique Identifiers

Example: "or_EQzGqWoY"

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

Data Argument Fields

archive: Boolean

Whether to archive order or not

Example: false

notify: Boolean

Whether to notify customer about order cancellation via email or not

Example: false

reason: OrderCancelReason

The reason why the order was canceled

refund: OrderRefund

Result

Order

Preview (typescript)

Loading module