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 combines_with • string: Filter by the discount classes that you can use in combination with Shopify discount types.
Anchor to created_at • time: Filter by the date and time when the discount was created.
Anchor to discount_type • string: Filter by the discount type.
Anchor to ends_at • time: Filter by the date and time when the discount expires and is no longer available for customer use.
Anchor to id • id: Filter by id range.
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 customers.
Anchor to type • string: Filter by the discount type.
Anchor to updated_at • time: Filter by the date and time when the discount was last updated.

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

savedSearchId

•

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

sortKey

•

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

Retrieve a list of code discounts
Retrieve code discounts by discount type

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

codeDiscountNodes(first: 3) {

nodes {

codeDiscount {

... on DiscountCodeBasic {

title

summary

}

... on DiscountCodeBxgy {

title

codesCount {

count

}

}`,

);

const data = await response.json();

query {
  codeDiscountNodes(first: 3) {
    nodes {
      id
      codeDiscount {
        ... on DiscountCodeBasic {
          title
          summary
        }
        ... on DiscountCodeBxgy {
          title
          codesCount {
            count
          }
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { codeDiscountNodes(first: 3) { nodes { id codeDiscount { ... on DiscountCodeBasic { title summary } ... on DiscountCodeBxgy { title codesCount { count } } } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    codeDiscountNodes(first: 3) {
      nodes {
        id
        codeDiscount {
          ... on DiscountCodeBasic {
            title
            summary
          }
          ... on DiscountCodeBxgy {
            title
            codesCount {
              count
            }
          }
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    codeDiscountNodes(first: 3) {
      nodes {
        id
        codeDiscount {
          ... on DiscountCodeBasic {
            title
            summary
          }
          ... on DiscountCodeBxgy {
            title
            codesCount {
              count
            }
          }
        }
      }
    }
  }`,
});

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 {
    codeDiscountNodes(first: 3) {
      nodes {
        id
        codeDiscount {
          ... on DiscountCodeBasic {
            title
            summary
          }
          ... on DiscountCodeBxgy {
            title
            codesCount {
              count
            }
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"codeDiscountNodes": {

"nodes": [

{

"id": "gid://shopify/DiscountCodeNode/1057371281",

"codeDiscount": {

"title": "10% off one-time",

"summary": "10% off one-time purchase products"

}

{

"id": "gid://shopify/DiscountCodeNode/1057371282",

"codeDiscount": {

"title": "60% off one-time",

"summary": "60% off one-time purchase products"

}

{

"id": "gid://shopify/DiscountCodeNode/1057371283",

"codeDiscount": {

"title": "BXGY Raincoats",

"codesCount": {

"count": 1

}

]

}