orderDelete
mutation

Choose a version:

Requires write_orders access scope. Also: The user must have delete_orders permission.

Deletes an order. For more information on which orders can be deleted, refer to Delete an order.

Anchor to section titled 'Arguments'

Arguments

Anchor to orderId orderId ID! required: The ID of the order to be deleted.

Was this section helpful?

Anchor to section titled 'OrderDeletePayload returns'

OrderDeletePayload returns

Anchor to OrderDeletePayload.deletedId deletedId ID: Deleted order ID.
Anchor to OrderDeletePayload.userErrors userErrors [OrderDeleteUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: orderDelete

Query Reference for MUTATION: orderDelete

"mutation orderDelete($orderId: ID!) {\n  orderDelete(orderId: $orderId) {\n    deletedId\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderDelete

"{\n  \"orderId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: orderDelete

""

Display Examples for MUTATION: orderDelete

[]

orderDeletemutation

Arguments

OrderDeletePayload returns

orderDelete
mutation