An automatic discount that offers customers a price for multiple items, or fixed amount discount, on specific products, collections, or the entire order.
Fields
asyncUsageCount ● Int
The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.
combinesWith ● DiscountCombinesWith
Determines which discount classes the discount can combine with.
More
createdAt ● Date
The date and time when the discount was created.
customerGets ● DiscountCustomerGets
The qualifying items in an order, the quantity of each one, and the total value of the discount.
More
discountClass ● MerchandiseDiscountClass
The class of the discount for combining purposes.
More
endsAt ● Date
The date and time when the discount ends. For open-ended discounts, use null.
minimumRequirement ● DiscountMinimumRequirement
The minimum subtotal or quantity that's required for the discount to be applied.
More
shortSummary ● String
A short summary of the discount.
startsAt ● Date
The date and time when the discount starts.
status ● DiscountStatus
The status of the discount.
More
summary ● String
A detailed summary of the discount.
title ● String
The title of the discount.
updatedAt ● Date
The date and time when the discount was updated.
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?