Choose a version:

draftOrderComplete

mutation

Requires write_draft_orders access scope. Also: The user must have access to mark as paid, or set payment terms.

Completes a draft order and converts it into a regular order. The order appears in the merchant's orders list, and the customer can be notified about their order.

Use the draftOrderComplete mutation when a merchant is ready to finalize a draft order and create a real order in their store. The draftOrderComplete mutation also supports sales channel attribution for tracking order sources using the sourceName argument, cart validation controls for app integrations, and detailed error reporting for failed completions.

You can complete a draft order with different payment scenarios:

Mark the order as paid immediately.
Set the order as payment pending using payment terms.
Specify a custom payment amount.
Select a specific payment gateway.

Note

When completing a draft order, inventory is reserved for the items in the order. This means the items will no longer be available for other customers to purchase. Make sure to verify inventory availability before completing the draft order.

Arguments

Anchor to idid •ID!required: The draft order to complete.
Anchor to paymentGatewayIdpaymentGatewayId •ID: The gateway for the completed draft order.
Anchor to sourceNamesourceName •String: A channel definition handle used for sales channel attribution.
Anchor to paymentPendingpaymentPending •BooleanDeprecatedDefault:false

Was this section helpful?

Anchor to DraftOrderCompletePayload returnsDraftOrderCompletePayload returns

Anchor to draftOrderdraftOrder •DraftOrder: The completed draft order.
Anchor to userErrorsuserErrors •[UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Complete a draft order
Complete a draft order with payment pending
Completing a draft order with an invalid payment gateway returns a user error
draftOrderComplete reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation draftOrderComplete($id: ID!) {

draftOrderComplete(id: $id) {

draftOrder {

order {

}

}`,

{

variables: {

"id": "gid://shopify/DraftOrder/276395349"

);

const data = await response.json();

mutation draftOrderComplete($id: ID!) {
  draftOrderComplete(id: $id) {
    draftOrder {
      id
      order {
        id
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderComplete($id: ID!) { draftOrderComplete(id: $id) { draftOrder { id order { id } } } }",
 "variables": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation draftOrderComplete($id: ID!) {
    draftOrderComplete(id: $id) {
      draftOrder {
        id
        order {
          id
        }
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/DraftOrder/276395349"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation draftOrderComplete($id: ID!) {
      draftOrderComplete(id: $id) {
        draftOrder {
          id
          order {
            id
          }
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/DraftOrder/276395349"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation draftOrderComplete($id: ID!) {
    draftOrderComplete(id: $id) {
      draftOrder {
        id
        order {
          id
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DraftOrder/276395349"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/DraftOrder/276395349"

}

Response

JSON

{

"draftOrderComplete": {

"draftOrder": {

"id": "gid://shopify/DraftOrder/276395349",

"order": {

"id": "gid://shopify/Order/1073459966"

}