DiscountCodeBxgyInput input object

Version 2020-01 (Release candidate)

Specifies input field to create or update a BXGY code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

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.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use this 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.

usageLimit (Int)

The maximum number of times that the code discount can be used. For open-ended discounts, use null.

usesPerOrderLimit (Int)

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

Version 2019-10 (Latest)

Specifies input field to create or update a BXGY code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

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.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use this 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.

usageLimit (Int)

The maximum number of times that the code discount can be used. For open-ended discounts, use null.

usesPerOrderLimit (Int)

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

Version 2019-07

Specifies input field to create or update a BXGY code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

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.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use this 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.

usageLimit (Int)

The maximum number of times that the code discount can be used. For open-ended discounts, use null.

usesPerOrderLimit (Int)

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

Sign up for a Partner account to get started.

Sign up