discountCodeFreeShippingUpdate mutation

Version unstable

Updates 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.


Argument Description
freeShippingCodeDiscount ( DiscountCodeFreeShippingInput! ) required

The input data used to update the code discount.

id ( ID! ) required

The ID of the code discount to update.

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.

  • 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.