discountCodeFreeShippingCreate mutation
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput 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.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput 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.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput 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.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput fields
-
appliesOncePerCustomer (
Boolean
)Whether the discount can be applied only once per customer.
-
code (
String
)The code to use the discount.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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.
-
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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput fields
-
appliesOncePerCustomer (
Boolean
)Whether the discount can be applied only once per customer.
-
code (
String
)The code to use the discount.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
. -
minimumRequirement (
DiscountMinimumRequirementInput
)The minimum subtotal or quantity that's required for the discount to be applied.
-
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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput fields
-
appliesOncePerCustomer (
Boolean
)Whether the discount can be applied only once per customer.
-
code (
String
)The code to use the discount.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
. -
minimumRequirement (
DiscountMinimumRequirementInput
)The minimum subtotal or quantity that's required for the discount to be applied.
-
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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput fields
-
appliesOncePerCustomer (
Boolean
)Whether the discount can be applied only once per customer.
-
code (
String
)The code to use the discount.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
. -
minimumRequirement (
DiscountMinimumRequirementInput
)The minimum subtotal or quantity that's required for the discount to be applied.
-
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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput fields
-
appliesOncePerCustomer (
Boolean
)Whether the discount can be applied only once per customer.
-
code (
String
)The code to use the discount.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
. -
minimumRequirement (
DiscountMinimumRequirementInput
)The minimum subtotal or quantity that's required for the discount to be applied.
-
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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput fields
-
appliesOncePerCustomer (
Boolean
)Whether the discount can be applied only once per customer.
-
code (
String
)The code to use the discount.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
. -
minimumRequirement (
DiscountMinimumRequirementInput
)The minimum subtotal or quantity that's required for the discount to be applied.
-
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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.
Creates a free shipping code discount.
Required access
Apps must have write_discounts
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
freeShippingCodeDiscount
(
DiscountCodeFreeShippingInput!
)
required
|
The input data used to create the code discount. |
DiscountCodeFreeShippingInput fields
-
appliesOncePerCustomer (
Boolean
)Whether the discount can be applied only once per customer.
-
code (
String
)The code to use the discount.
-
customerSelection (
DiscountCustomerSelectionInput
)The customers that can 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
. -
minimumRequirement (
DiscountMinimumRequirementInput
)The minimum subtotal or quantity that's required for the discount to be applied.
-
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
.
Return fields
-
codeDiscountNode (
DiscountCodeNode
)The created code discount.
-
userErrors (
[DiscountUserError!]!
)List of errors that occurred executing the mutation.