A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to code •string: Filter by the discount code. Not supported for bulk discounts.
Anchor to combines_with •string: Filter by the Shopify Functions discount classes that the discount type can combine with.
Anchor to created_at •time: Filter by the date and time, in the shop's timezone, when the discount was created.
Anchor to discount_class •string: Filter by the discount class.
Anchor to discount_type •string: Filter by the discount type.
Anchor to ends_at •time: Filter by the date and time, in the shop's timezone, when the discount ends.
Anchor to id •id: Filter by id range.
Anchor to method •string: Filter by the discount method.
Anchor to 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.
Anchor to status •string: Filter by the status of the discount.
Anchor to 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.

This value is updated asynchronously. As a result, it might be different than the actual usage count.
Anchor to title •string: Filter by the discount name that displays to merchants in the Shopify admin and to customers.
Anchor to type •string: Filter by the discount type.
Anchor to updated_at •time: Filter by the date and time, in the shop's timezone, when the discount was last updated.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to sortKeysortKey

•DiscountSortKeys

Default:ID

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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[DiscountNodeEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[DiscountNode!]! non-null: 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.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Retrieve a list of combinable discounts

Description

Retrieve a list of discounts that can be combined with other discounts. This query returns discounts that can be [combined](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) with product discounts.

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
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  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
              }
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~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
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `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
              }
            }
          }
        }
      }
    }
  }`,
});

Response

{
  "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

Description

Retrieve the first five discounts for a shop. You can retrieve [discount types](https://help.shopify.com/manual/discounts/discount-types) that offer buy X get Y (BXGY), amount off, and free shipping. You can also retrieve discounts that are managed by an app that's using [Shopify Functions](https://shopify.dev/docs/apps/build/functions).

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
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  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
              }
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~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
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `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
              }
            }
          }
        }
      }
    }
  }`,
});

Response

{
  "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"
          }
        }
      }
    ]
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

discountNodes(query: "combines_with:product_discounts", first: 10) {

edges {

node {

discount {

... on DiscountCodeBasic {

title

status

combinesWith {

productDiscounts

}

... on DiscountCodeFreeShipping {

title

status

combinesWith {

productDiscounts

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

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
            }
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  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
              }
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `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
              }
            }
          }
        }
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~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
              }
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"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

}

]

}