Order API

Type

ProductVariantLocalization1

Represents market-specific content and pricing for a product variant.

Localizations allow variants to have different titles, descriptions, alternate titles, and prices in different markets.

Kind Type
Used in AddProductToSubscription1, ApplyCartChange1, Cart2, CustomerBalance3, EstimateAccrual1, ListOffers1, ListProducts1, LoadCart1, LoggedOutBalance1, QueryOrderDetails1, UpdateOrders4, UpdateProducts3

Properties

  • market string required

    Identifier for the market this localization applies to

    Ask your Bubblehouse representative for the correct format of the market keys; this could be in a locale format like en or en_US, or in domain/path format like example.com/en-gb, or completely custom like my-market.

  • title string optional

    Market-specific variant title

    When updating, an empty string preserves the existing title. Provide a non-empty value to change it.

  • alt_titles array of string optional

    Alternative titles for the variant in this market

    When updating:

    • null (or omitted) preserves existing alternate titles
    • Empty array [] clears all alternate titles
    • Non-empty array replaces all alternate titles
  • description string optional

    Market-specific variant description

    When updating, an empty string preserves the existing description. Provide a non-empty value to change it.

  • price array optional

    Market-specific catalog unit price with currency

    A two-element array: decimal amount string and ISO currency code, for example ["40.00", "CAD"]. This price is independent of the base variant price; it is not inferred from an exchange rate.

    When receipt uploading uses catalog prices, the receipt market price takes precedence, followed by a parent market price, then the base variant price in the shop base currency. Quantity, currency conversion into the shop base currency, point rates, multipliers, and rounding still apply. Receipt amounts are not changed.

    Catalog pricing does not change product or variant matching settings. A matched product with exactly one variant uses that variant. Product-only matches with multiple variants earn no catalog-price points until a specific variant is selected.

    Receipt lines with a zero or negative receipt price, catalog price, or quantity remain matched but have a zero points price. Missing receipt prices can still earn catalog-price points.

    An omitted or null price preserves the existing market price. A zero amount with a currency is a known free price. Remove the market localization (or clear all localizations) to remove its price override.

Previous
ProductVariant2