Skip to main content
Anchor to DiscountCodeNodeConnection

DiscountCodeNodeConnection

connection

An auto-generated type for paginating through multiple DiscountCodeNodes.

Anchor to Queries with this connectionQueries with this connection

•query
Deprecated

Arguments

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

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to combines_with
•string

Filter by the discount classes that you can use in combination with Shopify discount types.

Valid values:

  • order_discounts
  • product_discounts
  • shipping_discounts

Example:

  • combines_with:product_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).

Example:

  • combines_with.product_discounts_with_tags_on_same_cart_line:priority
  • combines_with.product_discounts_with_tags_on_same_cart_line:priority,exclusive
Anchor to created_at
•time

Filter by the date and time when the discount was created.

Example:

  • created_at:>'2020-10-21T23:39:20Z'
  • created_at:<now
  • created_at:<='2024'
Anchor to discount_type
•string

Filter by the discount type.

Valid values:

  • app
  • bogo
  • fixed_amount
  • free_shipping
  • percentage

Example:

  • discount_type:fixed_amount
Anchor to ends_at
•time

Filter by the date and time when the discount expires and is no longer available for customer use.

Example:

  • ends_at:>'2020-10-21T23:39:20Z'
  • ends_at:<now
  • ends_at:<='2024'
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
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.

Example:

  • starts_at:>'2020-10-21T23:39:20Z'
  • starts_at:<now
  • starts_at:<='2024'
•string

Filter by the status of the discount.

Valid values:

  • active
  • expired
  • scheduled

Example:

  • status:scheduled
•string

Filter by a tag applied to the discount.

Example:

  • tag:loyalty
  • tag: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.

Example:

  • times_used:0
  • times_used:>150
  • times_used:>=200
•string

Filter by the discount name that displays to customers.

Example:

  • title:Black Friday Sale
•string

Filter by the discount type.

Valid values:

  • all
  • all_with_app
  • app
  • bxgy
  • fixed_amount
  • free_shipping
  • percentage

Example:

  • type:percentage
Anchor to updated_at
•time

Filter by the date and time when the discount was last updated.

Example:

  • updated_at:>'2020-10-21T23:39:20Z'
  • updated_at:<now
  • updated_at:<='2024'
•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?