discountNodes - admin-graphql - QUERY

Version: 2024-10

Description:

List of discounts.

Access Scopes

Apps must have `read_discounts` access scope.

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` | | combines_with | string | | - `PRODUCT_DISCOUNTS`
  - `ORDER_DISCOUNTS`
  - `SHIPPING_DISCOUNTS` | | discount_class | string | | - `PRODUCT`
  - `ORDER`
  - `SHIPPING` | | discount_type | string | | id | id | Filter by `id` range. | | | - `id:1234`
  - `id:>=1234`
  - `id:<=1234` | | method | string | | starts_at | time | | status | string | | times_used | integer | | title | string | | type | string | 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: DiscountSortKeys - 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: DiscountNodeEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: DiscountNode! A list of nodes that are contained in DiscountNodeEdge. 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

• Retrieve a list of discounts

          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\": \"query { discountNodes(first: 3) { edges { node { id discount { ... on DiscountCodeBasic { title } ... on DiscountCodeBxgy { title } ... on DiscountCodeFreeShipping { title } ... on DiscountAutomaticApp { title } ... on DiscountAutomaticBasic { title } ... on DiscountAutomaticBxgy { title } ... on DiscountAutomaticFreeShipping { title } } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    discountNodes(first: 3) {\n      edges {\n        node {\n          id\n          discount {\n            ... on DiscountCodeBasic {\n              title\n            }\n            ... on DiscountCodeBxgy {\n              title\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n            }\n            ... on DiscountAutomaticApp {\n              title\n            }\n            ... on DiscountAutomaticBasic {\n              title\n            }\n            ... on DiscountAutomaticBxgy {\n              title\n            }\n            ... on DiscountAutomaticFreeShipping {\n              title\n            }\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    discountNodes(first: 3) {\n      edges {\n        node {\n          id\n          discount {\n            ... on DiscountCodeBasic {\n              title\n            }\n            ... on DiscountCodeBxgy {\n              title\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n            }\n            ... on DiscountAutomaticApp {\n              title\n            }\n            ... on DiscountAutomaticBasic {\n              title\n            }\n            ... on DiscountAutomaticBxgy {\n              title\n            }\n            ... on DiscountAutomaticFreeShipping {\n              title\n            }\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    discountNodes(first: 3) {\n      edges {\n        node {\n          id\n          discount {\n            ... on DiscountCodeBasic {\n              title\n            }\n            ... on DiscountCodeBxgy {\n              title\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n            }\n            ... on DiscountAutomaticApp {\n              title\n            }\n            ... on DiscountAutomaticBasic {\n              title\n            }\n            ... on DiscountAutomaticBxgy {\n              title\n            }\n            ... on DiscountAutomaticFreeShipping {\n              title\n            }\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  discountNodes(first: 3) {\n    edges {\n      node {\n        id\n        discount {\n          ... on DiscountCodeBasic {\n            title\n          }\n          ... on DiscountCodeBxgy {\n            title\n          }\n          ... on DiscountCodeFreeShipping {\n            title\n          }\n          ... on DiscountAutomaticApp {\n            title\n          }\n          ... on DiscountAutomaticBasic {\n            title\n          }\n          ... on DiscountAutomaticBxgy {\n            title\n          }\n          ... on DiscountAutomaticFreeShipping {\n            title\n          }\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "discountNodes": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/DiscountAutomaticNode/52422887",
              "discount": {
                "title": "Percentage off (by Automatic App Discount)"
              }
            }
          },
          {
            "node": {
              "id": "gid://shopify/DiscountAutomaticNode/198286294",
              "discount": {
                "title": "My automatic bogo"
              }
            }
          },
          {
            "node": {
              "id": "gid://shopify/DiscountAutomaticNode/299501151",
              "discount": {
                "title": "My automatic discount"
              }
            }
          }
        ]
      }
    }
  }

  Retrieves a list of price rules

          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\": \"query DiscountList($first: Int) { discountNodes(first: $first) { edges { node { id __typename discount { ... on DiscountCodeBasic { title summary status codes(first: 1) { nodes { code } } } ... on DiscountAutomaticBasic { title summary status } ... on DiscountCodeBxgy { title summary status codes(first: 1) { nodes { code } } } ... on DiscountAutomaticBxgy { title summary status } ... on DiscountCodeFreeShipping { title summary status codes(first: 1) { nodes { code } } } ... on DiscountCodeApp { title status appDiscountType { functionId } codes(first: 1) { nodes { code } } } ... on DiscountAutomaticApp { title status appDiscountType { functionId } } } } } } }\",\n \"variables\": {\n    \"first\": 5\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query DiscountList($first: Int) {\n      discountNodes(first: $first) {\n        edges {\n          node {\n            id\n            __typename\n            discount {\n              ... on DiscountCodeBasic {\n                title\n                summary\n                status\n                codes(first: 1) {\n                  nodes {\n                    code\n                  }\n                }\n              }\n              ... on DiscountAutomaticBasic {\n                title\n                summary\n                status\n              }\n              ... on DiscountCodeBxgy {\n                title\n                summary\n                status\n                codes(first: 1) {\n                  nodes {\n                    code\n                  }\n                }\n              }\n              ... on DiscountAutomaticBxgy {\n                title\n                summary\n                status\n              }\n              ... on DiscountCodeFreeShipping {\n                title\n                summary\n                status\n                codes(first: 1) {\n                  nodes {\n                    code\n                  }\n                }\n              }\n              ... on DiscountCodeApp {\n                title\n                status\n                appDiscountType {\n                  functionId\n                }\n                codes(first: 1) {\n                  nodes {\n                    code\n                  }\n                }\n              }\n              ... on DiscountAutomaticApp {\n                title\n                status\n                appDiscountType {\n                  functionId\n                }\n              }\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"first\": 5\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 DiscountList($first: Int) {\n    discountNodes(first: $first) {\n      edges {\n        node {\n          id\n          __typename\n          discount {\n            ... on DiscountCodeBasic {\n              title\n              summary\n              status\n              codes(first: 1) {\n                nodes {\n                  code\n                }\n              }\n            }\n            ... on DiscountAutomaticBasic {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeBxgy {\n              title\n              summary\n              status\n              codes(first: 1) {\n                nodes {\n                  code\n                }\n              }\n            }\n            ... on DiscountAutomaticBxgy {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n              summary\n              status\n              codes(first: 1) {\n                nodes {\n                  code\n                }\n              }\n            }\n            ... on DiscountCodeApp {\n              title\n              status\n              appDiscountType {\n                functionId\n              }\n              codes(first: 1) {\n                nodes {\n                  code\n                }\n              }\n            }\n            ... on DiscountAutomaticApp {\n              title\n              status\n              appDiscountType {\n                functionId\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"first\": 5\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 = << 5,\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 DiscountList($first: Int) {\n    discountNodes(first: $first) {\n      edges {\n        node {\n          id\n          __typename\n          discount {\n            ... on DiscountCodeBasic {\n              title\n              summary\n              status\n              codes(first: 1) {\n                nodes {\n                  code\n                }\n              }\n            }\n            ... on DiscountAutomaticBasic {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeBxgy {\n              title\n              summary\n              status\n              codes(first: 1) {\n                nodes {\n                  code\n                }\n              }\n            }\n            ... on DiscountAutomaticBxgy {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n              summary\n              status\n              codes(first: 1) {\n                nodes {\n                  code\n                }\n              }\n            }\n            ... on DiscountCodeApp {\n              title\n              status\n              appDiscountType {\n                functionId\n              }\n              codes(first: 1) {\n                nodes {\n                  code\n                }\n              }\n            }\n            ... on DiscountAutomaticApp {\n              title\n              status\n              appDiscountType {\n                functionId\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"first\": 5\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query DiscountList($first: Int) {\n  discountNodes(first: $first) {\n    edges {\n      node {\n        id\n        __typename\n        discount {\n          ... on DiscountCodeBasic {\n            title\n            summary\n            status\n            codes(first: 1) {\n              nodes {\n                code\n              }\n            }\n          }\n          ... on DiscountAutomaticBasic {\n            title\n            summary\n            status\n          }\n          ... on DiscountCodeBxgy {\n            title\n            summary\n            status\n            codes(first: 1) {\n              nodes {\n                code\n              }\n            }\n          }\n          ... on DiscountAutomaticBxgy {\n            title\n            summary\n            status\n          }\n          ... on DiscountCodeFreeShipping {\n            title\n            summary\n            status\n            codes(first: 1) {\n              nodes {\n                code\n              }\n            }\n          }\n          ... on DiscountCodeApp {\n            title\n            status\n            appDiscountType {\n              functionId\n            }\n            codes(first: 1) {\n              nodes {\n                code\n              }\n            }\n          }\n          ... on DiscountAutomaticApp {\n            title\n            status\n            appDiscountType {\n              functionId\n            }\n          }\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "first": 5
  }

  response: {
    "data": {
      "discountNodes": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/DiscountCodeNode/2429471",
              "__typename": "DiscountNode",
              "discount": {
                "title": "cart_amount",
                "summary": "$10.00 off one-time purchase products",
                "status": "ACTIVE",
                "codes": {
                  "nodes": []
                }
              }
            }
          },
          {
            "node": {
              "id": "gid://shopify/DiscountAutomaticNode/52422887",
              "__typename": "DiscountNode",
              "discount": {
                "title": "Percentage off (by Automatic App Discount)",
                "status": "EXPIRED",
                "appDiscountType": {
                  "functionId": "5d3cc7e3-8348-4ede-8a40-6b83133c773c"
                }
              }
            }
          },
          {
            "node": {
              "id": "gid://shopify/DiscountAutomaticNode/198286294",
              "__typename": "DiscountNode",
              "discount": {
                "title": "My automatic bogo",
                "summary": "Buy 1 item, get 1 item free",
                "status": "SCHEDULED"
              }
            }
          },
          {
            "node": {
              "id": "gid://shopify/DiscountAutomaticNode/299501151",
              "__typename": "DiscountNode",
              "discount": {
                "title": "My automatic discount",
                "summary": "$100.00 off entire order • Minimum quantity of 1",
                "status": "SCHEDULED"
              }
            }
          },
          {
            "node": {
              "id": "gid://shopify/DiscountCodeNode/299564956",
              "__typename": "DiscountNode",
              "discount": {
                "title": "product_bogo",
                "summary": "Buy 1 item, get 1 item free",
                "status": "ACTIVE",
                "codes": {
                  "nodes": []
                }
              }
            }
          }
        ]
      }
    }
  }