name	type	description	acceptable_values	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.product_discounts_with_tags_on_same_cart_line	string
Filter by a combines with tag applied to discounts on the same cart line.
Supports multiple tags separated by commas (e.g., combines_with.product_discounts_with_tags_on_same_cart_line:priority,exclusive).			-
`combines_with.product_discounts_with_tags_on_same_cart_line:priority` - `combines_with.product_discounts_with_tags_on_same_cart_line:priority,exclusive`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
status	string	Filter by the discount status.	- `active` -
`expired` - `scheduled`		- `status:scheduled`
tag	string	Filter by a tag applied to the discount.		- `tag:loyalty` - `tag:clearance`
type	string	Filter by the [discount
type](https://help.shopify.com/manual/discounts/discount-types).	-
`all` - `all_with_app` - `app` - `bxgy` -
`fixed_amount` - `percentage`		- `type:bxgy`
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

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

•AutomaticDiscountSortKeys

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 •[DiscountAutomaticNodeEdge!]! 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 •[DiscountAutomaticNode!]! non-null: A list of nodes that are contained in DiscountAutomaticNodeEdge. 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

Query a list of automatic discounts

Description

Retrieve [automatic discounts](https://help.shopify.com/manual/discounts/discount-types#automatic-discounts) that are applied on a cart and at checkout when an order meets specific criteria.

Query

query {
  automaticDiscountNodes(first: 2) {
    edges {
      node {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            title
            status
          }
          ... on DiscountAutomaticBxgy {
            title
            status
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { automaticDiscountNodes(first: 2) { edges { node { id automaticDiscount { ... on DiscountAutomaticBasic { title status } ... on DiscountAutomaticBxgy { title status } } } } } }"
}'

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 {
    automaticDiscountNodes(first: 2) {
      edges {
        node {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              title
              status
            }
            ... on DiscountAutomaticBxgy {
              title
              status
            }
          }
        }
      }
    }
  }`,
  );
  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 {
    automaticDiscountNodes(first: 2) {
      edges {
        node {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              title
              status
            }
            ... on DiscountAutomaticBxgy {
              title
              status
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    automaticDiscountNodes(first: 2) {
      edges {
        node {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              title
              status
            }
            ... on DiscountAutomaticBxgy {
              title
              status
            }
          }
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  automaticDiscountNodes(first: 2) {
    edges {
      node {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            title
            status
          }
          ... on DiscountAutomaticBxgy {
            title
            status
          }
        }
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        automaticDiscountNodes(first: 2) {
          edges {
            node {
              id
              automaticDiscount {
                ... on DiscountAutomaticBasic {
                  title
                  status
                }
                ... on DiscountAutomaticBxgy {
                  title
                  status
                }
              }
            }
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "automaticDiscountNodes": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/DiscountAutomaticNode/1057371287",
          "automaticDiscount": {
            "title": "Automatic BXGY",
            "status": "ACTIVE"
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/DiscountAutomaticNode/1057371288",
          "automaticDiscount": {
            "title": "Basic Discount",
            "status": "ACTIVE"
          }
        }
      }
    ]
  }
}

Query automatic discounts with pagination and filtering

Description

This example shows how to query automatic discounts with pagination and status filtering. The query returns the first active discount and includes a cursor for pagination.

Query

query {
  automaticDiscountNodes(first: 1, query: "status:active") {
    nodes {
      id
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          title
          status
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { automaticDiscountNodes(first: 1, query: \"status:active\") { nodes { id automaticDiscount { ... on DiscountAutomaticBxgy { title status } } } pageInfo { hasNextPage endCursor } } }"
}'

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 {
    automaticDiscountNodes(first: 1, query: "status:active") {
      nodes {
        id
        automaticDiscount {
          ... on DiscountAutomaticBxgy {
            title
            status
          }
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }`,
  );
  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 {
    automaticDiscountNodes(first: 1, query: "status:active") {
      nodes {
        id
        automaticDiscount {
          ... on DiscountAutomaticBxgy {
            title
            status
          }
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    automaticDiscountNodes(first: 1, query: "status:active") {
      nodes {
        id
        automaticDiscount {
          ... on DiscountAutomaticBxgy {
            title
            status
          }
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  automaticDiscountNodes(first: 1, query: "status:active") {
    nodes {
      id
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          title
          status
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        automaticDiscountNodes(first: 1, query: "status:active") {
          nodes {
            id
            automaticDiscount {
              ... on DiscountAutomaticBxgy {
                title
                status
              }
            }
          }
          pageInfo {
            hasNextPage
            endCursor
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "automaticDiscountNodes": {
    "nodes": [
      {
        "id": "gid://shopify/DiscountAutomaticNode/1057371286",
        "automaticDiscount": {
          "title": "Active BXGY",
          "status": "ACTIVE"
        }
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "endCursor": "eyJsYXN0X2lkIjoxMDU3MzcxMjg2LCJsYXN0X3ZhbHVlIjoiMTA1NzM3MTI4NiJ9"
    }
  }
}

Examples

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

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

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

const response = await admin.graphql(

`#graphql

query {

automaticDiscountNodes(first: 2) {

edges {

node {

automaticDiscount {

... on DiscountAutomaticBasic {

title

status

}

... on DiscountAutomaticBxgy {

title

status

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  automaticDiscountNodes(first: 2) {
    edges {
      node {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            title
            status
          }
          ... on DiscountAutomaticBxgy {
            title
            status
          }
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { automaticDiscountNodes(first: 2) { edges { node { id automaticDiscount { ... on DiscountAutomaticBasic { title status } ... on DiscountAutomaticBxgy { title status } } } } } }"
}'

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 {
    automaticDiscountNodes(first: 2) {
      edges {
        node {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              title
              status
            }
            ... on DiscountAutomaticBxgy {
              title
              status
            }
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    automaticDiscountNodes(first: 2) {
      edges {
        node {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              title
              status
            }
            ... on DiscountAutomaticBxgy {
              title
              status
            }
          }
        }
      }
    }
  }`,
});

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 {
    automaticDiscountNodes(first: 2) {
      edges {
        node {
          id
          automaticDiscount {
            ... on DiscountAutomaticBasic {
              title
              status
            }
            ... on DiscountAutomaticBxgy {
              title
              status
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query {
  automaticDiscountNodes(first: 2) {
    edges {
      node {
        id
        automaticDiscount {
          ... on DiscountAutomaticBasic {
            title
            status
          }
          ... on DiscountAutomaticBxgy {
            title
            status
          }
        }
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        automaticDiscountNodes(first: 2) {
          edges {
            node {
              id
              automaticDiscount {
                ... on DiscountAutomaticBasic {
                  title
                  status
                }
                ... on DiscountAutomaticBxgy {
                  title
                  status
                }
              }
            }
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

JSON

{

"automaticDiscountNodes": {

"edges": [

{

"node": {

"id": "gid://shopify/DiscountAutomaticNode/1057371287",

"automaticDiscount": {

"title": "Automatic BXGY",

"status": "ACTIVE"

}

{

"node": {

"id": "gid://shopify/DiscountAutomaticNode/1057371288",

"automaticDiscount": {

"title": "Basic Discount",

"status": "ACTIVE"

}

]

}