INPUT_OBJECT

VoucherInput

link GraphQL Schema definition

  • input VoucherInput {
  • # Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER.
  • type: VoucherTypeEnum
  • # Voucher name.
  • name: String
  • code: String
  • # Start date of the voucher in ISO 8601 format.
  • startDate: DateTime
  • # End date of the voucher in ISO 8601 format.
  • endDate: DateTime
  • # Choices: fixed or percentage.
  • discountValueType: DiscountValueTypeEnum
  • # Value of the voucher.
  • discountValue: Decimal
  • # Products discounted by the voucher.
  • products: [ID]
  • # Collections discounted by the voucher.
  • collections: [ID]
  • # Categories discounted by the voucher.
  • categories: [ID]
  • # Min purchase amount required to apply the voucher.
  • minAmountSpent: Decimal
  • # Minimal quantity of checkout items required to apply the voucher.
  • minCheckoutItemsQuantity: Int
  • # Country codes that can be used with the shipping voucher.
  • countries: [String]
  • # Voucher should be applied to the cheapest item or entire order.
  • applyOncePerOrder: Boolean
  • # Voucher should be applied once per customer.
  • applyOncePerCustomer: Boolean
  • # Limit number of times this voucher can be used in total.
  • usageLimit: Int
  • }

link Require by