Skip to main content
query

Requires Apps must have read_discounts access scope.

Deprecated. Use discountNodes instead.

Returns a list of code-based discounts.

Anchor to Arguments

DiscountCodeNodeConnection arguments

•DiscountCodeNodeConnection!
•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

nametypedescriptionacceptable_valuesdefault_valueexample_use
defaultstringFilter by a case-insensitive search of multiple fields
in a document.- query=Bob Norman
- query=title:green hoodie
combines_withstringFilter by the discount classes
that you can use in combination with [Shopify discount
types](https://help.shopify.com/manual/discounts/discount-types).-
order_discounts
- product_discounts
- shipping_discounts
  • combines_with:product_discounts | | 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 | | created_at | time | Filter by the date and time when the discount was created. | | | - created_at:>'2020-10-21T23:39:20Z'
    - created_at:<now
    - created_at:<='2024' | | discount_type | string | Filter by the discount type. | - app
    - bogo
    - fixed_amount
    - free_shipping
    - percentage | | - discount_type:fixed_amount | | ends_at | time | Filter by the date and time when the discount expires and is no longer available for customer use. | | | - ends_at:>'2020-10-21T23:39:20Z'
    - ends_at:<now
    - ends_at:<='2024' | | id | id | Filter by id range. | | | - id:1234
    - id:>=1234
    - id:<=1234 | | 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' | | status | string | Filter by the status of the discount. | - active
  • expired
    - scheduled | | - status:scheduled | | tag | string | Filter by a tag applied to the discount. | | | - tag:loyalty
    - tag:clearance | | 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 | | title | string | Filter by the discount name that displays to customers. | | | - title:Black Friday Sale | | type | string | Filter by the discount type. | - all
    - all_with_app
    - app
    - bxgy
    - fixed_amount
    - free_shipping
    - percentage | | - type:percentage | | updated_at | time | Filter by the date and time when the discount was last updated. | | | - updated_at:>'2020-10-21T23:39:20Z'
    - updated_at:<now
    - updated_at:<='2024' | You can apply one or more filters to a query. Learn more about Shopify API search syntax.
•Boolean
Default:false

Reverse the order of the underlying list.

•ID

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

•CodeDiscountSortKeys
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?

•[DiscountCodeNodeEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

•[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.

•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.


Was this section helpful?