ChemPal Documentation - v0.0.0
    Preparing search index...

    Interface Variant

    Represents a specific variation of a product with its unique characteristics and pricing. Used to model different versions or package sizes of the same product.

    const variant: Variant = {
      title: "Sodium Chloride 500g",
      uom: "g",
      price: 19.99,
      quantity: 500,
      grade: "ACS",
      sku: "NaCl-500"
    };
    interface Variant {
        title?: string;
        description?: string;
        uom?: string;
        price?: number;
        currencyCode?: any;
        currencySymbol?: any;
        quantity?: number;
        baseQuantity?: number;
        baseUom?: any;
        usdPrice?: number;
        localPrice?: number;
        sku?: string | number;
        url?: string;
        id?: string | number;
        uuid?: string | number;
        grade?: string;
        conc?: string;
        status?: string;
        statusTxt?: string;
        shippingInformation?: string;
        availability?: any;
        attributes?: { name: string; value: string }[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    title? description? uom? price? currencyCode? currencySymbol? quantity? baseQuantity? baseUom? usdPrice? localPrice? sku? url? id? uuid? grade? conc? status? statusTxt? shippingInformation? availability? attributes?

    Properties

    title?: string

    Display name of the variant

    description?: string

    Description of the variant

    uom?: string

    Unit of measurement for the variant quantity

    price?: number

    Numeric price value of the variant

    currencyCode?: any

    ISO currency code for the price

    currencySymbol?: any

    Display symbol for the currency

    Example: "$"

    quantity?: number

    Available quantity in stock

    baseQuantity?: number

    Reference quantity for unit conversion calculations

    baseUom?: any

    Reference unit of measurement for conversions

    usdPrice?: number

    Price converted to USD for comparison

    localPrice?: number

    The price convert to the users local currency

    sku?: string | number

    Stock keeping unit identifier for inventory tracking

    url?: string

    URL to the variant's detail page

    id?: string | number

    Unique identifier within the system

    uuid?: string | number

    Globally unique identifier

    grade?: string

    Chemical grade specification (e.g., 'ACS', 'Technical')

    conc?: string

    Chemical concentration specification

    status?: string

    Current status code of the variant

    statusTxt?: string

    Human-readable status description

    shippingInformation?: string

    Special shipping requirements or information

    Example: "Hazardous material - special shipping required"

    availability?: any

    Availability of the variant

    attributes?: { name: string; value: string }[]

    Attributes of the variant

    Example: `[{ name: "Size", value: "500g" }]`

    Settings

    Member Visibility

    On This Page

    Properties