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.

Example

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;
    shortDescription?: string;
    rating?: number;
    reviewCount?: number;
    uom?: string;
    price?: number;
    currencyCode?: any;
    currencySymbol?: any;
    quantity?: number;
    baseQuantity?: number;
    baseUom?: Uom;
    usdPrice?: number;
    localPrice?: number;
    sku?: string | number;
    url?: string;
    permalink?: string;
    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[];
}

Hierarchy (View Summary)

Variant
- Product

Properties

`Optional`title

title?: string

Display name of the variant

Example

"Sodium Chloride 500g"

`Optional`description

description?: string

Description of the variant

Example

"Sodium Chloride 500g"

`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`uom

uom?: string

Unit of measurement for the variant quantity

Example

"g"

`Optional`price

price?: number

Numeric price value of the variant

Example

19.99

`Optional`currencyCode

currencyCode?: any

ISO currency code for the price

Example

"USD"

`Optional`currencySymbol

currencySymbol?: any

Display symbol for the currency

Example

"$"

`Optional`quantity

quantity?: number

Available quantity in stock

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`url

url?: string

URL ChemPal queries/processes for this variant — may be an API endpoint rather than a human-facing page.

Example

"/products/sodium-chloride-500g"

`Optional`permalink

permalink?: string

Human-facing page for this variant, i.e. what the user opens in the browser. Defaults to url when not separately provided.

Example

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

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

Interface Variant

Example

Hierarchy (View Summary)

Index

Properties

Properties

Optionaltitle

Example

Optionaldescription

Example

OptionalshortDescription

Example

Optionalrating

Example

OptionalreviewCount

Example

Optionaluom

Example

Optionalprice

Example

OptionalcurrencyCode

Example

OptionalcurrencySymbol

Example

Optionalquantity

Example

OptionalbaseQuantity

Example

OptionalbaseUom

Example

OptionalusdPrice

Example

OptionallocalPrice

Optionalsku

Example

Optionalurl

Example

Optionalpermalink

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

Settings

On This Page

`Optional`title

`Optional`description

`Optional`shortDescription

`Optional`rating

`Optional`reviewCount

`Optional`uom

`Optional`price

`Optional`currencyCode

`Optional`currencySymbol

`Optional`quantity

`Optional`baseQuantity

`Optional`baseUom

`Optional`usdPrice

`Optional`localPrice

`Optional`sku

`Optional`url

`Optional`permalink

`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