Choose a version:

DiscountAutomatic

union

Requires Apps must have read_discounts access scope.

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.

Anchor to Possible typesPossible types

DiscountAutomaticApp

•OBJECT

The DiscountAutomaticApp object stores information about automatic discounts that are managed by an app using Shopify Functions. Use DiscountAutomaticAppwhen 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

The DiscountCodeApp object has similar functionality to the DiscountAutomaticApp object, with the exception that DiscountCodeApp stores information about discount codes that are managed by an app using Shopify Functions.

Anchor to appDiscountTypeappDiscountType •AppDiscountType! 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 appliesOnOneTimePurchaseappliesOnOneTimePurchase •Boolean! non-null: Whether the discount applies on one-time purchases.
Anchor to appliesOnSubscriptionappliesOnSubscription •Boolean! non-null: Whether the discount applies on subscription items. Subscriptions enable customers to purchase products on a recurring basis.
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 contextcontext •DiscountContext! non-null: The context defining which buyers can use the discount.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the discount was created.
Anchor to discountClassesdiscountClasses •[DiscountClass!]! non-null: The classes of the discount.
Anchor to discountIddiscountId •ID! non-null: The globally-unique ID for 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 errorHistoryerrorHistory •FunctionsErrorHistory: The error history for the latest version of the discount type that the app provides.
Anchor to recurringCycleLimitrecurringCycleLimit •Int! non-null: 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 specify 0, then the discount applies indefinitely.
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 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 discountClassdiscountClass •DiscountClass! non-nullDeprecated

DiscountAutomaticBasic

•OBJECT

The DiscountAutomaticBasic object lets you manage amount off discounts that are automatically applied on a cart and at checkout. 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 DiscountAutomaticBasic object stores information about automatic amount off 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 DiscountCodeBasic object has similar functionality to the DiscountAutomaticBasic object, but customers need to enter a code to receive a discount.

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 contextcontext •DiscountContext! non-null: The context defining which buyers can use the discount.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the discount was created.
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 hasTimelineCommenthasTimelineComment •Boolean! non-null: Whether there are timeline comments associated with the discount.
Anchor to minimumRequirementminimumRequirement •DiscountMinimumRequirement: The minimum subtotal or quantity of items that are required for the discount to be applied.
Anchor to recurringCycleLimitrecurringCycleLimit •Int! non-null: 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 specify 0, then the discount applies indefinitely.
Anchor to shortSummaryshortSummary •String! non-null: An abbreviated version of the discount summary field.
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 discountClassdiscountClass •MerchandiseDiscountClass! non-nullDeprecated
Anchor to usageCountusageCount •Int! non-nullDeprecated

DiscountAutomaticBxgy

•OBJECT

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 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 contextcontext •DiscountContext! non-null: The context defining which buyers can use the discount.
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.
Anchor to discountClassdiscountClass •MerchandiseDiscountClass! non-nullDeprecated
Anchor to idid •ID! non-nullDeprecated
Anchor to usageCountusageCount •Int! non-nullDeprecated

DiscountAutomaticFreeShipping

•OBJECT

The DiscountAutomaticFreeShipping object lets you manage free shipping discounts that are automatically applied on a cart and at checkout. Free shipping discounts are promotional deals that merchants offer to customers to waive shipping costs and encourage online purchases.

The DiscountAutomaticFreeShipping object stores information about automatic free shipping 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 DiscountCodeFreeShipping object has similar functionality to the DiscountAutomaticFreeShipping object, but customers need to enter a code to receive a discount.

Anchor to appliesOnOneTimePurchaseappliesOnOneTimePurchase •Boolean! 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 appliesOnSubscriptionappliesOnSubscription •Boolean! non-null: Whether the discount applies on subscription items. Subscriptions enable customers to purchase products on a recurring basis.
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 contextcontext •DiscountContext! non-null: The context defining which buyers can use the discount.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the discount was created.
Anchor to destinationSelectiondestinationSelection •DiscountShippingDestinationSelection! 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 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 hasTimelineCommenthasTimelineComment •Boolean! non-null: Whether there are timeline comments associated with the discount.
Anchor to maximumShippingPricemaximumShippingPrice •MoneyV2: The maximum shipping price amount accepted to qualify for the discount.
Anchor to minimumRequirementminimumRequirement •DiscountMinimumRequirement: The minimum subtotal or quantity of items that are required for the discount to be applied.
Anchor to recurringCycleLimitrecurringCycleLimit •Int! non-null: 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 specify 0, then the discount applies indefinitely.
Anchor to shortSummaryshortSummary •String! non-null: An abbreviated version of the discount summary field.
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 discountClassdiscountClass •ShippingDiscountClass! non-nullDeprecated

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to DiscountAutomaticConnection.nodes DiscountAutomaticConnection.nodes •CONNECTION: An auto-generated type for paginating through multiple DiscountAutomatics.
Anchor to DiscountAutomaticEdge.node DiscountAutomaticEdge.node •OBJECT: An auto-generated type which holds one DiscountAutomatic and a cursor during pagination.
Anchor to DiscountAutomaticNode.automaticDiscount DiscountAutomaticNode.automaticDiscount •OBJECT: The DiscountAutomaticNode object enables you to manage automatic discounts that are applied when an order meets specific criteria. You can create amount off, free shipping, or buy X get Y automatic discounts. For example, you can offer customers a free shipping discount that applies when conditions are met. Or you can offer customers a buy X get Y discount that's automatically applied when customers spend a specified amount of money, or a specified quantity of products.

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

Was this section helpful?