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 {
    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 }[];
    moles?: number;
    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)

Variant
SyntheticFields
- Product

Properties

`Optional`baseQuantity

baseQuantity?: number

Reference quantity for unit conversion calculations

Example

`Optional`baseUom

baseUom?: any

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

grade?: string

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

Example

"ACS"

`Optional`conc

conc?: string

Chemical concentration specification

Example

"98%"

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

availability?: any

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

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 to the product's detail page

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: valueof<any>

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

formula?: string

Chemical molecular formula

Example

"NaCl"

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

supplierCountry?: string

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

Interface Product

Example

Hierarchy (View Summary)

Index

Properties

Properties

OptionalbaseQuantity

Example

OptionalbaseUom

Example

OptionalusdPrice

Example

OptionallocalPrice

Optionalsku

Example

Optionalid

Example

Optionaluuid

Example

Optionalgrade

Example

Optionalconc

Example

Optionalstatus

Example

OptionalstatusTxt

Example

OptionalshippingInformation

Example

Optionalavailability

Example

Optionalattributes

Example

Optionalmoles

Example

supplier

Example

title

Example

url

Example

price

Example

currencyCode

Example

currencySymbol

Example

quantity

Example

uom

Example

Optionaldescription

Example

Optionalmanufacturer

Example

Optionalcas

Example

Optionalformula

Example

Optionalvendor

Example

Optionalvariants

OptionaldocLinks

Example

OptionalsupplierCountry

Example

OptionalsupplierShipping

Example

OptionalpaymentMethods

Example

Optional_fuzz

Example

OptionalmatchPercentage

Example

Settings

On This Page

`Optional`baseQuantity

`Optional`baseUom

`Optional`usdPrice

`Optional`localPrice

`Optional`sku

`Optional`id

`Optional`uuid

`Optional`grade

`Optional`conc

`Optional`status

`Optional`statusTxt

`Optional`shippingInformation

`Optional`availability

`Optional`attributes

`Optional`moles

`Optional`description

`Optional`manufacturer

`Optional`cas

`Optional`formula

`Optional`vendor

`Optional`variants

`Optional`docLinks

`Optional`supplierCountry

`Optional`supplierShipping

`Optional`paymentMethods

`Optional`_fuzz

`Optional`matchPercentage