discountNodes
Requires Apps must have access scope.
Returns a list of discounts.
DiscountNodeConnection arguments
- Anchor to afterafter•
The elements that come after the specified cursor.
- Anchor to beforebefore•
The elements that come before the specified cursor.
- Anchor to firstfirst•
The first
n
elements from the paginated list.- Anchor to lastlast•
The last
n
elements from the paginated list.- Anchor to queryquery•
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.
query=Bob Norman
query=title:green hoodie
- Anchor to code•string
Filter by the discount code. Not supported for bulk discounts.
code:WELCOME10
- Anchor to combines_with•string
Filter by the Shopify Functions discount classes that the discount type can combine with.
order_discounts
product_discounts
shipping_discounts
combines_with:product_discounts
- Anchor to discount_class•string
Filter by the discount class.
order
product
shipping
discount_class:product
- Anchor to discount_type•string
Filter by the discount type.
bogo
fixed_amount
free_shipping
percentage
type:fixed_amount
- Anchor to method•string
Filter by the discount method.
automatic
code
method:code
- 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.
starts_at:>'2020-10-21T23:39:20Z'
starts_at:<now
starts_at:<='2024'
- Anchor to status•string
Filter by the status of the discount.
active
expired
scheduled
status:scheduled
- 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.times_used:0
times_used:>150
times_used:>=200
- Anchor to title•string
Filter by the discount name that displays to merchants in the Shopify admin and to customers.
title:Black Friday Sale
- Anchor to type•string
Filter by the discount type.
all
all_with_app
app
bxgy
fixed_amount
free_shipping
percentage
type:percentage
Example:
Example:
Valid values:
Example:
Valid values:
Example:
Valid values:
Example:
Valid values:
Example:
Example:
Valid values:
Example:
Example:
Example:
Valid values:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to savedSearchIdsaved•
Search Id The ID of a saved search. The search’s query string is used as the query argument.
- Anchor to sortKeysort•
Key DiscountSort Default:IDKeys 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.
Anchor to Possible returnsPossible returns
- Anchor to edgesedges•[Discount
Node non-nullEdge!]! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Discount
Node!]! 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 pageInfopage•
Info PageInfo! non-null An object that’s used to retrieve cursor information about the current page.
- Retrieve a list of combinable discounts
- Retrieve a list of discounts
Examples
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 -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/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 } } } } } } }"
}'
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 data = await response.json();
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
}
}
}
}
}
}
}`,
});
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)