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

    Interface ProductObject

    Represents a product object in the Wix platform format. Used for compatibility with Wix e-commerce platform.

    const product: ProductObject = {
      discountedPrice: "17.99",
      price: "19.99",
      title: "Sodium Chloride ACS Grade",
      url: "/products/sodium-chloride",
      textOptionsFacets: [
        { name: "grade", value: "ACS" }
      ]
    };
    interface ProductObject {
        discountedPrice?: string;
        price: string;
        title: string;
        url: string;
        textOptionsFacets?: TextOptionFacet[];
        id: string;
        handleId: string;
        name: string;
        description: string;
        comparePrice: number;
        pricePerUnit: null | number;
        formattedPrice: string;
        formattedComparePrice: string;
        formattedDiscountedPrice: string;
        formattedPricePerUnit: null | string;
        ribbon: string;
        discountPercentRate: number;
        currency: string;
        sku: string;
        isManageProductItems: boolean;
        isVisible: boolean;
        isInStock: boolean;
        isSellable: boolean;
        hasOptions: boolean;
        productItemsPreOrderAvailability: string;
        isTrackingInventory: boolean;
        weight: number;
        pageUrl: null | string;
        productType: string;
        seoTitle: null | string;
        seoDescription: null | string;
        seoJson: string;
        urlPart: string;
        creationDate: number;
        lastUpdated: number;
        brand: null | string;
        mainCategoryId: null | string;
        isV3: boolean;
        categoryIds: string[];
        formattedMinPriceWithSubscription: null | string;
        formattedMinComparePriceWithSubscription: null | string;
        additionalInfo: WixAdditionalInfo[];
        customTextFields: WixCustomTextField[];
        tags: null | WixTags;
        digitalProductFileItems: WixDigitalProductFileItem[];
        options: ProductOption[];
        productItems: ProductItem[];
        productItemsSummary: null | WixProductItemsSummary;
        media: WixMediaItem[];
        priceRange: null | WixPriceRange;
        discount: null | WixDiscount;
        pricePerUnitData: null | WixPricePerUnitData;
        costAndProfitData: null | WixCostAndProfitData;
        itemDiscount: null | WixItemDiscount;
        inventory: null | WixProductInventory;
        productDimensions: null | WixDimensions;
        packageDimensions: null | WixDimensions;
        ribbonWithId: null | WixRibbonWithId;
        breadcrumbs: null | WixBreadcrumb[];
        groupInfo: null | WixGroupInfo;
        minPriceVariant: null | WixMinPriceVariant;
        variants?: ProductObject[];
    }
    Index

    Properties

    discountedPrice? price title url textOptionsFacets? id handleId name description comparePrice pricePerUnit formattedPrice formattedComparePrice formattedDiscountedPrice formattedPricePerUnit ribbon discountPercentRate currency sku isManageProductItems isVisible isInStock isSellable hasOptions productItemsPreOrderAvailability isTrackingInventory weight pageUrl productType seoTitle seoDescription seoJson urlPart creationDate lastUpdated brand mainCategoryId isV3 categoryIds formattedMinPriceWithSubscription formattedMinComparePriceWithSubscription additionalInfo customTextFields tags digitalProductFileItems options productItems productItemsSummary media priceRange discount pricePerUnitData costAndProfitData itemDiscount inventory productDimensions packageDimensions ribbonWithId breadcrumbs groupInfo minPriceVariant variants?

    Properties

    discountedPrice?: string

    Price after applying any discounts

    "17.99"
    price: string

    Regular price of the product

    "19.99"
    title: string

    Display title of the product

    "Sodium Chloride ACS Grade"
    url: string

    URL to the product's detail page

    "/products/sodium-chloride"
    textOptionsFacets?: TextOptionFacet[]

    Available text-based filtering options

    id: string

    Unique identifier for the product

    handleId: string

    Internal handle identifier

    name: string

    Display name of the product

    description: string

    Detailed product description, which may contain HTML markup

    comparePrice: number

    Compare-at (original) price

    pricePerUnit: null | number

    Per-unit price, 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

    ribbon: string

    Ribbon (badge) text shown on the product

    discountPercentRate: number

    Discount percentage rate applied to the product

    currency: string

    Currency code for the product's prices (e.g. "USD")

    sku: string

    Stock keeping unit identifier

    isManageProductItems: boolean

    Whether product items are individually managed

    isVisible: boolean

    Whether the product is visible in the storefront

    isInStock: boolean

    Indicates whether the product is currently available for purchase

    isSellable: boolean

    Whether the product is sellable

    hasOptions: boolean

    Whether the product has selectable options

    productItemsPreOrderAvailability: string

    Pre-order availability across the product's items

    isTrackingInventory: boolean

    Whether inventory is tracked for the product

    weight: number

    Weight of the product

    pageUrl: null | string

    Canonical page URL of the product

    productType: string

    Classification or category of the product

    seoTitle: null | string

    SEO title

    seoDescription: null | string

    SEO description

    seoJson: string

    Serialized SEO metadata as a JSON string

    urlPart: string

    URL-friendly identifier used in product page links

    creationDate: number

    Creation timestamp (epoch milliseconds)

    lastUpdated: number

    Last-updated timestamp (epoch milliseconds)

    brand: null | string

    Manufacturer or brand name of the product

    mainCategoryId: null | string

    Identifier of the product's main category

    isV3: boolean

    Whether the product uses the V3 catalog schema

    categoryIds: string[]

    Identifiers of all categories the product belongs to

    formattedMinPriceWithSubscription: null | string

    Formatted minimum price when purchased with a subscription

    formattedMinComparePriceWithSubscription: null | string

    Formatted minimum compare-at price when purchased with a subscription

    additionalInfo: WixAdditionalInfo[]

    Additional-info accordion sections (e.g. synonyms, hazards)

    customTextFields: WixCustomTextField[]

    Custom text fields configured on the product

    tags: null | WixTags

    Public and private tag identifiers

    digitalProductFileItems: WixDigitalProductFileItem[]

    Downloadable digital files attached to the product

    options: ProductOption[]

    Array of available customization options for the product

    productItems: ProductItem[]

    Array of specific product variations with their unique combinations

    productItemsSummary: null | WixProductItemsSummary

    Summary counts describing the product's variant inventory

    media: WixMediaItem[]

    Media gallery (images and videos) for the product

    priceRange: null | WixPriceRange

    Aggregated price range across the product's variants

    discount: null | WixDiscount

    Discount applied to the product

    pricePerUnitData: null | WixPricePerUnitData

    Per-unit pricing metadata

    costAndProfitData: null | WixCostAndProfitData

    Owner-only cost and profit figures

    itemDiscount: null | WixItemDiscount

    Automatic item-level discount details

    inventory: null | WixProductInventory

    Product-level inventory information

    productDimensions: null | WixDimensions

    Physical dimensions of the product

    packageDimensions: null | WixDimensions

    Physical dimensions of the product's package

    ribbonWithId: null | WixRibbonWithId

    Ribbon with identifier and product count

    breadcrumbs: null | WixBreadcrumb[]

    Breadcrumb trail describing the product's category path

    groupInfo: null | WixGroupInfo

    Grouping information tying variant products together

    minPriceVariant: null | WixMinPriceVariant

    The cheapest variant, used for "from" pricing

    variants?: ProductObject[]

    Array of variant products

    Settings

    Member Visibility

    On This Page

    Properties