DiscountCodeBxgy

object

Requires Apps must have read_discounts access scope.

The DiscountCodeBxgy object lets you manage buy X get Y discounts (BXGY) that are applied on a cart and at checkout when a customer enters a code. 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 DiscountCodeBxgy object stores information about BXGY code 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 DiscountAutomaticBxgy object has similar functionality to the DiscountCodeBxgy object, but discounts are automatically applied, without the need for customers to enter a code.

Anchor to Fields and connectionsFields and connections

Anchor to appliesOncePerCustomerappliesOncePerCustomer • Boolean!non-null: Whether a customer can only use the discount once.
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 codescodes • DiscountRedeemCodeConnection!non-null: A list codes that customers can use to redeem the discount.
Anchor to codesCountcodesCount • Count: The number of codes that a customer can use to redeem the discount.
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 customerSelectioncustomerSelection • DiscountCustomerSelection!non-null: The customers that can use the discount.
Anchor to discountClassdiscountClass • MerchandiseDiscountClass!non-null: The discount class that's used to control how discounts can be combined.
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 hasTimelineCommenthasTimelineComment • Boolean!non-null: Whether there are timeline comments associated with the discount.
Anchor to shareableUrlsshareableUrls • [DiscountShareableUrl!]!non-null: A list of URLs that the app can use to share the discount.
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 totalSalestotalSales • MoneyV2: The total sales from orders where the discount was used.
Anchor to updatedAtupdatedAt • DateTime!non-null: The date and time when the discount was updated.
Anchor to usageLimitusageLimit • Int: The maximum number of times that a customer can use the discount. For discounts with unlimited usage, specify null.
Anchor to usesPerOrderLimitusesPerOrderLimit • Int: The maximum number of times that the discount can be applied to an order.

Was this section helpful?