Skip to main content
query

Requires read_discounts access scope.

The total number of discounts for the shop. Limited to a maximum of 10000 by default.

•Int
Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

•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
codestringFilter by the discount code. Not supported for bulk discounts.- code:WELCOME10
combines_withstringFilter by the [Shopify Functions discount
classes](https://shopify.dev/docs/apps/build/discounts#discount-classes)
that the discount type
can combine with. Supports multiple values separated by commas (e.g.,
combines_with:product_discounts,order_discounts).- order_discounts
  • product_discounts
    - shipping_discounts | | - combines_with:product_discounts
    - combines_with:product_discounts,order_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, in the shop's timezone, when the discount was created. | | | - created_at:>'2020-10-21T23:39:20Z'
    - created_at:<now
    - created_at:<='2024' | | discount_class | string | Filter by the discount class. Supports multiple classes separated by commas (e.g., discount_class:product,order). | - order
    - product
    - shipping | | - discount_class:product
    - discount_class:product,order | | discount_type | string | Filter by the discount type. Supports multiple types separated by commas (e.g., discount_type:percentage,fixed_amount). | - app
    - bogo
    - fixed_amount
    - free_shipping
    - percentage | | - discount_type:fixed_amount
    - discount_type:percentage,fixed_amount | | ends_at | time | Filter by the date and time, in the shop's timezone, when the discount ends. | | | - 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 | | method | string | Filter by the discount method. Supports multiple methods separated by commas (e.g., method:code,automatic). | - automatic
    - code | | - method:code
    - method:code,automatic | | 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. Supports multiple statuses separated by commas (e.g., status:active,scheduled). | - active
    - expired
    - scheduled | | - status:scheduled
    - status:active,scheduled | | tag | string | Filter by a tag applied to the discount. Supports multiple tags separated by commas (e.g., tag:loyalty,clearance). | | | - tag:loyalty
    - tag:loyalty,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 merchants in the Shopify admin and to customers. | | | - title:Black Friday Sale | | type | string | Filter by the discount type. Supports multiple types separated by commas (e.g., type:percentage,fixed_amount). | - all
    - all_with_app
    - app
    - bxgy
    - fixed_amount
    - free_shipping
    - percentage | | - type:percentage
    - type:percentage,fixed_amount | | updated_at | time | Filter by the date and time, in the shop's timezone, 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.
•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.


Was this section helpful?

•Count

A numeric count with precision information indicating whether the count is exact or an estimate.

•Int!
non-null

The count of elements.

•CountPrecision!
non-null

The count's precision, or the exactness of the value.


Was this section helpful?