DiscountAutomaticBxgy
Requires Apps must have access scope.
The 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 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.
Anchor to Fields and connectionsFields and connections
- Anchor to asyncUsageCountasync•
Usage Count 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 combinesWithcombines•
With DiscountCombines non-nullWith! The discount classes that you can use in combination with Shopify discount types.
- Anchor to createdAtcreated•
At DateTime! non-null The date and time when the discount was created.
- Anchor to customerBuyscustomer•
Buys DiscountCustomer non-nullBuys! The items eligible for the discount and the required quantity of each to receive the discount.
- Anchor to customerGetscustomer•
Gets DiscountCustomer non-nullGets! The items in the order that qualify for the discount, their quantities, and the total value of the discount.
- Anchor to discountClassdiscount•
Class MerchandiseDiscount non-nullClass! The discount class that's used to control how discounts can be combined.
- Anchor to endsAtends•
At 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•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to startsAtstarts•
At DateTime! non-null The date and time when the discount becomes active and is available to customers.
- Anchor to statusstatus•Discount
Status! 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 updatedAtupdated•
At DateTime! non-null The date and time when the discount was updated.
- Anchor to usesPerOrderLimituses•
Per Order Limit The maximum number of times that the discount can be applied to an order.