Skip to main content
POST
string
required
Your store ID in Jelou Shop.
string
required
Code the customer enters at checkout (max. 255 characters).
string
required
Internal coupon name (max. 255 characters).
string
Optional coupon description (max. 1000 characters).
string
required
Discount type. Values: percentage or value (fixed amount).
number
required
Discount value. For percentage it is a value between 0 and 100; for value it is a fixed amount in the store currency.
boolean
default:"true"
Whether the coupon is active. An inactive coupon cannot be applied.
string
Validity start date/time (ISO 8601). If omitted, the coupon is valid from creation.
string
Validity end date/time (ISO 8601). Must be equal to or later than valid_from. If omitted, it never expires.
integer
Total usage limit for the coupon (minimum 1). If omitted, usage is unlimited.
boolean
default:"false"
If true, each customer can use the coupon only once.
boolean
default:"false"
If true, the coupon applies to all branches and branches is ignored. If false, it only applies to the branches listed in branches.
object[]
Branches where the coupon applies (only when applies_to_all_branches is false).
The code must be unique within its branch scope. You cannot create two coupons with the same code if they share a branch (or if either applies to all branches). A percentage discount cannot exceed 100.
Per-branch coupon: send applies_to_all_branches: false and a branches list. Each branch can have its own max_uses and status.