# discountNodes - admin-graphql - QUERY
Version: 2024-10

## Description
Returns a list of discounts.

### Access Scopes
Apps must have `read_discounts` access scope.


## Arguments
* [after](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* [before](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* [first](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* [last](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* [query](/docs/api/admin-graphql/2024-10/scalars/String): 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`<br/> - `query=title:green hoodie` |
| combines_with | string | Filter by the [Shopify Functions discount classes](https://shopify.dev/docs/apps/build/discounts#discount-classes) that the [discount type](https://shopify.dev/docs/api/admin-graphql/latest/queries/discountnodes#argument-query-filter-discount_type) can combine with. | - `order_discounts`<br/> - `product_discounts`<br/> - `shipping_discounts` | | - `combines_with:product_discounts` |
| discount_class | string | Filter by the [discount class](https://shopify.dev/docs/apps/build/discounts#discount-classes). | - `order`<br/> - `product`<br/> - `shipping` | | - `discount_class:product` |
| discount_type | string | Filter by the [discount type](https://help.shopify.com/manual/discounts/discount-types). | - `bogo`<br/> - `fixed_amount`<br/> - `free_shipping`<br/> - `percentage` | | - `type:fixed_amount` |
| id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` |
| method | string | Filter by the [discount method](https://shopify.dev/docs/apps/build/discounts#discount-methods). | - `automatic`<br/> - `code` | | - `method:code` |
| starts_at | time | Filter by the date and time, in the shop's timezone, when the discount becomes active and is available for customer use. | | | - `starts_at:>'2020-10-21T23:39:20Z'`<br/> - `starts_at:<now`<br/> - `starts_at:<='2024'` |
| status | string | Filter by the status of the discount. | - `active`<br/> - `expired`<br/> - `scheduled` | | - `status:scheduled` |
| times_used | integer | Filter by the number of times the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. <br><br> This value is updated asynchronously. As a result, it might be different than the actual usage count. | | | - `times_used:0`<br/> - `times_used:>150`<br/> - `times_used:>=200` |
| title | string | Filter by the discount name that displays to merchants in the Shopify admin and to customers. | | | - `title:Black Friday Sale` |
| type | string | Filter by the [discount type](https://help.shopify.com/manual/discounts/discount-types). | - `all`<br/> - `all_with_app`<br/> - `app`<br/> - `bxgy`<br/> - `fixed_amount`<br/> - `free_shipping`<br/> - `percentage` | | - `type:percentage` |
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](/docs/api/admin-graphql/2024-10/scalars/Boolean): Boolean - Reverse the order of the underlying list.
* [savedSearchId](/docs/api/admin-graphql/2024-10/scalars/ID): 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](/docs/api/admin-graphql/2024-10/enums/DiscountSortKeys): 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](/docs/api/admin-graphql/2024-10/objects/DiscountNodeEdge): DiscountNodeEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
* [nodes](/docs/api/admin-graphql/2024-10/objects/DiscountNode): 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](/docs/api/admin-graphql/2024-10/objects/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 combinable 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(query: \\\"combines_with:product_discounts\\\", first: 10) { edges { node { id discount { ... on DiscountCodeBasic { title status combinesWith { productDiscounts } } ... on DiscountCodeFreeShipping { title status combinesWith { productDiscounts } } } } } } }\"\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    discountNodes(query: \"combines_with:product_discounts\", first: 10) {\n      edges {\n        node {\n          id\n          discount {\n            ... on DiscountCodeBasic {\n              title\n              status\n              combinesWith {\n                productDiscounts\n              }\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n              status\n              combinesWith {\n                productDiscounts\n              }\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(query: \"combines_with:product_discounts\", first: 10) {\n      edges {\n        node {\n          id\n          discount {\n            ... on DiscountCodeBasic {\n              title\n              status\n              combinesWith {\n                productDiscounts\n              }\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n              status\n              combinesWith {\n                productDiscounts\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n" 
Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    discountNodes(query: \"combines_with:product_discounts\", first: 10) {\n      edges {\n        node {\n          id\n          discount {\n            ... on DiscountCodeBasic {\n              title\n              status\n              combinesWith {\n                productDiscounts\n              }\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n              status\n              combinesWith {\n                productDiscounts\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
Graphql query: "query {\n  discountNodes(query: \"combines_with:product_discounts\", first: 10) {\n    edges {\n      node {\n        id\n        discount {\n          ... on DiscountCodeBasic {\n            title\n            status\n            combinesWith {\n              productDiscounts\n            }\n          }\n          ... on DiscountCodeFreeShipping {\n            title\n            status\n            combinesWith {\n              productDiscounts\n            }\n          }\n        }\n      }\n    }\n  }\n}"
#### Graphql Input
null
#### Graphql Response
{
  "data": {
    "discountNodes": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/DiscountCodeNode/700447567",
            "discount": {
              "title": "COMBINABLEFREESHIPPING",
              "status": "ACTIVE",
              "combinesWith": {
                "productDiscounts": true
              }
            }
          }
        },
        {
          "node": {
            "id": "gid://shopify/DiscountCodeNode/988849754",
            "discount": {
              "title": "combinable_cart_amount",
              "status": "EXPIRED",
              "combinesWith": {
                "productDiscounts": true
              }
            }
          }
        }
      ]
    }
  }
}

### 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: 5) { edges { node { id __typename discount { ... on DiscountCodeBasic { title summary status } ... on DiscountAutomaticBasic { title summary status } ... on DiscountCodeBxgy { title summary status } ... on DiscountAutomaticBxgy { title summary status } ... on DiscountCodeFreeShipping { title summary status } ... on DiscountAutomaticApp { title status appDiscountType { functionId } } } } } } }\"\n}'\n"
Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    discountNodes(first: 5) {\n      edges {\n        node {\n          id\n          __typename\n          discount {\n            ... on DiscountCodeBasic {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticBasic {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeBxgy {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticBxgy {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticApp {\n              title\n              status\n              appDiscountType {\n                functionId\n              }\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: 5) {\n      edges {\n        node {\n          id\n          __typename\n          discount {\n            ... on DiscountCodeBasic {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticBasic {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeBxgy {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticBxgy {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticApp {\n              title\n              status\n              appDiscountType {\n                functionId\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.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: 5) {\n      edges {\n        node {\n          id\n          __typename\n          discount {\n            ... on DiscountCodeBasic {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticBasic {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeBxgy {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticBxgy {\n              title\n              summary\n              status\n            }\n            ... on DiscountCodeFreeShipping {\n              title\n              summary\n              status\n            }\n            ... on DiscountAutomaticApp {\n              title\n              status\n              appDiscountType {\n                functionId\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
Graphql query: "query {\n  discountNodes(first: 5) {\n    edges {\n      node {\n        id\n        __typename\n        discount {\n          ... on DiscountCodeBasic {\n            title\n            summary\n            status\n          }\n          ... on DiscountAutomaticBasic {\n            title\n            summary\n            status\n          }\n          ... on DiscountCodeBxgy {\n            title\n            summary\n            status\n          }\n          ... on DiscountAutomaticBxgy {\n            title\n            summary\n            status\n          }\n          ... on DiscountCodeFreeShipping {\n            title\n            summary\n            status\n          }\n          ... on DiscountAutomaticApp {\n            title\n            status\n            appDiscountType {\n              functionId\n            }\n          }\n        }\n      }\n    }\n  }\n}"
#### Graphql Input
null
#### Graphql 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": "EXPIRED"
            }
          }
        },
        {
          "node": {
            "id": "gid://shopify/DiscountAutomaticNode/52422887",
            "__typename": "DiscountNode",
            "discount": {
              "title": "Percentage off (by Automatic App Discount)",
              "status": "EXPIRED",
              "appDiscountType": {
                "functionId": "9476d0af-de36-4159-a6cd-b68165c2deac"
              }
            }
          }
        },
        {
          "node": {
            "id": "gid://shopify/DiscountAutomaticNode/198286294",
            "__typename": "DiscountNode",
            "discount": {
              "title": "My automatic bogo",
              "summary": "Buy 1 item, get 1 item free",
              "status": "EXPIRED"
            }
          }
        },
        {
          "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": "EXPIRED"
            }
          }
        }
      ]
    }
  }
}