# draftOrderComplete - admin-graphql - MUTATION Version: 2025-01 ## Description Completes a draft order and creates an order. ### Access Scopes `write_draft_orders` access scope. Also: The user must have access to mark as paid, or set payment terms. ## Arguments * [id](/docs/api/admin-graphql/2025-01/scalars/ID): ID! - The draft order to complete. * [paymentGatewayId](/docs/api/admin-graphql/2025-01/scalars/ID): ID - The gateway for the completed draft order. * [paymentPending](/docs/api/admin-graphql/2025-01/scalars/Boolean): Boolean - Whether the payment is pending. * [sourceName](/docs/api/admin-graphql/2025-01/scalars/String): String - A channel definition handle used for sales channel attribution. ## Returns * [draftOrder](/docs/api/admin-graphql/2025-01/objects/DraftOrder): DraftOrder The completed draft order. * [userErrors](/docs/api/admin-graphql/2025-01/objects/UserError): UserError! The list of errors that occurred from executing the mutation. ## Examples ### Complete a draft order Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation draftOrderComplete($id: ID!) { draftOrderComplete(id: $id) { draftOrder { id order { id } } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderComplete($id: ID!) {\n draftOrderComplete(id: $id) {\n draftOrder {\n id\n order {\n id\n }\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\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 draftOrderComplete($id: ID!) {\n draftOrderComplete(id: $id) {\n draftOrder {\n id\n order {\n id\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\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 draftOrderComplete($id: ID!) {\n draftOrderComplete(id: $id) {\n draftOrder {\n id\n order {\n id\n }\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DraftOrder/276395349\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation draftOrderComplete($id: ID!) {\n draftOrderComplete(id: $id) {\n draftOrder {\n id\n order {\n id\n }\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/DraftOrder/276395349" } #### Graphql Response { "data": { "draftOrderComplete": { "draftOrder": { "id": "gid://shopify/DraftOrder/276395349", "order": { "id": "gid://shopify/Order/1073459966" } } } } } ### Complete a draft order with payment pending Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation draftOrderComplete($id: ID!, $paymentPending: Boolean) { draftOrderComplete(id: $id, paymentPending: $paymentPending) { draftOrder { id order { id } } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"paymentPending\": true\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderComplete($id: ID!, $paymentPending: Boolean) {\n draftOrderComplete(id: $id, paymentPending: $paymentPending) {\n draftOrder {\n id\n order {\n id\n }\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"paymentPending\": true\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 draftOrderComplete($id: ID!, $paymentPending: Boolean) {\n draftOrderComplete(id: $id, paymentPending: $paymentPending) {\n draftOrder {\n id\n order {\n id\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"paymentPending\": true\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 draftOrderComplete($id: ID!, $paymentPending: Boolean) {\n draftOrderComplete(id: $id, paymentPending: $paymentPending) {\n draftOrder {\n id\n order {\n id\n }\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"paymentPending\": true\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation draftOrderComplete($id: ID!, $paymentPending: Boolean) {\n draftOrderComplete(id: $id, paymentPending: $paymentPending) {\n draftOrder {\n id\n order {\n id\n }\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/DraftOrder/276395349", "paymentPending": true } #### Graphql Response { "data": { "draftOrderComplete": { "draftOrder": { "id": "gid://shopify/DraftOrder/276395349", "order": { "id": "gid://shopify/Order/1073459967" } } } } } ### Completing a draft order with an invalid payment gateway returns a user error Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation draftOrderComplete($id: ID!, $paymentGatewayId: ID) { draftOrderComplete(id: $id, paymentGatewayId: $paymentGatewayId) { userErrors { message field } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"paymentGatewayId\": \"gid://shopify/PaymentGateway/12121213\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation draftOrderComplete($id: ID!, $paymentGatewayId: ID) {\n draftOrderComplete(id: $id, paymentGatewayId: $paymentGatewayId) {\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"paymentGatewayId\": \"gid://shopify/PaymentGateway/12121213\"\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 draftOrderComplete($id: ID!, $paymentGatewayId: ID) {\n draftOrderComplete(id: $id, paymentGatewayId: $paymentGatewayId) {\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"paymentGatewayId\": \"gid://shopify/PaymentGateway/12121213\"\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 draftOrderComplete($id: ID!, $paymentGatewayId: ID) {\n draftOrderComplete(id: $id, paymentGatewayId: $paymentGatewayId) {\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DraftOrder/276395349\",\n \"paymentGatewayId\": \"gid://shopify/PaymentGateway/12121213\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation draftOrderComplete($id: ID!, $paymentGatewayId: ID) {\n draftOrderComplete(id: $id, paymentGatewayId: $paymentGatewayId) {\n userErrors {\n message\n field\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/DraftOrder/276395349", "paymentGatewayId": "gid://shopify/PaymentGateway/12121213" } #### Graphql Response { "data": { "draftOrderComplete": { "userErrors": [ { "message": "Invalid payment gateway", "field": null } ] } } }