Integrating Curebit on Your Site
Purchase API
This is a preliminary API release and is subject to change. Please contact us if you are planning to use our API.
Approve/Void rewards for purchases
You can approve or void rewards for purchase that are waiting approval NOTE: Approved or voided purchases could not be changed to opposite state
PUT Resource URL (format: JSON):
https://www.curebit.com/api/v1/sites/:site_slug/purchases/:order_number/set_rewards_status?api_key=#{api_key}&status=[approved,voided]
| Parameter | Description | Example |
|---|---|---|
|
api_key
Required |
Your API key |
Your api_key is:
CRljoG5Glb8xeNCv1NO |
|
site_slug
Required |
Your site name slug |
Your possible site_slug values:
my-store |
|
order_number
Required |
Purchase Order number for what needs approve/void rewards | 123 |
|
status
Required |
Rewards status that needs to set | approved, voided |
| HTTP Code | HTTP Body | Description |
|---|---|---|
| 200 OK | { success => true } | Order found/status changed |
| 200 OK | { success => true, notice => "no rewards" } | Order does not have rewards |
| 400 Bad Request |
{ success => false,
error => :error_message } |
The 'status' is wrong |
| 403 Forbidden |
{ success => false,
error => :error_message } |
The request failed and no purchase's rewards were changed |
| 404 Not Found |
{ success => false,
error => "An exception occurred. No site found by site_slug: #{site_slug}" } |
The 'site' could not be found by 'site_slug' |
| 400 Bad Request |
{ success => false,
error => "Couldn't find Purchase with order_number = #{order_number}" } |
The order could not be found by 'order_number' |
NOTE: If purchase was not redeemed and does not have rewards it will return success too
