Interface Product

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

Example

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 {
    shortDescription?: string;
    rating?: number;
    reviewCount?: number;
    baseQuantity?: number;
    baseUom?: Uom;
    usdPrice?: number;
    localPrice?: number;
    sku?: string | number;
    id?: string | number;
    uuid?: string | number;
    cacheKey?: string;
    grade?: string;
    concentration?: string;
    moleweight?: number;
    formula?: string;
    purity?: string;
    status?: string;
    statusTxt?: string;
    shippingInformation?: string;
    purchaseRestriction?: PurchaseRestriction;
    availability?: Availability;
    attributes?: { name: string; value: string }[];
    moles?: number;
    images?: ProductImage[];
    _id?: number;
    parentProduct?: { title: string; url: string; permalink?: string };
    priceSeriesKey?: string;
    priceTrendValue?: number;
    supplier: string;
    title: string;
    url: string;
    permalink?: string;
    price: number;
    currencyCode: valueof;
    currencySymbol: valueof;
    quantity: number;
    uom: string;
    description?: string;
    manufacturer?: string;
    cas?: `${string}-${string}-${string}`;
    vendor?: string;
    variants?: Variant[];
    docLinks?: string[];
    sdsUrl?: string;
    coaUrl?: string;
    specSheetUrl?: string;
    supplierCountry?: any;
    supplierShipping?: ShippingRange;
    paymentMethods?: PaymentMethod[];
    supplierEbayStoreURL?: string;
    supplierAmazonStoreURL?: string;
    _fuzz?: { score: number; idx: number };
    matchPercentage?: number;
    smiles?: undefined;
    iupacName?: IupacName<string>;
    pubchemId?: PubChemCID;
    inchiKey?: InChIKey<string>;
    inchi?: InChI<string>;
}

Hierarchy (View Summary)

Variant
SyntheticFields
- Product

Properties

`Optional`shortDescription

shortDescription?: string

Short description of the variant

Example

"Sodium Chloride 500g"

`Optional`rating

rating?: number

Rating of the variant

Example

4.5

`Optional`reviewCount

reviewCount?: number

Number of reviews for the variant

Example

`Optional`baseQuantity

baseQuantity?: number

Reference quantity for unit conversion calculations

Example

`Optional`baseUom

baseUom?: Uom

Reference unit of measurement for conversions

Example

"g"

`Optional`usdPrice

usdPrice?: number

Price converted to USD for comparison

Example

19.99

`Optional`localPrice

localPrice?: number

The price convert to the users local currency

`Optional`sku

sku?: string | number

Stock keeping unit identifier for inventory tracking

Example

"NaCl-500"

`Optional`id

id?: string | number

Unique identifier within the system

Example

`Optional`uuid

uuid?: string | number

Globally unique identifier

Example

"550e8400-e29b-41d4-a716-446655440000"

`Optional`cacheKey

cacheKey?: string

Stable per-product cache/exclusion identity, as derived by SupplierBase.getUniqueProductKey and frozen on the builder at parse time. Combined with the supplier name (via getProductIdentityKey) to key the product-detail cache and the "Ignore Product" exclusion store.

Example

"FAM_889460"

`Optional`grade

grade?: string

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

Example

"ACS"

`Optional`concentration

concentration?: string

Chemical concentration specification

Example

"98%"

`Optional`moleweight

moleweight?: number

Molecular weight of the variant

Example

100.00

`Optional`formula

formula?: string

Molecular formula

Example

`C<sub>18</sub>H<sub>33</sub>NaO<sub>3</sub>`

`Optional`purity

purity?: string

Purity of the variant, as a percentage string. Keeps any qualifier the supplier reports, e.g. comparators (<, >, ≤, ≥) and the % sign.

Example

"98%"

Example

"≥99%"

`Optional`status

status?: string

Current status code of the variant

Example

"IN_STOCK"

`Optional`statusTxt

statusTxt?: string

Human-readable status description

Example

"In Stock"

`Optional`shippingInformation

shippingInformation?: string

Special shipping requirements or information

Example

"Hazardous material - special shipping required"

`Optional`purchaseRestriction

purchaseRestriction?: PurchaseRestriction

