DiscountAutomaticBasic

object

Requires Apps must have read_discounts access scope.

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 FieldsFields

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 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 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 minimumRequirementminimumRequirement • DiscountMinimumRequirement!non-null: 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 usageCountusageCount • Int!non-nullDeprecated: The number of times that the discount has been used. Use asyncUsageCount instead.

Was this section helpful?