Loyalty API
Unredeem1
Reverses a point redemption transaction, returning points to the customer's balance.
| Method | POST |
|---|---|
| Kind | Write |
| URL | https://app.bubblehouse.com/api/v2023061/<shop>/Unredeem1 |
| Authentication | Customer TokenShop TokenPartner Token for CustomerPartner Token for Shop |
You have a choice of making this call from your server using a shop token and specifying a customer ID, or making this call from a web browser/app using a customer token you have generated on the server.
Input
A customer to operate upon, when using a shop token.
If you're using a customer token and decide to pass this field (which we do not recommend), it must match the customer from the token.
The ID of the point balance change to reverse.
This should be a change ID that was previously returned by the
RedeemPoints1API call in thechange_bhidfield.
Output
successbooleanrequiredIndicates whether the redemption was successfully reversed.
ptsintegeroptionalThe number of points that were returned to the customer's balance.
Specific Errors
| Status | Error | Reason & Examples |
|---|---|---|
| change_already_reverted | {"id":"change_already_reverted"} | |
| invalid_redemption_for_unredeem | {"id":"invalid_redemption_for_unredeem"} | |
| not_found | {"id":"not_found"} |
API-wide Errors
| Status | Error | Reason & Examples |
|---|---|---|
| 400 | missing_customer_identity | The customer identity ('customer' input parameter) has not been specified when using a shop token. You need to either specify a non-empty value for one of the customer identity fields, or use a customer token. {"id":"missing_customer_identity"} |
| 404 | empty_customer_identity | All fields of the customer identity ('customer' input parameter) have been empty when using a shop token. You need to either specify a non-empty value for one of the customer identity fields, or use a customer token. {"id":"empty_customer_identity"} |
| 404 | no_customers_match_customer_identity | The customer identity ('customer' input parameter) does not match a known customer. {"id":"no_customers_match_customer_identity"} |
| 404 | customer_identity_partially_mismatches_matched_customer | A customer has been matched by one of the fields of the customer identity ('customer' input parameter), but some non-empty fields do not match Bubblehouse data on that customer. {"id":"customer_identity_partially_mismatches_matched_customer"} |
| 403 | customer_identity_does_not_match_token | API call is using a customer token, but the customer identity in API params does not match the customer from the token. {"id":"customer_identity_does_not_match_token"} |
Global Errors
| Status | Error | Reason & Examples |
|---|---|---|
| 401 | invalid_token | The provided authentication token is invalid or has expired. {"id":"invalid_token","message":"The token has expired"} |
| 429 | rate_limit_exceeded | Your usage is over the rate limit. Ensure that you're not making duplicate calls, and contact our team for a rate limit increase. {"id":"rate_limit_exceeded","message":"You are over the read limit per second for this customer"} |
| 400 | obsolete_global_api_version | The global API version you are trying to use is no longer supported. {"id":"obsolete_global_api_version"} |
| 400 | invalid_global_api_version | The global API version you are trying to use has never existed. {"id":"invalid_global_api_version"} |
| 400 | inaccessible_global_api_version | The global API version you are trying to use is not enabled on your account. {"id":"inaccessible_global_api_version"} |