draftOrderCreateFromOrder

mutation

Requires write_draft_orders access scope. Also: Requires write_orders access scope.

Creates a draft order from order.

Arguments

Anchor to orderIdorderId • ID!required: Specifies the order's id that we create the draft order from.

Was this section helpful?

Anchor to DraftOrderCreateFromOrderPayload returnsDraftOrderCreateFromOrderPayload returns

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

Was this section helpful?

Create a draft order from order
draftOrderCreateFromOrder reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation DraftOrderCreateFromOrder($orderId: ID!) {
6    draftOrderCreateFromOrder(orderId: $orderId) {
7      draftOrder {
8        id
9      }
10      userErrors {
11        field
12        message
13      }
14    }
15  }`,
16  {
17    variables: {
18      "orderId": "gid://shopify/Order/148977776"
19    },
20  },
21);
22
23const data = await response.json();
24

mutation DraftOrderCreateFromOrder($orderId: ID!) {
  draftOrderCreateFromOrder(orderId: $orderId) {
    draftOrder {
      id
    }
    userErrors {
      field
      message
    }
  }
}

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 DraftOrderCreateFromOrder($orderId: ID!) { draftOrderCreateFromOrder(orderId: $orderId) { draftOrder { id } userErrors { field message } } }",
 "variables": {
    "orderId": "gid://shopify/Order/148977776"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation DraftOrderCreateFromOrder($orderId: ID!) {
    draftOrderCreateFromOrder(orderId: $orderId) {
      draftOrder {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "orderId": "gid://shopify/Order/148977776"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DraftOrderCreateFromOrder($orderId: ID!) {
      draftOrderCreateFromOrder(orderId: $orderId) {
        draftOrder {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "orderId": "gid://shopify/Order/148977776"
    },
  },
});

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 DraftOrderCreateFromOrder($orderId: ID!) {
    draftOrderCreateFromOrder(orderId: $orderId) {
      draftOrder {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "orderId": "gid://shopify/Order/148977776"
}

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

Input variables

JSON

1{
2  "orderId": "gid://shopify/Order/148977776"
3}

Response

JSON

1{
2  "draftOrderCreateFromOrder": {
3    "draftOrder": {
4      "id": "gid://shopify/DraftOrder/1069920479"
5    },
6    "userErrors": []
7  }
8}