DiscountCodeFreeShippingInput

Version 2019-07 (Latest)

Specifies input field to create or update free shipping code discount.

Show definition
"""
Specifies input field to create or update free shipping code discount.
"""
input DiscountCodeFreeShippingInput {
  """
  Whether the discount can be applied only once per customer.
  """
  appliesOncePerCustomer: Boolean
  """
  The code to use the discount.
  """
  code: String
  """
  The customers that can use this discount.
  """
  customerSelection: DiscountCustomerSelectionInput
  """
  A list of destinations where the discount will apply.
  """
  destination: DiscountShippingDestinationSelectionInput
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The minimum subtotal or quantity that's required for the discount to be applied.
  """
  minimumRequirement: DiscountMinimumRequirementInput
  """
  The date and time when the discount starts.
  """
  startsAt: DateTime
  """
  The title of the discount.
  """
  title: String
  """
  The maximum number of times that the code discount can be used. For open-ended discounts, use `null`.
  """
  usageLimit: Int
}

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

Version 2019-10 (Release candidate)

Specifies input field to create or update free shipping code discount.

Show definition
"""
Specifies input field to create or update free shipping code discount.
"""
input DiscountCodeFreeShippingInput {
  """
  Whether the discount can be applied only once per customer.
  """
  appliesOncePerCustomer: Boolean
  """
  The code to use the discount.
  """
  code: String
  """
  The customers that can use this discount.
  """
  customerSelection: DiscountCustomerSelectionInput
  """
  A list of destinations where the discount will apply.
  """
  destination: DiscountShippingDestinationSelectionInput
  """
  The date and time when the discount ends. For open-ended discounts, use null.
  """
  endsAt: DateTime
  """
  The minimum subtotal or quantity that's required for the discount to be applied.
  """
  minimumRequirement: DiscountMinimumRequirementInput
  """
  The date and time when the discount starts.
  """
  startsAt: DateTime
  """
  The title of the discount.
  """
  title: String
  """
  The maximum number of times that the code discount can be used. For open-ended discounts, use null.
  """
  usageLimit: Int
}

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

Sign up for a Partner account to get started.

Sign up