Loyalty API
TypeStatusResult1
Authentication and customer loyalty status returned by Status2.
| Kind | Type |
|---|---|
| Used in | Status2 |
Properties
-
The current Bubblehouse server time.
-
logged_inboolean requiredWhether the authentication token identifies a customer or shop.
-
userobject optionalBrief actor information when the token identifies a customer or shop.
Null for anonymous requests.
-
shop_slugstring requiredThe shop slug for the API call.
-
The customer's current loyalty membership status.
When no customer is selected, Bubblehouse evaluates an empty customer. This is usually
full, but can beguestornonedepending on program rules. A customer whose loyalty program access is disabled also returnsnone. -
program_enabledboolean requiredWhether the loyalty program is enabled for the evaluated customer.
False means Bubblehouse has disabled the loyalty program for this customer through customer-level rules such as Shopify tags or email patterns.
When no customer is selected, Bubblehouse evaluates an empty customer. This is usually true, but can be false when program enablement rules would exclude an empty customer.