draftOrderDelete mutation

Version unstable

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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-10 (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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-07 (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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-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

Argument Description
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!]!)

    The list of errors that occurred from executing the mutation.

Version 2021-01

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