Unredeem1 - Loyalty API - Bubblehouse API

Reverses a point redemption transaction, returning points to the customer's balance.

Kind	Write API call
Method	POST
URL	`https://app.bubblehouse.com/api/v20230601/<shop>/Unredeem1`
Authentication	Customer TokenPartner Token for CustomerShop TokenPartner 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

customer CustomerIdentity1 required if using a shop token

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.
change_bhid bubbleflake required

The ID of the point balance change to reverse.

This should be a change ID that was previously returned by the RedeemPoints1 API call in the change_bhid field.

Output

success boolean required

Indicates whether the redemption was successfully reversed.
pts integer optional

The number of points that were returned to the customer's balance.

Specific Errors

Status	Error	Reason & Examples
422	change_already_reverted	The change has already been reverted.
422	invalid_redemption_for_unredeem	The redemption cannot be unredeemed (only external redemptions or unused redemptions can be unredeemed).
404	not_found	The specified resource does not exist or does not belong to the customer.

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.
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.
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.
404	no_customers_match_customer_identity	The customer identity ('customer' input parameter) does not match a known customer.
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.

Global Errors

Status	Error	Reason & Examples
401	invalid_token	The provided authentication token is invalid or 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.
400	invalid_global_api_version	The global API version you are trying to use has never existed.
400	obsolete_global_api_version	The global API version you are trying to use is no longer supported.
400	inaccessible_global_api_version	The global API version you are trying to use is not enabled on your account.