Choose a version:

DiscountItems

union

Requires Apps must have read_discounts access scope.

The type used to target the items required for discount eligibility, or the items to which the application of a discount might apply. For example, for a customer to be eligible for a discount, they're required to add an item from a specified collection to their order. Alternatively, a customer might be required to add a specific product or product variant. When using this type to target which items the discount will apply to, the discount might apply to all items on the order, or to specific products and product variants, or items in a given collection.

Anchor to Possible typesPossible types

AllDiscountItems

•OBJECT

Targets all items the cart for a specified discount.

Anchor to allItemsallItems •Boolean! non-null: Whether all items are eligible for the discount. This value always returns true.

DiscountCollections

•OBJECT

A list of collections that the discount can have as a prerequisite or a list of collections to which the discount can be applied.

Anchor to collectionscollections •CollectionConnection! non-null: The list of collections that the discount can have as a prerequisite or the list of collections to which the discount can be applied.

DiscountProducts

•OBJECT

A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied.

Anchor to productsproducts •ProductConnection! non-null: The list of products that the discount can have as a prerequisite or the list of products to which the discount can be applied.
Anchor to productVariantsproductVariants •ProductVariantConnection! non-null: The list of product variants that the discount can have as a prerequisite or the list of product variants to which the discount can be applied.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to DiscountCustomerBuys.items DiscountCustomerBuys.items •OBJECT: The prerequisite items and prerequisite value that a customer must have on the order for the discount to be applicable.
Anchor to DiscountCustomerGets.items DiscountCustomerGets.items •OBJECT: The items in the order that qualify for the discount, their quantities, and the total value of the discount.

Was this section helpful?