DiscountAutomaticBxgy - admin-graphql - OBJECT

Version: 2024-01

Description:

The `DiscountAutomaticBxgy` object lets you manage [buy X get Y discounts (BXGY)](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y) 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](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountProducts), [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCollections), or [all items in a cart](https://shopify.dev/docs/api/admin-graphql/latest/objects/AllDiscountItems). Learn more about working with [Shopify's discount model](https://shopify.dev/docs/apps/build/discounts), including limitations and considerations. > Note: > The [`DiscountCodeBxgy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeBxgy) object has similar functionality to the `DiscountAutomaticBxgy` object, but customers need to enter a code to receive a discount.

Access Scopes

Apps must have `read_discounts` access scope.

Fields

  • asyncUsageCount: Int! - 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.
  • combinesWith: DiscountCombinesWith! - The [discount classes](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that you can use in combination with [Shopify discount types](https://help.shopify.com/manual/discounts/discount-types).
  • createdAt: DateTime! - The date and time when the discount was created.
  • customerBuys: DiscountCustomerBuys! - The items eligible for the discount and the required quantity of each to receive the discount.
  • customerGets: DiscountCustomerGets! - The items in the order that qualify for the discount, their quantities, and the total value of the discount.
  • discountClass: MerchandiseDiscountClass! - The [discount class](https://help.shopify.com/manual/discounts/combining-discounts/discount-combinations) that's used to control how discounts can be combined.
  • endsAt: 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`.
  • id: ID! - A legacy unique ID for the discount.
  • startsAt: DateTime! - The date and time when the discount becomes active and is available to customers.
  • status: DiscountStatus! - The status of the discount that describes its availability, expiration, or pending activation.
  • summary: String! - A detailed explanation of what the discount is, who can use it, when and where it applies, and any associated rules or limitations.
  • title: String! - The discount's name that displays to merchants in the Shopify admin and to customers.
  • updatedAt: DateTime! - The date and time when the discount was updated.
  • usageCount: Int! - The number of times that the discount has been used.
  • usesPerOrderLimit: Int - The maximum number of times that the discount can be applied to an order.

Connections

  • events: EventConnection!

Related queries

Related mutations

Related Unions

  • Discount A discount.
  • DiscountAutomatic The type of discount associated to the automatic discount. For example, the automatic discount might offer a basic discount using a fixed percentage, or a fixed amount, on specific products from the order. The automatic discount may also be a BXGY discount, which offers customer discounts on select products if they add a specific product to their order.

Examples