Anchor to section titled 'undefined'draft
draft
mutation
2024-07
Requires write access scope. Also: The user must have access to delete draft orders.
Deletes a draft order.
Anchor to section titled 'Arguments'
Arguments
Specify the draft order to delete by its ID.
Was this section helpful?
Anchor to section titled 'DraftOrderDeletePayload returns'
DraftOrderDeletePayload returns
The ID of the deleted draft order.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: draftOrderDelete
Query Reference for MUTATION: draftOrderDelete
"mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: draftOrderDelete
"{\n \"input\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n }\n}"Schema Reference for MUTATION: draftOrderDelete
"input DraftOrderDeleteInput {\n id: ID!\n}\n"Display Examples for MUTATION: draftOrderDelete
[
{
"example": {
"type_name": "draftorderdelete",
"title": "Delete a draft order by ID and return the deleted ID",
"query_string": "mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/DraftOrder/276395349"
}
},
"response": {
"data": {
"draftOrderDelete": {
"deletedId": "gid://shopify/DraftOrder/276395349"
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/draft_orders/test/unit/graph_api/admin/mutations/draft_order_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation draftOrderDelete($input: DraftOrderDeleteInput!) { draftOrderDelete(input: $input) { deletedId } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/DraftOrder/276395349\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Specify the draft order to delete by its ID.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DraftOrderDeleteInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "DraftOrderDeleteInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"id\":\"gid://shopify/DraftOrder/276395349\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "draftorderdelete",
"title": "Deleting a draft order that doesn't exist returns an error",
"query_string": "mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n userErrors {\n message\n field\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/DraftOrder/1"
}
},
"response": {
"data": {
"draftOrderDelete": {
"deletedId": null,
"userErrors": [
{
"message": "Draft order not found",
"field": null
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/draft_orders/test/unit/graph_api/admin/mutations/draft_order_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation draftOrderDelete($input: DraftOrderDeleteInput!) { draftOrderDelete(input: $input) { deletedId userErrors { message field } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/1\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/1\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/1\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/1\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n userErrors {\n message\n field\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/DraftOrder/1\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Specify the draft order to delete by its ID.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DraftOrderDeleteInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "DraftOrderDeleteInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"id\":\"gid://shopify/DraftOrder/1\"}",
"typeKind": "MUTATION"
}
]
}
]