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 creates an 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: Whether the payment is pending. Create a draft with payment terms rather than marking the draft as pending.

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

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/2024-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"

}