Parsed purchase restrictions (region/buyer/etc.) used to hide options a given user cannot buy. See PurchaseRestriction.

`Optional`availability

availability?: Availability

Availability of the variant

Example

"IN_STOCK"

`Optional`attributes

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

Attributes of the variant

Example

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

`Optional`moles

moles?: number

Number of moles of the variant

Example

23.5

`Optional`images

images?: ProductImage[]

Flat list of the product's images. Full-size images and thumbnails are kept as separate, independent entries distinguished by their type field (see ProductImage; a supplier's main image/thumbnail is often not part of its gallery). The first entry of each type is treated as that type's default.

Example

`[{ href: "https://example.com/image.jpg", type: "image" }, { href: "https://example.com/thumb.jpg", type: "thumbnail" }]`

`Optional`_id

_id?: number

Positional index of the product within the current search-results list, assigned at render/persist time. This is NOT a stable product identifier (that is id) — it only conveys row position, so consumers that need a unique row key can use it without clobbering the real product id.

Example

`Optional`parentProduct

parentProduct?: { title: string; url: string; permalink?: string }

Display-only back-reference to the main product, set on flattened variant rows when the "group product variants" setting is off (see flattenProductVariants). Lets the detail panel link back to the parent instead of listing variants. Never set by suppliers, never persisted or exported.

`Optional`priceSeriesKey

priceSeriesKey?: string

Display-only price-history series id for this row, stamped on flattened variant rows when the "group product variants" setting is off (see flattenProductVariants). Because flattening merges the variant onto a copy of the product and drops variants, the row can no longer recompute its own variantSeriesKey; carrying the resolved key lets the results table look up the variant's recorded series directly. Never set by suppliers, never persisted or exported.

`Optional`priceTrendValue

priceTrendValue?: number

Display-only signed percent change of this row's price trend (rising = +, falling = −), stamped by the results table so its trend column has a value to sort by (price history isn't on the row — it's loaded separately). Absent when the row has no drawable trend. Never set by suppliers, never persisted or exported.

supplier

supplier: string

Name of the supplier providing the product

Example

"Loudwolf"

title

title: string

Full product title/name

Example

"Sodium Chloride ACS Grade 500g"

url

url: string

Absolute URL ChemPal queries/processes for this product. For scraped suppliers this is the product page; for JSON-backed suppliers it may be an API endpoint. Used as the product's processing identity (cache and exclusion keys, detail fetches).

Example

"https://supplier.com/products/sodium-chloride-500g"

`Optional`permalink

permalink?: string

Absolute human-facing page the user opens in the browser. Defaults to url (so scraped suppliers need not set it); JSON-backed suppliers whose web UI differs from their API endpoint set it explicitly.

Example

"https://supplier.com/products/sodium-chloride-500g"

price

price: number

Current price of the product

Example

19.99

currencyCode

currencyCode: valueof

ISO currency code for the price

Example

"USD"

currencySymbol

currencySymbol: valueof

Display symbol for the currency

Example

"$"

quantity

quantity: number

Available quantity in stock

Example

uom

uom: string

Standardized unit of measurement

Example

"g"

`Optional`description

description?: string

Detailed product description

Example

"ACS grade sodium chloride suitable for analytical use"

`Optional`manufacturer

manufacturer?: string

Name of the product manufacturer

Example

"Sigma-Aldrich"

`Optional`cas

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

Chemical Abstracts Service registry number

Example

"7647-14-5"

`Optional`vendor

vendor?: string

Alternative name for the supplier

Example

"Sigma"

`Optional`variants

variants?: Variant[]

Array of available product variations

`Optional`docLinks

docLinks?: string[]

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

Example

["https://supplier.com/msds/nacl.pdf"]

`Optional`sdsUrl

sdsUrl?: string

URL to the product's SDS page

Example

"https://supplier.com/sds/nacl.pdf"

`Optional`coaUrl

coaUrl?: string

URL to the product's Certificate of Analysis (COA) document

Example

"https://supplier.com/coa/nacl.pdf"

`Optional`specSheetUrl

specSheetUrl?: string

specsheet

`Optional`supplierCountry

supplierCountry?: any

Country of the supplier

Example

