Skip to main content
Anchor to DiscountNode

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 firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

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

Example:

  • action:create
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.

Example:

  • false
  • true
Anchor to created_at
•time

Filter by the date and time when the event happened.

Example:

  • created_at:>2020-10-21
  • created_at:<now
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to subject_type
•string

The resource type affected by this event. See EventSubjectType for possible values.

Example:

  • PRODUCT_VARIANT
  • PRODUCT
  • COLLECTION
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.

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The key for the metafield.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-null

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

Arguments

Anchor to namespacenamespace
•String

The metafield namespace to filter by. If omitted, all metafields are returned.

Anchor to keyskeys
•[String!]

List of keys of metafields in the format namespace.key, will be returned in the same format.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

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 namespacenamespace
•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus
•MetafieldDefinitionPinnedStatus
Default:ANY

Filter by the definition's pinned status.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

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.

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.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time

Filter by the date and time when the metafield definition was created.

Example:

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

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to key
•string

Filter by the metafield definition key field.

Example:

  • key:some-key
Anchor to namespace
•string

Filter by the metafield definition namespace field.

Example:

  • namespace:some-namespace
Anchor to owner_type
•string

Filter by the metafield definition ownerType field.

Example:

  • owner_type:PRODUCT
Anchor to type
•string

Filter by the metafield definition type field.

Example:

  • type:single_line_text_field
Anchor to updated_at
•time

Filter by the date and time when the metafield definition was last updated.

Example:

  • updated_at:>2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
Was this section helpful?

Anchor to QueriesQueries

Anchor to discountNodediscountNode
•query

Returns a DiscountNode resource by ID.

Arguments

Anchor to idid
•ID!
required

The ID of the DiscountNode to return.

Anchor to discountNodesdiscountNodes
•query

Returns a list of discounts.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

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.

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.

Example:

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

Filter by the discount code. Not supported for bulk discounts.

Example:

  • code:WELCOME10
Anchor to combines_with
•string

Filter by the Shopify Functions discount classes that the discount type can combine with.

Valid values:

  • order_discounts
  • product_discounts
  • shipping_discounts

Example:

  • combines_with:product_discounts
Anchor to created_at
•time

Filter by the date and time, in the shop's timezone, when the discount was created.

Example:

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

Filter by the discount class.

Valid values:

  • order
  • product
  • shipping

Example:

  • discount_class:product
Anchor to discount_type
•string

Filter by the discount type.

Valid values:

  • bogo
  • fixed_amount
  • free_shipping
  • percentage

Example:

  • type:fixed_amount
Anchor to ends_at
•time

Filter by the date and time, in the shop's timezone, when the discount ends.

Example:

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

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to method
•string

Filter by the discount method.

Valid values:

  • automatic
  • code

Example:

  • method:code
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'
Anchor to status
•string

Filter by the status of the discount.

Valid values:

  • active
  • expired
  • scheduled

Example:

  • status:scheduled
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
Anchor to title
•string

Filter by the discount name that displays to merchants in the Shopify admin and to customers.

Example:

  • title:Black Friday Sale
Anchor to type
•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, in the shop's timezone, when the discount was last updated.

Example:

  • updated_at:>'2020-10-21T23:39:20Z'
  • updated_at:<now
  • updated_at:<='2024'
Anchor to savedSearchIdsavedSearchId
•ID

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

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?