Choose a version:

DiscountNode

object

Requires Apps must have read_discounts access scope.

The DiscountNode object enables you to manage discounts, which are applied at checkout or on a cart.

Discounts are a way for merchants to promote sales and special offers, or as customer loyalty rewards. Discounts can apply to orders, products, or shipping, and can be either automatic or code-based. For example, you can offer customers a buy X get Y discount that's automatically applied when purchases meet specific criteria. Or, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store.

Learn more about working with Shopify's discount model, including related mutations, limitations, and considerations.

Anchor to FieldsFields

Anchor to discountdiscount

•Discount!

non-null

A discount that's applied at checkout or on cart.

Discounts can be automatic or code-based.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

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 action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event occurred. Event data is retained for 1 year.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•EventSortKeys

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.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

•[Metafield]!

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

•[HasMetafieldsIdentifier!]!

required

The list of metafields to retrieve by namespace and key.

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

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 namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

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 created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MetafieldDefinitionSortKeys

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 QueriesQueries

Anchor to discountNode discountNode

•query

Returns a DiscountNode resource by ID.

Anchor to idid •ID! required: The ID of the DiscountNode to return.

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.