DiscountCodeFreeShippingInput - admin-graphql - INPUT_OBJECT
Version: 2024-04
Description:
The input fields to create or update a free shipping code discount.
Access Scopes
Fields
-
appliesOnOneTimePurchase:
Boolean -
Whether the discount applies on regular one-time-purchase items.
-
appliesOnSubscription:
Boolean -
Whether the discount applies on subscription items.
-
appliesOncePerCustomer:
Boolean -
Whether the discount can be applied only once per customer.
-
code:
String -
The code to use the discount.
-
combinesWith:
DiscountCombinesWithInput -
Determines which discount classes the shipping discount can combine with.
-
customerSelection:
DiscountCustomerSelectionInput -
The customers that are eligible to use the discount.
-
destination:
DiscountShippingDestinationSelectionInput -
A list of destinations where the discount will apply.
-
endsAt:
DateTime -
The date and time when the discount ends. For open-ended discounts, use `null`.
-
maximumShippingPrice:
Decimal -
The maximum shipping price that qualifies for the discount.
-
minimumRequirement:
DiscountMinimumRequirementInput -
The minimum subtotal or quantity that's required for the discount to be applied.
-
recurringCycleLimit:
Int -
The number of times a discount applies on recurring purchases (subscriptions).
-
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 discount can be used. For open-ended discounts, use `null`.
Input objects with this input object
Examples
