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

    Interface Product

    Represents a chemical product with its complete details, extending the Variant interface. This is the main product type used throughout the application.

    const product: Product = {
      supplier: "Loudwolf",
      title: "Sodium Chloride ACS Grade",
      url: "/products/sodium-chloride-acs",
      price: 19.99,
      currencyCode: "USD",
      currencySymbol: "$",
      quantity: 500,
      uom: "g",
      cas: "7647-14-5",
      formula: "NaCl"
    };
    interface Product {
        baseQuantity?: number;
        baseUom?: any;
        usdPrice?: number;
        localPrice?: number;
        sku?: string | number;
        id?: string | number;
        uuid?: string | number;
        grade?: string;
        conc?: string;
        status?: string;
        statusTxt?: string;
        shippingInformation?: string;
        availability?: any;
        attributes?: { name: string; value: string }[];
        supplier: string;
        title: string;
        url: string;
        price: number;
        currencyCode: valueof;
        currencySymbol: valueof;
        quantity: number;
        uom: valueof<any>;
        description?: string;
        manufacturer?: string;
        cas?: `${string}-${string}-${string}`;
        formula?: string;
        vendor?: string;
        variants?: Variant[];
        docLinks?: string[];
        supplierCountry?: string;
        supplierShipping?: ShippingRange;
        paymentMethods?: PaymentMethod[];
        _fuzz?: { score: number; idx: number };
        matchPercentage?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    baseQuantity? baseUom? usdPrice? localPrice? sku? id? uuid? grade? conc? status? statusTxt? shippingInformation? availability? attributes? supplier title url price currencyCode currencySymbol quantity uom description? manufacturer? cas? formula? vendor? variants? docLinks? supplierCountry? supplierShipping? paymentMethods? _fuzz? matchPercentage?

    Properties

    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

    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" }]`

    supplier: string

    Name of the supplier providing the product

    title: string

    Full product title/name

    url: string

    Absolute URL to the product's detail page

    price: number

    Current price of the product

    currencyCode: valueof

    ISO currency code for the price

    currencySymbol: valueof

    Display symbol for the currency

    Example: "$"

    quantity: number

    Available quantity in stock

    uom: valueof<any>

    Standardized unit of measurement

    description?: string

    Detailed product description

    manufacturer?: string

    Name of the product manufacturer

    cas?: `${string}-${string}-${string}`

    Chemical Abstracts Service registry number

    formula?: string

    Chemical molecular formula

    vendor?: string

    Alternative name for the supplier

    variants?: Variant[]

    Array of available product variations

    docLinks?: string[]

    URLs to related documentation (MSDS, SDS, etc.)

    supplierCountry?: string

    Country of the supplier

    supplierShipping?: ShippingRange

    Shipping scope of the supplier

    Example: "worldwide" | "domestic" | "international" | "local"

    paymentMethods?: PaymentMethod[]

    Payment methods accepted by the supplier

    Optional_fuzz

    _fuzz?: { score: number; idx: number }

    Levenshtein result of the product title and the search string

    matchPercentage?: number

    Match percentage of the product title and the search string

    Settings

    Member Visibility

    On This Page

    Properties