LoggedOutBalance1

Returns loyalty program structure for non-authenticated users, allowing them to preview the program before signing in.

Kind	Read API call
Method	GET or POST
URL	https://app.bubblehouse.com/api/v2023061/<shop>/LoggedOutBalance1
Authentication	AnonymousShop Token

This method returns the structure and configuration of the loyalty program for users who have not yet authenticated. It's designed to allow stores to render loyalty program details to anonymous visitors.

This call uses the same response structure as CustomerBalance3 but with values representing a logged out user.

When include_referrals=true is provided and referrals are enabled for this shop, the response includes the same referral_stats structure as CustomerBalance3, filled with zeros.

Input

• include_referrals boolean optional

  If true and referrals are enabled for this shop, the return value will include the referral_stats property filled with zeros.

• include_unused_rewards boolean optional

  If true, the return value will include the unused_rewards property (with an empty value).

• include_full_program boolean optional

  If true, the return value will include information for rendering an entire loyalty program: sources, offers, tiers, milestones.

  Recommended to set this to true when displaying the loyalty program to new visitors to show them all the program benefits.

• market MarketInput1 optional

  Optional market identity. When provided, all translatable strings are returned in the language configured for the matching market. When omitted, default copy is returned.

Output

See CustomerBalanceResult3.

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	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.
400	invalid_global_api_version	The global API version you are trying to use has never existed.