draftOrderDelete mutation

Version 2020-01 (Release candidate)

Deletes a draft order.

Required access

write_draft_orders access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( DraftOrderDeleteInput! ) required

Specify the draft order to delete by its ID.

DraftOrderDeleteInput fields

id (ID!) Required

The ID of the draft order to delete.

Return fields

deletedId (ID)

The ID of the deleted draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Latest)

Deletes a draft order.

Required access

write_draft_orders access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( DraftOrderDeleteInput! ) required

Specify the draft order to delete by its ID.

DraftOrderDeleteInput fields

id (ID!) Required

The ID of the draft order to delete.

Return fields

deletedId (ID)

The ID of the deleted draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07

Deletes a draft order.

Required access

write_draft_orders access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( DraftOrderDeleteInput! ) required

Specify the draft order to delete by its ID.

DraftOrderDeleteInput fields

id (ID!) Required

The ID of the draft order to delete.

Return fields

deletedId (ID)

The ID of the deleted draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04

Deletes a draft order.

Required access

write_draft_orders access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( DraftOrderDeleteInput! ) required

Specify the draft order to delete by its ID.

DraftOrderDeleteInput fields

id (ID!) Required

The ID of the draft order to delete.

Return fields

deletedId (ID)

The ID of the deleted draft order.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up