# draftOrderDelete - admin-graphql - MUTATION Version: 2024-10 ## Description Deletes a draft order. ### Access Scopes `write_draft_orders` access scope. Also: The user must have access to delete draft orders. ## Arguments * [input](/docs/api/admin-graphql/2024-10/input-objects/DraftOrderDeleteInput): DraftOrderDeleteInput! - Specify the draft order to delete by its ID. ## Returns * [deletedId](/docs/api/admin-graphql/2024-10/scalars/ID): ID The ID of the deleted draft order. * [userErrors](/docs/api/admin-graphql/2024-10/objects/UserError): UserError! The list of errors that occurred from executing the mutation. ## Examples ### Delete a draft order by ID and return the deleted ID Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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" 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" 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" 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" Graphql query: "mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n }\n}" #### Graphql Input { "input": { "id": "gid://shopify/DraftOrder/276395349" } } #### Graphql Response { "data": { "draftOrderDelete": { "deletedId": "gid://shopify/DraftOrder/276395349" } } } ### Deleting a draft order that doesn't exist returns an error Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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" 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" 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" 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" Graphql query: "mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n userErrors {\n message\n field\n }\n }\n}" #### Graphql Input { "input": { "id": "gid://shopify/DraftOrder/1" } } #### Graphql Response { "data": { "draftOrderDelete": { "deletedId": null, "userErrors": [ { "message": "Draft order not found", "field": null } ] } } } ### Remove an existing DraftOrder Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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 { field message } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n }\n}'\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 field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n },\n },\n});\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 field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\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 field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation draftOrderDelete($input: DraftOrderDeleteInput!) {\n draftOrderDelete(input: $input) {\n deletedId\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "input": { "id": "gid://shopify/DraftOrder/276395349" } } #### Graphql Response { "data": { "draftOrderDelete": { "deletedId": "gid://shopify/DraftOrder/276395349", "userErrors": [] } } }