draftOrders - admin-graphql - QUERY

Version: 2024-04

Description:

List of saved draft orders.

Access Scopes

Arguments

• after: String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• before: String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• first: Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• last: Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• query: String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`
  - `query=title:green hoodie` | | created_at | time | | customer_id | id | | id | id | Filter by `id` range. | | | - `id:1234`
  - `id:>=1234`
  - `id:<=1234` | | source | string | | status | string | | tag | string | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
• reverse: Boolean - Reverse the order of the underlying list.
• savedSearchId: ID - The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument.
• sortKey: DraftOrderSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

Returns

• edges: DraftOrderEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: DraftOrder! A list of nodes that are contained in DraftOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
• pageInfo: PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

Examples

• Get the first 10 draft orders

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { draftOrders(first: 10) { edges { node { id } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    draftOrders(first: 10) {\n      edges {\n        node {\n          id\n        }\n      }\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  query {\n    draftOrders(first: 10) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    draftOrders(first: 10) {\n      edges {\n        node {\n          id\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  draftOrders(first: 10) {\n    edges {\n      node {\n        id\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "draftOrders": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/DraftOrder/12873508"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/14492994"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/15964851"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/17011624"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/33942910"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/35687358"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/35831665"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/57615313"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/116136825"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/138565067"
            }
          }
        ]
      }
    }
  }

  Get the first 10 draft orders created after December 1, 2019

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { draftOrders(first: 10, query: \\\"created_at:>2019-12-01\\\") { edges { node { id createdAt } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    draftOrders(first: 10, query: \"created_at:>2019-12-01\") {\n      edges {\n        node {\n          id\n          createdAt\n        }\n      }\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  query {\n    draftOrders(first: 10, query: \"created_at:>2019-12-01\") {\n      edges {\n        node {\n          id\n          createdAt\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<2019-12-01\") {\n      edges {\n        node {\n          id\n          createdAt\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    draftOrders(first: 10, query: \"created_at:>2019-12-01\") {\n      edges {\n        node {\n          id\n          createdAt\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  draftOrders(first: 10, query: \"created_at:>2019-12-01\") {\n    edges {\n      node {\n        id\n        createdAt\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "draftOrders": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/DraftOrder/12873508",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/14492994",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/15964851",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/17011624",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/33942910",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/35687358",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/35831665",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/57615313",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/116136825",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/138565067",
              "createdAt": "2021-12-01T12:42:15Z"
            }
          }
        ]
      }
    }
  }

  Get the first 10 draft orders with a status of 'OPEN'

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { draftOrders(first: 10, query: \\\"status:OPEN\\\") { edges { node { id status } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    draftOrders(first: 10, query: \"status:OPEN\") {\n      edges {\n        node {\n          id\n          status\n        }\n      }\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  query {\n    draftOrders(first: 10, query: \"status:OPEN\") {\n      edges {\n        node {\n          id\n          status\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    draftOrders(first: 10, query: \"status:OPEN\") {\n      edges {\n        node {\n          id\n          status\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  draftOrders(first: 10, query: \"status:OPEN\") {\n    edges {\n      node {\n        id\n        status\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "draftOrders": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/DraftOrder/12873508",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/14492994",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/15964851",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/17011624",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/33942910",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/35687358",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/35831665",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/57615313",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/116136825",
              "status": "OPEN"
            }
          },
          {
            "node": {
              "id": "gid://shopify/DraftOrder/138565067",
              "status": "OPEN"
            }
          }
        ]
      }
    }
  }

  Get the first draft order for a given customer

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { draftOrders(first: 1, query: \\\"customerId:544365967\\\") { edges { node { id status customer { firstName } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    draftOrders(first: 1, query: \"customerId:544365967\") {\n      edges {\n        node {\n          id\n          status\n          customer {\n            firstName\n          }\n        }\n      }\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  query {\n    draftOrders(first: 1, query: \"customerId:544365967\") {\n      edges {\n        node {\n          id\n          status\n          customer {\n            firstName\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    draftOrders(first: 1, query: \"customerId:544365967\") {\n      edges {\n        node {\n          id\n          status\n          customer {\n            firstName\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  draftOrders(first: 1, query: \"customerId:544365967\") {\n    edges {\n      node {\n        id\n        status\n        customer {\n          firstName\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "draftOrders": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/DraftOrder/12873508",
              "status": "OPEN",
              "customer": {
                "firstName": "Bob"
              }
            }
          }
        ]
      }
    },
    "extensions": {
      "search": [
        {
          "path": [
            "draftOrders"
          ],
          "query": "customerId:544365967",
          "parsed": {
            "field": "customerId",
            "match_all": "544365967"
          },
          "warnings": [
            {
              "field": "customerId",
              "message": "Invalid search field for this query."
            }
          ]
        }
      ]
    }
  }