Available Endpoints
Object Documentation
Redemption Rule
Coupon Object
AvailableTo Object
Coupon Group Object
POST - Create Redemption Rule
Copy https://api.gameball.co/api/v3.0/integrations/client/redemption/rule
This API is used to create a redemption rule for a client
Request
Body
A client can only have one free_shipping
rule
Sample Request
Copy {
"pointsToRedeem" : 100 ,
"valueOfPoint" : 0.0 ,
"ruleType" : "free_product_settings" ,
"startDate" : null ,
"endDate" : null ,
"coupon" : {
"couponType" : "free_product" ,
"discountValue" : null ,
"minOrderValue" : 100.0 ,
"product" : {
"productId" : "6932183449758" ,
"productName" : "7 Shakra Bracelet" ,
"productDisplayNames" : [] ,
"variantId" : "40691241877662" ,
"variantName" : "Blue"
} ,
"applicableTo" : {
"collections" : [] ,
"productIds" : null
} ,
"group" : {
"handle" : "Free_Sundae"
}
} ,
"availableTo" : {
"level" : {
"levelId" : 12345 ,
"levelName" : "Silver"
} ,
"tags" : [ "VIP" ]
}
}
Response
Body
Redemption Rule Object
Sample Response
Copy {
"id" : 1234 ,
"pointsToRedeem" : 100 ,
"valueOfPoint" : 0.0 ,
"ruleType" : "free_product_settings" ,
"startDate" : null ,
"endDate" : null ,
"coupon" : {
"couponType" : "free_product" ,
"discountValue" : null ,
"minOrderValue" : 100.0 ,
"product" : {
"productId" : "6932183449758" ,
"productName" : "7 Shakra Bracelet" ,
"productDisplayNames" : [] ,
"variantId" : "40691241877662" ,
"variantName" : "Blue"
} ,
"applicableTo" : {
"collections" : [] ,
"productIds" : null
} ,
"group" : {
"handle" : "Free_Sundae" ,
"title" : null ,
"url" : null ,
"iconPath" : null ,
"description" : null ,
"maxPerPlayer" : null ,
"startDate" : null ,
"expiryDate" : null ,
"isAvailable" : false ,
"isValid" : false ,
"isActive" : false
}
} ,
"availableTo" : {
"level" : {
"levelId" : 12345 ,
"levelName" : "Silver"
} ,
"tags" : [ "VIP" ]
}
}
PUT - Update Redemption Rule
Copy https://api.gameball.co/api/v3.0/integrations/client/redemption/config/rule/{ruleId}
This API is used to Update a client's redemption rule
Request
Path Parameters
Body
Only parameters that will be updated should be sent
Redemption Rule Object
Copy {
"pointsToRedeem" : 500
}
Response
Body
Redemption Rule Object
Copy {
"id" : 1234 ,
"pointsToRedeem" : 500 ,
"valueOfPoint" : 0.0 ,
"ruleType" : "free_product_settings" ,
"startDate" : null ,
"endDate" : null ,
"coupon" : {
"couponType" : "free_product" ,
"discountValue" : null ,
"minOrderValue" : 100.0 ,
"product" : {
"productId" : "6932183449758" ,
"productName" : "7 Shakra Bracelet" ,
"productDisplayNames" : [] ,
"variantId" : "40691241877662" ,
"variantName" : "Blue"
} ,
"applicableTo" : {
"collections" : [] ,
"productIds" : null
} ,
"group" : {
"handle" : "Free_Sundae" ,
"title" : null ,
"url" : null ,
"iconPath" : null ,
"description" : null ,
"maxPerPlayer" : null ,
"startDate" : null ,
"expiryDate" : null ,
"isAvailable" : false ,
"isValid" : false ,
"isActive" : false
}
} ,
"availableTo" : {
"level" : {
"levelId" : 12345 ,
"levelName" : "Silver"
} ,
"tags" : [ "VIP" ]
}
}
PUT - Update Default Rule
Copy https://api.gameball.co/api/v3.0/integrations/client/redemption/config/rule
This API is used to Update the default redemption rule.
The default redemption rule defines the value of a point and allows the customer to exchange their points into monetary value based on the rule's configurations
Request
Body
Only parameters that will be updated should be sent
Sample Request
Copy {
"valueOfPoint" : 111.0
}
Response
Body
Sample Response
Copy {
"id" : 1234 ,
"valueOfPoint" : 111.0 ,
"isActive" : true
}
PUT - Update Redemption Configurations
Copy https://api.gameball.co/api/v3.0/integrations/client/redemption/config
This API allows you to edit a client's configurations
Request
Body
Only parameters that will be updated should be sent
Sample Request
Copy {
"IsRedemptionActive" : false ,
"PointsExpiryPeriod" : 800
}
Response
Body
Copy {
"IsRedemptionActive" : false ,
"PointsExpiryPeriod" : 800
}
DELETE - Delete Redemption Rule
Copy https://api.gameball.co/api/v3.0/integrations/client/redemption/config/{ruleId}
This API allows deletes a client's redemption rule
Request
Path Parameters
Default rule cannot be deleted
Response
No Response Body
Sample Response