Input fields for creating or updating an automatic Buy X, Get Y (BXGY) discount.
Fields
startsAt ● Date
Start date and time of the discount
customerBuys ● DiscountCustomerBuysInput
Eligible items for the discount and the quantity of each item that customers must purchase
More
usesPerOrderLimit ● Int
The maximum number of times the discount can be applied per order. If null or omitted, there is no limit.
title ● String
The title of the discount.
endsAt ● Date
The date and time when the discount ends. If null or omitted, the discount has no expiration date.
combinesWith ● DiscountCombinesWithInput
The discount types that can be combined with the discount. If the field is null, an empty object ({}), or is omitted, the discount cannot be combined with any other discounts.
More
customerGets ● DiscountCustomerGetsInput
Eligible items in the order, the quantity of each item, and the total discount value
More
customerSelection ● DiscountCustomerSelectionInput
Specify the customer scope eligible for this discount. If null or omitted during an update, the original value remains unchanged.
More
usageLimit ● Int
The maximum number of times the discount can be used. If null or omitted, there is no total usage limit.
Value range: 1–99,999,999
appliesTimesPerCustomer ● Int
The maximum number of times a single customer can use the discount. If null or omitted, there is no limit.
Value range: 1–99,999,999
Was this article helpful to you?