Loyalty API

OrderLineDetails1

Detailed breakdown of point calculations for a single order line item.

Properties

  • idstringrequired

    External ID of the line item from the original order.

  • bhidbubbleflakerequired

    Bubblehouse internal ID for this line item.

  • subtotal_amountmonetaryWithCurrencyrequired

    The subtotal amount for this line item before any loyalty-related calculations.

  • accrual_amountmonetaryWithCurrencyrequired

    The amount that qualifies for point accrual after applying discounts and multipliers.

    This is the final amount used to calculate points for this line item. It may differ from the subtotal due to various factors like loyalty multipliers, excluded categories, or line-specific discounts.

  • accrual_pts_approxintegerrequired

    Approximate number of points this line item would earn.

    The number of points corresponding to accrual_amount. The value is approximate because line item points might not add up to the entire order's exact number of points due to rounding: Bubblehouse normally performs rounding at the order level, so line items that would accrue 1.4 and 2.4 points will report 1 and 2 points respectively, but the entire order would round 3.8 points to 4 in this example. (This depends on the chosen rounding mode for the account, of course; if configured to always round down, no discrepancies can occur, and per-item point numbers are exact.)

  • multiplierpermyriadrequired

    The multiplier applied to this line item, expressed in permyriads.

    Will be 0 for line items that are not eligible for loyalty points.

  • line_discountsmonetaryWithCurrencyoptional

    Line-specific discounts applied to this item.

    These are discounts that apply specifically to this line item, such as product-specific coupons or quantity discounts.

  • extra_discountsmonetaryWithCurrencyoptional

    Additional discounts applied to this item.

    These are additional discounts that may come from order-level promotions, loyalty rewards, or other sources beyond standard line discounts.

This type provides a comprehensive view of how points are calculated for each individual line item in an order, including the original amounts, applicable multipliers, discounts, and estimated point earnings.

Previous
Source2