Order API

Enum

OrderNature

How Bubblehouse treats an order for loyalty purposes.

Most integrations omit nature and let Bubblehouse decide. Bubblehouse sets tag_excluded and loyalty_unavailable itself; sending them is accepted but not needed. loyalty_unavailable is decided once, when the order is first created. A later update that adds an ignored tag can still turn a normal order into tag_excluded.

Kind Enum type
Used in Cart2, EstimateAccrual1, LoadCart1, UpdateOrders4

Values

  • normal

    A regular order. This is the default.

    Normal orders earn points, add to loyalty spend, count toward achievements and order counts, and can approve referrals, subject to the store's configuration.

  • historical

    An order placed before the store started using Bubblehouse, imported to build order history.

    Bubblehouse skips live order effects for historical orders, such as recording coupon code use and creating referrals from referral codes.

  • fake_counted

    Reserved for internal use.

    Processed like normal.

  • stats_adjustment

    Reserved for internal use: a synthetic order that adjusts customer statistics.

    Not visible to customers.

  • tag_excluded

    The order carries a tag the store has configured to ignore.

    Fully excluded from loyalty: no points, spend, achievements or order counts, and no referral is created or approved. Loyalty coupons used on the order are still recorded as used.

  • loyalty_unavailable

    Loyalty is unavailable for this order, for example because the store limits loyalty to some countries and the order ships or bills elsewhere.

    Excluded from loyalty like tag_excluded. Loyalty coupons used on the order are still recorded as used. A referral code or referral link data on the order creates a referral that is rejected right away.

Previous
FulfillmentStatus