Skip to main content
Anchor to DiscountAutomaticBxgy

DiscountAutomaticBxgy

object

Requires Apps must have read_discounts access scope.

The DiscountAutomaticBxgy object lets you manage buy X get Y discounts (BXGY) that are automatically applied on a cart and at checkout. BXGY discounts incentivize customers by offering them additional items at a discounted price or for free when they purchase a specified quantity of items.

The DiscountAutomaticBxgy object stores information about automatic BXGY discounts that apply to specific products and variants, collections, or all items in a cart.

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

Note

The DiscountCodeBxgy object has similar functionality to the DiscountAutomaticBxgy object, but customers need to enter a code to receive a discount.

Anchor to Fields and connectionsFields and connections

Anchor to asyncUsageCountasyncUsageCount
•Int!non-null

The number of times that 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 lower than the actual usage count until the asynchronous process is completed.

Anchor to combinesWithcombinesWith
•DiscountCombinesWith!non-null

The discount classes that you can use in combination with Shopify discount types.

Anchor to createdAtcreatedAt
•DateTime!non-null

The date and time when the discount was created.

Anchor to customerBuyscustomerBuys
•DiscountCustomerBuys!non-null

The items eligible for the discount and the required quantity of each to receive the discount.

Anchor to customerGetscustomerGets
•DiscountCustomerGets!non-null

The items in the order that qualify for the discount, their quantities, and the total value of the discount.

Anchor to discountClassesdiscountClasses
•[DiscountClass!]!non-null

The classes of the discount.

Anchor to endsAtendsAt
•DateTime

The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify null.

Anchor to eventsevents
•EventConnection!non-null

The paginated list of events associated with the host subject.

Anchor to startsAtstartsAt
•DateTime!non-null

The date and time when the discount becomes active and is available to customers.

Anchor to statusstatus
•DiscountStatus!non-null

The status of the discount that describes its availability, expiration, or pending activation.

Anchor to summarysummary
•String!non-null

A detailed explanation of what the discount is, who can use it, when and where it applies, and any associated rules or limitations.

Anchor to titletitle
•String!non-null

The discount's name that displays to merchants in the Shopify admin and to customers.

Anchor to updatedAtupdatedAt
•DateTime!non-null

The date and time when the discount was updated.

Anchor to usesPerOrderLimitusesPerOrderLimit
•Int

The maximum number of times that the discount can be applied to an order.

Deprecated fields and connections

Anchor to discountClassdiscountClass
•MerchandiseDiscountClass!non-nullDeprecated
Anchor to idid
•ID!non-nullDeprecated
Anchor to usageCountusageCount
•Int!non-nullDeprecated
Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?