The input fields for creating or updating a free shipping code.
Fields
code ● String
The code to use the discount.
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
customerSelection ● DiscountCustomerSelectionInput
The customers eligible for the discount. If null or omitted during an update, the original value remains unchanged.
More
The list of destinations where the discount applies. If null or omitted during an update, the original value remains unchanged.
More
startsAt ● Date
The date and time when the discount starts.
title ● String
The title of the discount.
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
endsAt ● Date
The date and time when the discount ends. If null or omitted, the discount has no expiration date.
maximumShippingPrice ● Decimal
The maximum shipping fee eligible for the discount. If null or omitted, there is no limit on the shipping fee.
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
minimumRequirement ● DiscountMinimumRequirementInput
The minimum item quantity or order subtotal required for the discount. If null or omitted, there is no minimum requirement.
More
Was this article helpful to you?