draftOrder - admin-graphql - QUERY

Version: 2024-07

Description:

Returns a DraftOrder resource by ID.

Access Scopes

Arguments

• id: ID! - The ID of the `DraftOrder` to return.

Returns

• acceptAutomaticDiscounts: Boolean Whether or not to accept automatic discounts on the draft order during calculation. If false, only discount codes and custom draft order discounts (see `appliedDiscount`) will be applied. If true, eligible automatic discounts will be applied in addition to discount codes and custom draft order discounts.
• allowDiscountCodesInCheckout: Boolean! Whether discount codes are allowed during checkout of this draft order.
• appliedDiscount: DraftOrderAppliedDiscount The custom order-level discount applied.
• billingAddress: MailingAddress The billing address of the customer.
• billingAddressMatchesShippingAddress: Boolean! Whether the billing address matches the shipping address.
• completedAt: DateTime The date and time when the draft order was converted to a new order, and had it's status changed to **Completed**.
• createdAt: DateTime! The date and time when the draft order was created in Shopify.
• currencyCode: CurrencyCode! The shop currency used for calculation.
• customAttributes: Attribute! The custom information added to the draft order on behalf of the customer.
• customer: Customer The customer who will be sent an invoice.
• defaultCursor: String! A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID.
• discountCodes: String! All discount codes applied.
• email: String The email address of the customer, which is used to send notifications.
• hasTimelineComment: Boolean! Whether the merchant has added timeline comments to the draft order.
• id: ID! A globally-unique ID.
• invoiceEmailTemplateSubject: String! The subject defined for the draft invoice email template.
• invoiceSentAt: DateTime The date and time when the invoice was last emailed to the customer.
• invoiceUrl: URL The link to the checkout, which is sent to the customer in the invoice email.
• legacyResourceId: UnsignedInt64! The ID of the corresponding resource in the REST Admin API.
• lineItemsSubtotalPrice: MoneyBag! A subtotal of the line items and corresponding discounts, excluding include shipping charges, shipping discounts, taxes, or order discounts.
• marketName: String! The name of the selected market.
• marketRegionCountryCode: CountryCode! The selected country code that determines the pricing.
• metafield: Metafield A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• name: String! The identifier for the draft order, which is unique within the store. For example, _#D1223_.
• note2: String The text from an optional note attached to the draft order.
• order: Order The order that was created from the draft order.
• paymentTerms: PaymentTerms The associated payment terms for this draft order.
• phone: String The assigned phone number.
• platformDiscounts: DraftOrderPlatformDiscount! The list of platform discounts applied.
• poNumber: String The purchase order number.
• presentmentCurrencyCode: CurrencyCode! The payment currency used for calculation.
• privateMetafield: PrivateMetafield Returns a private metafield by namespace and key that belongs to the resource.
• purchasingEntity: PurchasingEntity The purchasing entity.
• ready: Boolean! Whether the draft order is ready and can be completed. Draft orders might have asynchronous operations that can take time to finish.
• reserveInventoryUntil: DateTime The time after which inventory will automatically be restocked.
• shippingAddress: MailingAddress The shipping address of the customer.
• shippingLine: ShippingLine The line item containing the shipping information and costs.
• status: DraftOrderStatus! The status of the draft order.
• subtotalPrice: Money! The subtotal, in shop currency, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
• subtotalPriceSet: MoneyBag! The subtotal, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
• tags: String! The comma separated list of tags associated with the draft order. Updating `tags` overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation.
• taxExempt: Boolean! Whether the draft order is tax exempt.
• taxLines: TaxLine! The list of of taxes lines charged for each line item and shipping line.
• taxesIncluded: Boolean! Whether the line item prices include taxes.
• totalDiscountsSet: MoneyBag! Total discounts.
• totalLineItemsPriceSet: MoneyBag! Total price of line items.
• totalPrice: Money! The total price, in shop currency, includes taxes, shipping charges, and discounts.
• totalPriceSet: MoneyBag! The total price, includes taxes, shipping charges, and discounts.
• totalQuantityOfLineItems: Int! The sum of individual line item quantities. If the draft order has bundle items, this is the sum containing the quantities of individual items in the bundle.
• totalShippingPrice: Money! The total shipping price in shop currency.
• totalShippingPriceSet: MoneyBag! The total shipping price.
• totalTax: Money! The total tax in shop currency.
• totalTaxSet: MoneyBag! The total tax.
• totalWeight: UnsignedInt64! The total weight in grams of the draft order.
• transformerFingerprint: String Fingerprint of the current cart. In order to have bundles work, the fingerprint must be passed to each request as it was previously returned, unmodified.
• updatedAt: DateTime! The date and time when the draft order was last changed. The format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01.
• visibleToCustomer: Boolean! Whether the draft order will be visible to the customer on the self-serve portal.
• warnings: DraftOrderWarning! The list of warnings raised while calculating.

Examples

