Add a reward customers can take with their points
post/loyalty/rewards
Add a reward customers can take with their points: money off, a percentage off, free delivery, or a gift handed over in person.
Before you call
- Credential
Authorization: Bearer $KEY- Scope
contacts:admin- Sdk
contacts.loyalty.createReward- Cli
contacts loyalty create reward
Request bodyapplication/json, required
- namestringrequiredAt most 80 characters.
- descriptionstringDefault: . At most 400 characters.
- costPointsintegerrequiredAt least 1. At most 10000000.
- kindstringrequiredOne of: percent, fixed, free_shipping, gift.
- percentBpinteger or null
- amountMinorinteger or null
- currencystring or null
- minSubtotalMinorintegerDefault: 0. At least 0. At most 100000000.
- validDaysintegerDefault: 60. At least 1. At most 365.
- positionintegerDefault: 0. At least 0. At most 1000.
Responses
- 201application/jsonSuccess
- 400application/jsonThe request was malformed
- errorstringrequired
- messagestring
- 401application/jsonNo valid credential
- errorstringrequired
- messagestring
- 403application/jsonThe credential lacks the scope, origin or address
- errorstringrequired
- messagestring
- 429application/jsonOver the key's rate limit; see Retry-After
- errorstringrequired
- messagestring