automatic discount that offers customers free shipping.
Fields
asyncUsageCount ● Int
The number of times the discount has been redeemed. This value is updated asynchronously and may not match the actual usage count.
combinesWith ● DiscountCombinesWith
which discount classes the discount can combine with.
More
createdAt ● Date
The time when the discount was created.
destinationSelection ● DiscountShippingDestinationSelection
Shipping destinations eligible for the discount.
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.
maximumShippingPrice ● MoneyV2
Maximum shipping cost eligible for the discount.
More
minimumRequirement ● DiscountMinimumRequirement
Minimum subtotal or quantity required to apply the discount.
More
shortSummary ● String
discount short summary.
startsAt ● Date
The time when the discount starts.
status ● DiscountStatus
discount status.
More
summary ● String
discount summary.
title ● String
discount title.
totalSales ● MoneyV2
Total sales of orders using the discount.
More
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?