discountCodeFreeShippingUpdate mutation

Version 2020-01 (Release candidate)

Updates a free shipping code discount.

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

freeShippingCodeDiscount ( DiscountCodeFreeShippingInput! ) required

The input data used to update the discount.

id ( ID! ) required

The ID of the code discount to update.

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 this 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 code discount can be used. For open-ended discounts, use null.

Return fields

codeDiscountNode (DiscountCodeNode)

The updated discount.

userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Latest)

Updates a free shipping code discount.

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

freeShippingCodeDiscount ( DiscountCodeFreeShippingInput! ) required

The input data used to update the discount.

id ( ID! ) required

The ID of the code discount to update.

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 this 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 code discount can be used. For open-ended discounts, use null.

Return fields

codeDiscountNode (DiscountCodeNode)

The updated discount.

userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07

Updates a free shipping code discount.

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

freeShippingCodeDiscount ( DiscountCodeFreeShippingInput! ) required

The input data used to update the discount.

id ( ID! ) required

The ID of the code discount to update.

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 this 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 code discount can be used. For open-ended discounts, use null.

Return fields

codeDiscountNode (DiscountCodeNode)

The updated discount.

userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up