draftOrderCreateFromOrder
mutation

Choose a version:

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

Creates a draft order from order.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'DraftOrderCreateFromOrderPayload returns'

DraftOrderCreateFromOrderPayload returns

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

Was this section helpful?

Code examples for MUTATION: draftOrderCreateFromOrder

Query Reference for MUTATION: draftOrderCreateFromOrder

"mutation draftOrderCreateFromOrder($orderId: ID!) {\n  draftOrderCreateFromOrder(orderId: $orderId) {\n    draftOrder {\n      # DraftOrder fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: draftOrderCreateFromOrder

"{\n  \"orderId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: draftOrderCreateFromOrder

""

Display Examples for MUTATION: draftOrderCreateFromOrder

[
  {
    "example": {
      "type_name": "draftordercreatefromorder",
      "title": "Create a draft order from order",
      "description": "Create a draft order from order",
      "query_string": "mutation DraftOrderCreateFromOrder($orderId: ID!) {\n  draftOrderCreateFromOrder(orderId: $orderId) {\n    draftOrder {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "orderId": "gid://shopify/Order/148977776"
      },
      "response": {
        "data": {
          "draftOrderCreateFromOrder": {
            "draftOrder": {
              "id": "gid://shopify/DraftOrder/1069920479"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/draft_orders/test/unit/graph_api/admin/mutations/draft_order_create_from_order_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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",
      "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",
      "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",
      "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",
      "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"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "orderId",
          "description": "Specifies the order's id that we create the draft order from.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "orderId",
        "argValue": " \"gid://shopify/Order/148977776\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

draftOrderCreateFromOrdermutation

Arguments

DraftOrderCreateFromOrderPayload returns

draftOrderCreateFromOrder
mutation