Anchor to discountNodesCountdiscount
querydiscount Nodes Count
Requires access scope.
The total number of discounts for the shop. Limited to a maximum of 10000 by default.
Anchor to Arguments
Arguments
- limit (Int)
- query (String)
- savedSearchId (ID)
- Anchor to limitlimit•IntDefault:10000
The upper bound on count value before returning a result. Use
nullto have no limit.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators.
name type description acceptable_values default_value example_use default string Filter by a case-insensitive search of multiple fields in a document. - query=Bob Norman
-query=title:green hoodiecode string Filter by the discount code. Not supported for bulk discounts. - combines_with string Filter 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). -
-| | -
-| | 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). | | | -
-| | created_at | time | Filter by the date and time, in the shop's timezone, when the discount was created. | | | -
-
-| | discount_class | string | Filter by the discount class. Supports multiple classes separated by commas (e.g., discount_class:product,order). | -order
-product
-shipping| | -
-| | discount_type | string | Filter by the discount type. Supports multiple types separated by commas (e.g., discount_type:percentage,fixed_amount). | -app
-bogo
-
-
-percentage| | -
-| | ends_at | time | Filter by the date and time, in the shop's timezone, when the discount ends. | | | -
-
-| | id | id | Filter byidrange. | | | -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. | | | -
-
-| | 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. | | | -
-| | 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
-
-app
-bxgy
-
-
-percentage| | -type:percentage
-| | updated_at | time | Filter by the date and time, in the shop's timezone, when the discount was last updated. | | | -
-
-| You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to savedSearchIdsaved•ID
Search Id
Was this section helpful?
Anchor to Possible returnsPossible returns
- Count (Count)
- Anchor to CountCount•Count
A numeric count with precision information indicating whether the count is exact or an estimate.
- Anchor to countcount•Int!non-null
The count of elements.
- Anchor to precisionprecision•Count
Precision! non-null The count's precision, or the exactness of the value.
Was this section helpful?