draftOrderDelete mutation

Deletes a draft order.

Required access

write_draft_orders access scope.

On this page

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.

mutation draftOrderDelete($input: DraftOrderDeleteInput!) { draftOrderDelete(input: $input) { 
  1. <font style="color:#1F61A0;">deletedId</font>
  3. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  5.   <font style="color:#1F61A0;">field</font>
  7.   <font style="color:#1F61A0;">message</font>
  9. <font style="color:#555555;">}</font>
} } { “input”: { 
  1. <font style="color:#8B2BB9;">"id"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font>
} }

Arguments

Argument Description
input
(
[DraftOrderDeleteInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorderdeleteinput)

) REQUIRED		 Specify the draft order to delete by its ID.

DraftOrderDeleteInput fields

  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The ID of the draft order to delete.

Return fields

  • deletedId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    The ID of the deleted draft order.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.