Cashback Rule 🤝
APIs to create, update or delete Redemption Rules and Configurations
Available Endpoints
POST
integrations/client/cashback/config/rule
PUT
integrations/client/cashback/rule/{ruleId}
PUT
integrations/client/cashback/rule
PUT
integrations/client/cashback/config
DELETE
integrations/client/cashback/rule/{ruleId}
Object Documentation
Cashback Rule
id
integer
Id of the cashback rule
isDefaultRule
boolean
A boolean indicating if the cashback rule is the default one
minAmountToSpend
double
Amount needed to be spent in order to be rewarded the cashback
pointsRewardedAsCashback
double
Points awarded for the amount specified in minAmountToSpend
availableTo
Object
AvailableTo Object
level
Object
A Level object indicating the VIP tier that the rule is available to,
The Level object has the following attributes:
levelName
String
levelId
integer
tags
array
An array of tag names that the rule is available to
POST - Create Cashback Rule
This API is used to create a client's cashback rule
Request
Header
Authorization
string
Yes
Partner Access Token, The token is of type Bearer
storeId
string
Yes
Id of the store on the partner's system
Body
Note that you can only create cashback rules that are limited to a certain VIP tier or tags, you cannot create a general default cashback rule that is available to all customers (A default cashback rule is created once a client is created automatically)
minAmountToSpend
double
Yes
Amount needed to be spent in order to be rewarded the cashback
pointsRewardedAsCashback
double
Yes
Points awarded for the amount specified in minAmountToSpend
availableTo
Object
Yes
(If left empty or null it will be applied to all)
Sample Request
Response
Body
Sample Response
PUT - Update Cashback Rule
This API is used to update a client's cashback rule
Request
Header
Authorization
string
Yes
Partner Access Token, The token is of type Bearer
storeId
string
Yes
Id of the store on the partner's system
Path Parameters
ruleId
integer
Id of the client's cashback rule
Body
Only parameters that will be updated should be sent
Sample Request
Response
Body
Sample Response
PUT - Update Default Rule
This API is used to update the default cashback rule (Cashback rule that applies to all customers)
Request
Header
Authorization
string
Yes
Partner Access Token, The token is of type Bearer
storeId
string
Yes
Id of the store on the partner's system
Body
isActive
boolean
A Boolean indicating if the cashback program is active
minAmountToSpend
double
Amount needed to be spent in order to be rewarded the cashback
pointsRewardedAsCashback
double
Points awarded for the amount specified in minAmountToSpend
Response
Body
Sample Response
PUT - Update Cashback Configurations
This API is used to updated general configrations of the cashback program
Request
Header
Authorization
string
Yes
Partner Access Token, The token is of type Bearer
storeId
string
Yes
Id of the store on the partner's system
Body
Only parameters that will be updated should be sent
isCashbackActive
boolean
A Boolean flag indicating if the Cashback program is active for the client
returnWindowDuration
integer
Number of days that the customer can return an order and points get deducted accordingly
Sample Request
Response
Body
isCashbackActive
boolean
A Boolean flag indicating if the Cashback program is active for the client
returnWindowDuration
integer
Number of days that the customer can return an order and points get deducted accordingly
Sample Response
DELETE - Delete Cashback Rule
This API deletes a client's cashback rule
Request
Header
Authorization
string
Yes
Partner Access Token, The token is of type Bearer
storeId
string
Yes
Id of the store on the partner's system
Path Parameters
Default rule cannot be deleted
ruleId
integer
Id of the client's cashback rule
Response
Body
No Response Body
Sample Response
Last updated