"US"

`Optional`supplierShipping

supplierShipping?: ShippingRange

Shipping scope of the supplier

Example

"worldwide" | "domestic" | "international" | "local"

`Optional`paymentMethods

paymentMethods?: PaymentMethod[]

Payment methods accepted by the supplier

Example

["visa", "mastercard"]

`Optional`supplierEbayStoreURL

supplierEbayStoreURL?: string

The supplier's eBay storefront, set when they accept "ebayonly" — they restrict shipping on their own site but ship more freely via the marketplace.

Example

"https://www.ebay.com/str/dailybiousa"

`Optional`supplierAmazonStoreURL

supplierAmazonStoreURL?: string

The supplier's Amazon storefront, set when they accept "amazononly".

Example

"https://www.amazon.com/s?k=HiMedia"

`Optional`_fuzz

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

Levenshtein result of the product title and the search string

Example

`Optional`matchPercentage

matchPercentage?: number

Match percentage of the product title and the search string

Example

`Optional`smiles

smiles?: undefined

SMILES notation for the product

Example

"C1=CC=CC=C1"

`Optional`iupacName

iupacName?: IupacName<string>

IUPAC name for the product

Example

"dipotassium;oxalate"

`Optional`pubchemId

pubchemId?: PubChemCID

PubChem Compound ID (CID) for the product

Example

`Optional`inchiKey

inchiKey?: InChIKey<string>

InChIKey for the product

Example

"IRXRGVFLQOSHOH-UHFFFAOYSA-L"

`Optional`inchi

inchi?: InChI<string>

InChI string for the product

Example

"1S/C2H2O4.2K/c3-1(4)2(5)6;;/h(H,3,4)(H,5,6);;/q;2*+1/p-2"

Interface Product

Example

Hierarchy (View Summary)

Index

Properties

Properties

OptionalshortDescription

Example

Optionalrating

Example

OptionalreviewCount

Example

OptionalbaseQuantity

Example

OptionalbaseUom

Example

OptionalusdPrice

Example

OptionallocalPrice

Optionalsku

Example

Optionalid

Example

Optionaluuid

Example

OptionalcacheKey

Example

Optionalgrade

Example

Optionalconcentration

Example

Optionalmoleweight

Example

Optionalformula

Example

Optionalpurity

Example

Example

Optionalstatus

Example

OptionalstatusTxt

Example

OptionalshippingInformation

Example

OptionalpurchaseRestriction

Optionalavailability

Example

Optionalattributes

Example

Optionalmoles

Example

Optionalimages

Example

Optional_id

Example

OptionalparentProduct

OptionalpriceSeriesKey

OptionalpriceTrendValue

supplier

Example

title

Example

url

Example

Optionalpermalink

Example

price

Example

currencyCode

Example

currencySymbol

Example

quantity

Example

uom

Example

Optionaldescription

Example

Optionalmanufacturer

Example

`Optional`shortDescription

`Optional`rating

`Optional`reviewCount

`Optional`baseQuantity

`Optional`baseUom

`Optional`usdPrice

`Optional`localPrice

`Optional`sku

`Optional`id

`Optional`uuid

`Optional`cacheKey

`Optional`grade

`Optional`concentration

`Optional`moleweight

`Optional`formula

`Optional`purity

`Optional`status

`Optional`statusTxt

`Optional`shippingInformation

`Optional`purchaseRestriction

`Optional`availability

`Optional`attributes

`Optional`moles

`Optional`images

`Optional`_id

`Optional`parentProduct

`Optional`priceSeriesKey

`Optional`priceTrendValue

`Optional`permalink

`Optional`description

`Optional`manufacturer

`Optional`cas

`Optional`vendor

`Optional`variants

`Optional`docLinks

`Optional`sdsUrl

`Optional`coaUrl

`Optional`specSheetUrl

`Optional`supplierCountry

`Optional`supplierShipping

`Optional`paymentMethods

`Optional`supplierEbayStoreURL

`Optional`supplierAmazonStoreURL

`Optional`_fuzz

`Optional`matchPercentage

`Optional`smiles

`Optional`iupacName

`Optional`pubchemId

`Optional`inchiKey

`Optional`inchi