Loyalty API

Type

ProductPublic2

A lightweight view of a product, used when embedding product info inside other objects like order line items or offers.

Kind Type
Used in CustomerBalance3, EstimateAccrual1, ListOffers1, LoggedOutBalance1, QueryOrderDetails1

Contains core identifying information about a product. This is a read-only summary; to create or update products, use the Order API's full Product2 type.

Properties

  • bhid bubbleflake required

    Bubblehouse internal ID for this product.

  • id string required

    External ID of the product from the ecommerce system.

  • slug string optional

    URL-friendly identifier of the product, if available.

  • sku string optional

    Stock Keeping Unit identifier for the product.

  • title string optional

    Display name of the product.

  • image_url string optional

    URL of the product's image, if available.

  • inactive boolean optional

    Whether the product is currently unavailable on the store.

  • deleted boolean optional

    Whether the product has been deleted.

  • localizations array of ProductLocalization1 optional

    Market-specific product content for multi-region stores.

Previous
PointValueBucket2