draftOrderDelete

Deletes a draft order.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the draftOrderDelete action (under Draft).
Fill in the fields below, then reference the result from later steps as {{draftorderdelete.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation DraftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

inputobjectrequired

Specify the draft order to delete by its ID.

idstringrequired

json

{
  "input": {
    "id": "string"
  }
}

Response

Read the result with {{draftorderdelete.response.data.data.draftOrderDelete}}. If the API returns errors, the step fails and they are at {{draftorderdelete.response.data.errors}}.

deletedIdstring

userErrorsarray<object>

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?