Loyalty API

Type

StatusResult1

Authentication and customer loyalty status returned by Status2.

Kind Type
Used in Status2

Properties

  • now time required

    The current Bubblehouse server time.

  • logged_in boolean required

    Whether the authentication token identifies a customer or shop.

  • user object optional

    Brief actor information when the token identifies a customer or shop.

    Null for anonymous requests.

  • shop_slug string required

    The shop slug for the API call.

  • membership MembershipStatus1 required

    The customer's current loyalty membership status.

    When no customer is selected, Bubblehouse evaluates an empty customer. This is usually full, but can be guest or none depending on program rules. A customer whose loyalty program access is disabled also returns none.

  • program_enabled boolean required

    Whether 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.

Previous
Source2