Discount
Requires Apps must have access scope.
The type of discount associated with the discount code. For example, the discount code might offer a basic discount of a fixed percentage, or a fixed amount, on specific products or the order. Alternatively, the discount might offer the customer free shipping on their order. A third option is a Buy X, Get Y (BXGY) discount, which offers a customer discounts on select products if they add a specific product to their order.
Anchor to Possible typesPossible types
- •OBJECT
The
object stores information about code discounts that are managed by an app using Shopify Functions. Usewhen you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.Learn more about creating custom discount functionality.
Note- Anchor to appDiscountTypeapp•App
Discount Type Discount Type! non-null The details about the app extension that's providing the discount type. This information includes the app extension's name and client ID, App Bridge configuration, discount class, function ID, and other metadata about the discount type, including the discount type's name and description.
- Anchor to appliesOncePerCustomerapplies•Boolean!
Once Per Customer non-null Whether a customer can only use the discount once.
- Anchor to appliesOnOneTimePurchaseapplies•Boolean!
On One Time Purchase non-null Whether the discount applies on regular one-time-purchase items.
- Anchor to appliesOnSubscriptionapplies•Boolean!
On Subscription non-null Whether the discount applies to subscriptions items.
- Anchor to asyncUsageCountasync•Int!
Usage Count 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•Discount
Redeem Code Connection! non-null A list codes that customers can use to redeem the discount.
- Anchor to codesCountcodes•Count
Count The number of codes that a customer can use to redeem the discount.
- Anchor to combinesWithcombines•Discount
With Combines With! non-null The discount classes that you can use in combination with Shopify discount types.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the discount was created.
- Anchor to discountClassesdiscount•[Discount
Classes Class!]! non-null The classes of the discount.
- Anchor to discountIddiscount•ID!
Id non-null The globally-unique ID for the discount.
- Anchor to endsAtends•Date
At Time 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 errorHistoryerror•Functions
History Error History The error history for the latest version of the discount type that the app provides.
- Anchor to hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether there are timeline comments associated with the discount.
- Anchor to recurringCycleLimitrecurring•Int
Cycle Limit The number of billing cycles for which the discount can be applied, which is useful for subscription-based discounts. For example, if you set this field to
3, then the discount only applies to the first three billing cycles of a subscription. If you specify0, then the discount applies indefinitely.- •[Discount
Shareable Url!]! non-null A list of URLs that the app can use to share the discount.
- Anchor to startsAtstarts•Date
At Time! 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 titletitle•String!non-null
The discount's name that displays to merchants in the Shopify admin and to customers.
- Anchor to totalSalestotal•Money
Sales V2 The total sales from orders where the discount was used.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the discount was updated.
- Anchor to usageLimitusage•Int
Limit The maximum number of times that a customer can use the discount. For discounts with unlimited usage, specify
null.- Anchor to customerSelectioncustomer•Discount
Selection Customer Selection! non-nullDeprecated - Anchor to discountClassdiscount•Discount
Class Class! non-nullDeprecated
- •OBJECT
The
object lets you manage amount off discounts that are applied on a cart and at checkout when a customer enters a code. Amount off discounts give customers a fixed value or a percentage off the products in an order, but don't apply to shipping costs.The
object stores information about amount off 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- Anchor to appliesOncePerCustomerapplies•Boolean!
Once Per Customer non-null Whether a customer can only use the discount once.
- Anchor to asyncUsageCountasync•Int!
Usage Count 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•Discount
Redeem Code Connection! non-null A list codes that customers can use to redeem the discount.
- Anchor to codesCountcodes•Count
Count The number of codes that a customer can use to redeem the discount.
- Anchor to combinesWithcombines•Discount
With Combines With! non-null The discount classes that you can use in combination with Shopify discount types.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the discount was created.
- Anchor to customerGetscustomer•Discount
Gets Customer Gets! non-null The items in the order that qualify for the discount, their quantities, and the total value of the discount.
- Anchor to discountClassesdiscount•[Discount
Classes Class!]! non-null The classes of the discount.
- Anchor to endsAtends•Date
At Time 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 hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether there are timeline comments associated with the discount.
- Anchor to minimumRequirementminimum•Discount
Requirement Minimum Requirement The minimum subtotal or quantity of items that are required for the discount to be applied.
- Anchor to recurringCycleLimitrecurring•Int
Cycle Limit The number of billing cycles for which the discount can be applied, which is useful for subscription-based discounts. For example, if you set this field to
3, then the discount only applies to the first three billing cycles of a subscription. If you specify0, then the discount applies indefinitely.- •[Discount
Shareable Url!]! non-null A list of URLs that the app can use to share the discount.
- Anchor to shortSummaryshort•String!
Summary non-null An abbreviated version of the discount
summaryfield.- Anchor to startsAtstarts•Date
At Time! 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 totalSalestotal•Money
Sales V2 The total sales from orders where the discount was used.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the discount was updated.
- Anchor to usageLimitusage•Int
Limit The maximum number of times that a customer can use the discount. For discounts with unlimited usage, specify
null.- Anchor to customerSelectioncustomer•Discount
Selection Customer Selection! non-nullDeprecated - Anchor to discountClassdiscount•Merchandise
Class Discount Class! non-nullDeprecated
- •OBJECT
The
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
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- Anchor to appliesOncePerCustomerapplies•Boolean!
Once Per Customer non-null Whether a customer can only use the discount once.
- Anchor to asyncUsageCountasync•Int!
Usage Count 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•Discount
Redeem Code Connection! non-null A list codes that customers can use to redeem the discount.
- Anchor to codesCountcodes•Count
Count The number of codes that a customer can use to redeem the discount.
- Anchor to combinesWithcombines•Discount
With Combines With! non-null The discount classes that you can use in combination with Shopify discount types.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the discount was created.
- Anchor to customerBuyscustomer•Discount
Buys Customer Buys! non-null The items eligible for the discount and the required quantity of each to receive the discount.
- Anchor to customerGetscustomer•Discount
Gets Customer Gets! non-null The items in the order that qualify for the discount, their quantities, and the total value of the discount.
- Anchor to discountClassesdiscount•[Discount
Classes Class!]! non-null The classes of the discount.
- Anchor to endsAtends•Date
At Time 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 hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether there are timeline comments associated with the discount.
- •[Discount
Shareable Url!]! non-null A list of URLs that the app can use to share the discount.
- Anchor to startsAtstarts•Date
At Time! 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 totalSalestotal•Money
Sales V2 The total sales from orders where the discount was used.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the discount was updated.
- Anchor to usageLimitusage•Int
Limit The maximum number of times that a customer can use the discount. For discounts with unlimited usage, specify
null.- Anchor to usesPerOrderLimituses•Int
Per Order Limit The maximum number of times that the discount can be applied to an order.
- Anchor to customerSelectioncustomer•Discount
Selection Customer Selection! non-nullDeprecated - Anchor to discountClassdiscount•Merchandise
Class Discount Class! non-nullDeprecated
- •OBJECT
The
object lets you manage free shipping discounts that are applied on a cart and at checkout when a customer enters a code. Free shipping discounts are promotional deals that merchants offer to customers to waive shipping costs and encourage online purchases.The
object stores information about free shipping 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- Anchor to appliesOncePerCustomerapplies•Boolean!
Once Per Customer non-null Whether a customer can only use the discount once.
- Anchor to appliesOnOneTimePurchaseapplies•Boolean!
On One Time Purchase non-null Whether the discount applies on one-time purchases. A one-time purchase is a transaction where you pay a single time for a product, without any ongoing commitments or recurring charges.
- Anchor to appliesOnSubscriptionapplies•Boolean!
On Subscription non-null Whether the discount applies on subscription items. Subscriptions enable customers to purchase products on a recurring basis.
- Anchor to asyncUsageCountasync•Int!
Usage Count 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•Discount
Redeem Code Connection! non-null A list codes that customers can use to redeem the discount.
- Anchor to codesCountcodes•Count
Count The number of codes that a customer can use to redeem the discount.
- Anchor to combinesWithcombines•Discount
With Combines With! non-null The discount classes that you can use in combination with Shopify discount types.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the discount was created.
- Anchor to destinationSelectiondestination•Discount
Selection Shipping Destination Selection! non-null The countries that qualify for the discount. You can define a list of countries or specify all countries to be eligible for the discount.
- Anchor to discountClassesdiscount•[Discount
Classes Class!]! non-null The classes of the discount.
- Anchor to endsAtends•Date
At Time 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 hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether there are timeline comments associated with the discount.
- Anchor to maximumShippingPricemaximum•Money
Shipping Price V2 The maximum shipping price amount accepted to qualify for the discount.
- Anchor to minimumRequirementminimum•Discount
Requirement Minimum Requirement The minimum subtotal or quantity of items that are required for the discount to be applied.
- Anchor to recurringCycleLimitrecurring•Int
Cycle Limit The number of billing cycles for which the discount can be applied, which is useful for subscription-based discounts. For example, if you set this field to
3, then the discount only applies to the first three billing cycles of a subscription. If you specify0, then the discount applies indefinitely.- •[Discount
Shareable Url!]! non-null A list of URLs that the app can use to share the discount.
- Anchor to shortSummaryshort•String!
Summary non-null An abbreviated version of the discount
summaryfield.- Anchor to startsAtstarts•Date
At Time! 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 totalSalestotal•Money
Sales V2 The total sales from orders where the discount was used.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the discount was updated.
- Anchor to usageLimitusage•Int
Limit The maximum number of times that a customer can use the discount. For discounts with unlimited usage, specify
null.- Anchor to customerSelectioncustomer•Discount
Selection Customer Selection! non-nullDeprecated - Anchor to discountClassdiscount•Shipping
Class Discount Class! non-nullDeprecated
Anchor to Fields with this unionFields with this union
- •OBJECT
The
object enables you to manage code discounts that are applied when customers enter a code at checkout. For example, you can offer discounts where customers have to enter a code to redeem an amount off discount on products, variants, or collections in a store. Or, you can offer discounts where customers have to enter a code to get free shipping. Merchants can create and share discount codes individually with customers.Learn more about working with Shopify's discount model, including related queries, mutations, limitations, and considerations.