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

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

url?: string

URL to the variant's detail page

Example

"/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`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

Interface Variant

Example

Hierarchy (View Summary)

Index

Properties

Properties

Optionaltitle

Example

Optionaldescription

Example

Optionaluom

Example

Optionalprice

Example

OptionalcurrencyCode

Example

OptionalcurrencySymbol

Example

Optionalquantity

Example

OptionalbaseQuantity

Example

OptionalbaseUom

Example

OptionalusdPrice

Example

OptionallocalPrice

Optionalsku

Example

Optionalurl

Example

Optionalid

Example

Optionaluuid

Example

Optionalgrade

Example

Optionalconc

Example

Optionalstatus

Example

OptionalstatusTxt

Example

OptionalshippingInformation

Example

Optionalavailability

Example

Optionalattributes

Example

Optionalmoles

Example

Settings

On This Page

`Optional`title

`Optional`description

`Optional`uom

`Optional`price

`Optional`currencyCode

`Optional`currencySymbol

`Optional`quantity

`Optional`baseQuantity

`Optional`baseUom

`Optional`usdPrice

`Optional`localPrice

`Optional`sku

`Optional`url

`Optional`id

`Optional`uuid

`Optional`grade

`Optional`conc

`Optional`status

`Optional`statusTxt

`Optional`shippingInformation

`Optional`availability

`Optional`attributes

`Optional`moles