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 discount code customers enter at checkout
  • Discount Type
    Type of discount granted by the coupon
  • Discount Value
    Discount value (percentage or fixed amount, null for free shipping)
  • Eligibility
    Which accounts are eligible to use the coupon
  • Max Discount
    Maximum discount amount the coupon can grant
  • Min Purchase Quantity
    Minimum purchase quantity, when minPurchaseRequirement is MINIMUM_QUANTITY
  • Min Purchase Requirement
    Minimum purchase requirement to use the coupon
  • Min Purchase Value
    Minimum purchase amount, when minPurchaseRequirement is MINIMUM_AMOUNT
  • 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
  • Usage Limit
    Maximum number of times the coupon can be used per account
  • Valid From
    Date the coupon becomes valid
  • Valid To
    Date the coupon expires