Choose a version:

DiscountNodeConnection

connection

An auto-generated type for paginating through multiple DiscountNodes.

Anchor to Fields with this connectionFields with this connection

Anchor to CustomerMergePreviewDefaultFields.discountNodes CustomerMergePreviewDefaultFields.discountNodes •OBJECT: The fields that will be kept as part of a customer merge preview.
Anchor to Market.discounts Market.discounts •OBJECT: A merchant-defined group of buyers identified by conditions such as their region, retail location, or company location. Each market allows configuration of a distinct, localized buyer experience. Customizations include, but are not limited to, currency, pricing and product availability, web presence, and content translations.

Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

Anchor to discountNodes discountNodes

•query

Returns a list of discounts.

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

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 code •string: Filter by the discount code. Not supported for bulk discounts.
Anchor to combines_with •string: Filter by the Shopify Functions discount classes that the discount type can combine with. Supports multiple values separated by commas (e.g., combines_with:product_discounts,order_discounts).
Anchor to 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).
Anchor to context •string: Filter by the context type. Supports multiple values separated by commas (e.g., context:all,market). When multiple values are provided, results include discounts that match any of them.
Anchor to created_at •time: Filter by the date and time, in the shop's timezone, when the discount was created.
Anchor to customer_ids •string: Filter by specific customer IDs that are eligible for the discount.
Anchor to discount_class •string: Filter by the discount class. Supports multiple classes separated by commas (e.g., discount_class:product,order).
Anchor to discount_type •string: Filter by the discount type. Supports multiple types separated by commas (e.g., discount_type:percentage,fixed_amount).
Anchor to ends_at •time: Filter by the date and time, in the shop's timezone, when the discount ends.
Anchor to id •id: Filter by id range.
Anchor to market_ids •string: Filter by specific market IDs that are eligible for the discount. Supports multiple IDs separated by commas (e.g., market_ids:123,456).
Anchor to method •string: Filter by the discount method. Supports multiple methods separated by commas (e.g., method:code,automatic).
Anchor to - `automatic`<br/> - `code` •: method:code
- method:code,automatic
Anchor to segment_ids •string: Filter by specific segment IDs that are eligible for the discount. Supports multiple IDs separated by commas (e.g., segment_ids:123,456).
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. Supports multiple statuses separated by commas (e.g., status:active,scheduled).
Anchor to tag •string: Filter by a tag applied to the discount. Supports multiple tags separated by commas (e.g., tag:loyalty,clearance).
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 merchants in the Shopify admin and to customers.
Anchor to type •string: Filter by the discount type. Supports multiple types separated by commas (e.g., type:percentage,fixed_amount).
Anchor to updated_at •time: Filter by the date and time, in the shop's timezone, when the discount was last updated.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId

•ID

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

Anchor to sortKeysortKey

•DiscountSortKeys

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?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[DiscountNodeEdge!]! 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 •[DiscountNode!]! 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 pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?