ChemPal Documentation - v1.7.0
    Preparing search index...

    Interface ProductItem

    Represents a specific product item with its price and options. Used for product variations.

    interface ProductItem {
        id: string;
        optionsSelections: number[];
        isVisible?: boolean;
        availableForPreOrder?: boolean;
        sku?: null | string;
        surcharge?: number;
        weight?: number;
        price: number;
        comparePrice?: number;
        discountedPrice?: number;
        pricePerUnit?: null | number;
        formattedPrice: string;
        formattedComparePrice?: string;
        formattedDiscountedPrice?: string;
        formattedPricePerUnit?: null | string;
        isTrackingInventory?: null | boolean;
        hasDiscount?: boolean;
        inventory?: null | WixItemInventory;
        productDimensions?: null | WixDimensions;
        packageDimensions?: null | WixDimensions;
    }
    Index

    Properties

    id optionsSelections isVisible? availableForPreOrder? sku? surcharge? weight? price comparePrice? discountedPrice? pricePerUnit? formattedPrice formattedComparePrice? formattedDiscountedPrice? formattedPricePerUnit? isTrackingInventory? hasDiscount? inventory? productDimensions? packageDimensions?

    Properties

    id: string

    Unique identifier for the product item

    optionsSelections: number[]

    Array of selected option IDs that define this specific product variation

    isVisible?: boolean

    Whether this item is visible in the storefront

    availableForPreOrder?: boolean

    Whether this item is available for pre-order

    sku?: null | string

    SKU of the item, when set

    surcharge?: number

    Price surcharge applied on top of the base price for this item

    weight?: number

    Weight of the item

    price: number

    Numeric price value of the product item

    comparePrice?: number

    Compare-at (original) price of the item

    discountedPrice?: number

    Discounted price of the item

    pricePerUnit?: null | number

    Per-unit price of the item, when applicable

    formattedPrice: string

    Human-readable formatted price string (e.g. "$19.99")

    formattedComparePrice?: string

    Formatted compare-at price

    formattedDiscountedPrice?: string

    Formatted discounted price

    formattedPricePerUnit?: null | string

    Formatted per-unit price

    isTrackingInventory?: null | boolean

    Whether inventory is tracked for this item

    hasDiscount?: boolean

    Whether this item currently has a discount applied

    inventory?: null | WixItemInventory

    Inventory snapshot for this item

    productDimensions?: null | WixDimensions

    Physical dimensions of the product item

    packageDimensions?: null | WixDimensions

    Physical dimensions of the item's package

    Settings

    Member Visibility

    On This Page

    Properties