draftOrderCreateFromOrder - admin-graphql - MUTATION

Version: 2024-10

Description:

Creates a draft order from order.

Access Scopes

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

Arguments

• orderId: ID! - Specifies the order's id that we create the draft order from.

Returns

• draftOrder: DraftOrder The created draft order.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Create a draft order from order

          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 DraftOrderCreateFromOrder($orderId: ID!) { draftOrderCreateFromOrder(orderId: $orderId) { draftOrder { id } userErrors { field message } } }\",\n \"variables\": {\n    \"orderId\": \"gid://shopify/Order/148977776\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation DraftOrderCreateFromOrder($orderId: ID!) {\n      draftOrderCreateFromOrder(orderId: $orderId) {\n        draftOrder {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"orderId\": \"gid://shopify/Order/148977776\"\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 DraftOrderCreateFromOrder($orderId: ID!) {\n    draftOrderCreateFromOrder(orderId: $orderId) {\n      draftOrder {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"orderId\": \"gid://shopify/Order/148977776\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation DraftOrderCreateFromOrder($orderId: ID!) {\n    draftOrderCreateFromOrder(orderId: $orderId) {\n      draftOrder {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"orderId\" => \"gid://shopify/Order/148977776\",\n];\n\n$response = $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 DraftOrderCreateFromOrder($orderId: ID!) {\n    draftOrderCreateFromOrder(orderId: $orderId) {\n      draftOrder {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"orderId\": \"gid://shopify/Order/148977776\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation DraftOrderCreateFromOrder($orderId: ID!) {\n  draftOrderCreateFromOrder(orderId: $orderId) {\n    draftOrder {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "orderId": "gid://shopify/Order/148977776"
  }

  response: {
    "data": {
      "draftOrderCreateFromOrder": {
        "draftOrder": {
          "id": "gid://shopify/DraftOrder/1069920479"
        },
        "userErrors": []
      }
    }
  }