Documentation
Shop Coupon Request
Properties
  • Account Ids
    Account IDs eligible to use the coupon, when eligibility is SPECIFIC_ACCOUNTS
  • Applies To
    Which products the coupon applies to
  • Category Ids
    Category IDs the coupon applies to, when appliesTo is SPECIFIC_CATEGORY
  • Code
    The coupon code customers enter at checkout
  • Coupon Type
    Type of coupon
  • Coupon Value Fixed
    Coupon value, when couponType is FIXED (a CHF amount)
  • Coupon Value Percentage
    Coupon value, when couponType is PERCENTAGE (0-100)
  • Eligibility
    Which accounts are eligible to use the coupon
  • Max Quantity
    Number of qualifying items a FIXED coupon takes its amount off. Required when couponType is FIXED and appliesTo is SPECIFIC_PRODUCTS or SPECIFIC_CATEGORY, not allowed otherwise
  • Min Purchase Amount
    Minimum purchase amount, when minPurchaseRequirement is MINIMUM_AMOUNT
  • Min Purchase Quantity
    Minimum purchase quantity, when minPurchaseRequirement is MINIMUM_QUANTITY
  • Min Purchase Requirement
    Minimum purchase requirement to use the coupon
  • Per Account Limit
    Maximum number of times a single account can use the coupon
  • Product Ids
    Product IDs the coupon applies to, when appliesTo is SPECIFIC_PRODUCTS
  • Short Description
    Short description of the coupon, per language
  • Usage Limit
    Maximum number of times the coupon can be used per account
  • Valid From
    Date the coupon becomes valid
  • Valid To
    Last day the coupon is valid; must be after validFrom