Loyalty API

Type

ProductVariantPublic2

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

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

Contains core identifying information about a specific product variant (e.g. a particular size or color). This is a read-only summary; to create or update variants, use the Order API's full ProductVariant2 type.

Properties

  • bhid bubbleflake required

    Bubblehouse internal ID for this variant.

  • id string required

    External ID of the variant from the ecommerce system.

  • title string optional

    Display name of the variant.

  • sku string optional

    Stock Keeping Unit identifier for this variant.

  • deleted boolean optional

    Whether the variant has been deleted.

  • localizations array of ProductVariantLocalization1 optional

    Market-specific variant content for multi-region stores.

Previous
ProductPublic2