A code discount that gives customers a Buy X Get Y (BXGY) deal.
Fields
appliesTimesPerCustomer ● Int
Limit on the number of uses per customer, null means no limit
asyncUsageCount ● Int
The count of times the discount has been used.
codeCount ● Int
The number of redeem codes for the discount.
codes ● [String]
It returns the first 20 codes of the discount
combinesWith ● DiscountCombinesWith
Determines which discount classes the discount can combine with.
More
createdAt ● Date
The date and time when the discount was created.
customerBuys ● DiscountCustomerBuys
Eligible items for the discount and the quantity of each item the customer must buy.
More
customerGets ● DiscountCustomerGets
Eligible items in the order, the quantity of each item, and the total discount value.
More
customerSelection ● DiscountCustomerSelection
The customers that can use 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.
shareableUrls ● [DiscountShareableUrl]
URLs that can be used to share the discount.
More
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 the discount can be used.
usesPerOrderLimit ● Int
The maximum number of times that the discount can be applied to an order.
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?