Skip to main content
POST
Create reward option

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Body

application/json
rewardName
string
required
costToRedeem
integer
required
Required range: x >= 1
discountType
enum<string>
required
Available options:
fixed_amount,
percentage,
free_shipping
discountValue
required

Decimal string up to 4 decimals. Percentage must be 1-100.

expirationPreset
enum<string>
required
Available options:
NO_EXPIRATION,
SEVEN_DAYS,
THIRTY_DAYS,
NINETY_DAYS,
ONE_YEAR
voucherPrefix
string | null
minimumPurchaseAmount

Decimal string up to 4 decimals.

Response

201 - application/json

Created

id
string
companyId
integer
rewardName
string
costToRedeem
integer
discountType
enum<string>
Available options:
fixed_amount,
percentage,
free_shipping
discountValue
number
voucherPrefix
string | null
minimumPurchaseAmount
number
expirationPreset
enum<string>
Available options:
NO_EXPIRATION,
SEVEN_DAYS,
THIRTY_DAYS,
NINETY_DAYS,
ONE_YEAR
priceRuleId
string
startsAt
string<date-time>
endsAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>