A basic automatic discount that provides customers with a percentage or fixed amount off 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
which discount classes the discount can combine with.
More
createdAt ● Date
The time when the discount was created.
customerGets ● DiscountCustomerGets
Eligible items in the order, their quantities, and the total discount amount.
More
discountClass ● MerchandiseDiscountClass
The class of the discount for combining purposes.
More
endsAt ● Date
The time when the discount ends. For open-ended discounts, use null.
minimumRequirement ● DiscountMinimumRequirement
Minimum subtotal or quantity required to apply the discount.
More
shortSummary ● String
A short summary of the discount.
startsAt ● Date
The time when discount starts.
status ● DiscountStatus
The status of the discount.
More
summary ● String
summary of the discount.
title ● String
The title of the discount.
updatedAt ● Date
The 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?