A code discount that offers customers free shipping on their order.
Fields
appliesTimesPerCustomer ● Int
The limit on the number of times each customer can use the discount, null means no limit
asyncUsageCount ● Int
The number of times that the discount has been used.
codeCount ● Int
The number of redeem codes for the discount.
codes ● [String]
Discount codes
combinesWith ● DiscountCombinesWith
Determines which discount classes the discount can combine with.
More
createdAt ● Date
The date and time when the discount was created.
customerSelection ● DiscountCustomerSelection
The customers that can use the discount.
More
destinationSelection ● DiscountShippingDestinationSelection
A shipping destination that qualifies for 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.
maximumShippingPrice ● MoneyV2
The maximum shipping price amount accepted to qualify for the discount.
More
minimumRequirement ● DiscountMinimumRequirement
The minimum subtotal or quantity that's required for the discount to be applied.
More
shareableUrls ● [DiscountShareableUrl]
URLs that can be used to share the discount.
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.
totalSales ● MoneyV2
The total sales from orders where the discount was used.
More
updatedAt ● Date
The date and time when the discount was updated.
usageLimit ● Int
The maximum number of times that the discount can be used.
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?