API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

DiscountAutomaticBxgyInput input object

Version 2021-01 (Release candidate)

Specifies input field to create or update automatic bogo discount.

Input fields

customerBuys (DiscountCustomerBuysInput)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGetsInput)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usesPerOrderLimit (UnsignedInt64)

The maximum number of times that the discount can be applied to an order.

Version 2020-10 (Latest)

Specifies input field to create or update automatic bogo discount.

Input fields

customerBuys (DiscountCustomerBuysInput)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGetsInput)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usesPerOrderLimit (UnsignedInt64)

The maximum number of times that the discount can be applied to an order.

Version 2020-07

Specifies input field to create or update automatic bogo discount.

Input fields

customerBuys (DiscountCustomerBuysInput)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGetsInput)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usesPerOrderLimit (UnsignedInt64)

The maximum number of times that the discount can be applied to an order.

Version 2020-04

Specifies input field to create or update automatic bogo discount.

Input fields

customerBuys (DiscountCustomerBuysInput)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGetsInput)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usesPerOrderLimit (UnsignedInt64)

The maximum number of times that the discount can be applied to an order.

Version 2020-01

Specifies input field to create or update automatic bogo discount.

Input fields

customerBuys (DiscountCustomerBuysInput)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGetsInput)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usesPerOrderLimit (UnsignedInt64)

The maximum number of times that the discount can be applied to an order.

Version 2019-10 (Unsupported)

Specifies input field to create or update automatic bogo discount.

Input fields

customerBuys (DiscountCustomerBuysInput)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGetsInput)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usesPerOrderLimit (UnsignedInt64)

The maximum number of times that the discount can be applied to an order.

Version 2019-07 (Unsupported)

Specifies input field to create or update automatic bogo discount.

Input fields

customerBuys (DiscountCustomerBuysInput)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGetsInput)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usesPerOrderLimit (UnsignedInt64)

The maximum number of times that the discount can be applied to an order.

Version 2019-04 (Unsupported)

Specifies input field to create or update automatic bogo discount.

Input fields

customerBuys (DiscountCustomerBuysInput)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGetsInput)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usesPerOrderLimit (UnsignedInt64)

The maximum number of times that the discount can be applied to an order.