• Get a draft order by ID

          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\": \"query { draftOrder(id: \\\"gid://shopify/DraftOrder/276395349\\\") { name } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      name\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    draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      name\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\n  query {\n    draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      name\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    draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      name\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n    name\n  }\n}"
        

  input: null

  response: {
    "data": {
      "draftOrder": {
        "name": "#D1"
      }
    }
  }

  Get a list of draft orders by ID and GraphQL alias

          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\": \"query { draftOrder1: draftOrder(id: \\\"gid://shopify/DraftOrder/276395349\\\") { name } draftOrder2: draftOrder(id: \\\"gid://shopify/DraftOrder/221448317\\\") { name } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    draftOrder1: draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      name\n    }\n    draftOrder2: draftOrder(id: \"gid://shopify/DraftOrder/221448317\") {\n      name\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    draftOrder1: draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      name\n    }\n    draftOrder2: draftOrder(id: \"gid://shopify/DraftOrder/221448317\") {\n      name\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\n  query {\n    draftOrder1: draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      name\n    }\n    draftOrder2: draftOrder(id: \"gid://shopify/DraftOrder/221448317\") {\n      name\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    draftOrder1: draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      name\n    }\n    draftOrder2: draftOrder(id: \"gid://shopify/DraftOrder/221448317\") {\n      name\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  draftOrder1: draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n    name\n  }\n  draftOrder2: draftOrder(id: \"gid://shopify/DraftOrder/221448317\") {\n    name\n  }\n}"
        

  input: null

  response: {
    "data": {
      "draftOrder1": {
        "name": "#D1"
      },
      "draftOrder2": {
        "name": "#D7"
      }
    }
  }

  Get a list of line item names for a draft order

          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\": \"query { draftOrder(id: \\\"gid://shopify/DraftOrder/276395349\\\") { lineItems(first: 5) { edges { node { name } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      lineItems(first: 5) {\n        edges {\n          node {\n            name\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    draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      lineItems(first: 5) {\n        edges {\n          node {\n            name\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\n  query {\n    draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      lineItems(first: 5) {\n        edges {\n          node {\n            name\n          }\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    draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n      lineItems(first: 5) {\n        edges {\n          node {\n            name\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  draftOrder(id: \"gid://shopify/DraftOrder/276395349\") {\n    lineItems(first: 5) {\n      edges {\n        node {\n          name\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "draftOrder": {
        "lineItems": {
          "edges": [
            {
              "node": {
                "name": "Boots - Default"
              }
            }
          ]
        }
      }
    }
  }

  Get a metafield attached to a draft order

          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\": \"query DraftOrderMetafield($namespace: String!, $key: String!, $ownerId: ID!) { draftOrder(id: $ownerId) { purchaseOrder: metafield(namespace: $namespace, key: $key) { value } } }\",\n \"variables\": {\n    \"namespace\": \"my_fields\",\n    \"key\": \"purchase_order\",\n    \"ownerId\": \"gid://shopify/DraftOrder/276395349\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query DraftOrderMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n      draftOrder(id: $ownerId) {\n        purchaseOrder: metafield(namespace: $namespace, key: $key) {\n          value\n        }\n      }\n    }`,\n    \"variables\": {\n      \"namespace\": \"my_fields\",\n      \"key\": \"purchase_order\",\n      \"ownerId\": \"gid://shopify/DraftOrder/276395349\"\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 DraftOrderMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    draftOrder(id: $ownerId) {\n      purchaseOrder: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"namespace\": \"my_fields\",\n  \"key\": \"purchase_order\",\n  \"ownerId\": \"gid://shopify/DraftOrder/276395349\"\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  query DraftOrderMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    draftOrder(id: $ownerId) {\n      purchaseOrder: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"namespace\" => \"my_fields\",\n  \"key\" => \"purchase_order\",\n  \"ownerId\" => \"gid://shopify/DraftOrder/276395349\",\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  query DraftOrderMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    draftOrder(id: $ownerId) {\n      purchaseOrder: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"namespace\": \"my_fields\",\n      \"key\": \"purchase_order\",\n      \"ownerId\": \"gid://shopify/DraftOrder/276395349\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query DraftOrderMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n  draftOrder(id: $ownerId) {\n    purchaseOrder: metafield(namespace: $namespace, key: $key) {\n      value\n    }\n  }\n}"
        

  input: {
    "namespace": "my_fields",
    "key": "purchase_order",
    "ownerId": "gid://shopify/DraftOrder/276395349"
  }

  response: {
    "data": {
      "draftOrder": {
        "purchaseOrder": {
          "value": "123"
        }
      }
    }
  }

  Get metafields attached to a draft order

          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\": \"query DraftOrderMetafields($ownerId: ID!) { draftOrder(id: $ownerId) { metafields(first: 3) { edges { node { namespace key value } } } } }\",\n \"variables\": {\n    \"ownerId\": \"gid://shopify/DraftOrder/276395349\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query DraftOrderMetafields($ownerId: ID!) {\n      draftOrder(id: $ownerId) {\n        metafields(first: 3) {\n          edges {\n            node {\n              namespace\n              key\n              value\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"ownerId\": \"gid://shopify/DraftOrder/276395349\"\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 DraftOrderMetafields($ownerId: ID!) {\n    draftOrder(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"ownerId\": \"gid://shopify/DraftOrder/276395349\"\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  query DraftOrderMetafields($ownerId: ID!) {\n    draftOrder(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"ownerId\" => \"gid://shopify/DraftOrder/276395349\",\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  query DraftOrderMetafields($ownerId: ID!) {\n    draftOrder(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"ownerId\": \"gid://shopify/DraftOrder/276395349\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query DraftOrderMetafields($ownerId: ID!) {\n  draftOrder(id: $ownerId) {\n    metafields(first: 3) {\n      edges {\n        node {\n          namespace\n          key\n          value\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "ownerId": "gid://shopify/DraftOrder/276395349"
  }

  response: {
    "data": {
      "draftOrder": {
        "metafields": {
          "edges": [
            {
              "node": {
                "namespace": "my_fields",
                "key": "purchase_order",
                "value": "123"
              }
            }
          ]
        }
      }
    }
  }