Interface Product

Represents a distinct Product with basic identifiers, price, and display information, and further optional detailed information.

interface Product {
    category?: string;
    color?: string;
    customProperties?: [string: string | number];
    image?: string;
    price: number;
    productId: string;
    regularPrice: number;
    reviews?: ProductReviews;
    size?: string;
    sku: string;
    stock?: number;
    subCategory?: string;
    title: string;
    url: string;
}

Hierarchy (view full)

Properties

category? color? customProperties? image? price productId regularPrice reviews? size? sku stock? subCategory? title url

Properties

Optionalcategory

category?: string

The broad category containing this item.

Optionalcolor

color?: string

The color of the SKU item. (optional)

OptionalcustomProperties

customProperties?: [string: string | number]

Named (keys) custom properties (values with a valid string representation) to be stored and reported to Granify with the product. This is useful for adding additional properties that may be domain-specific to your site and do not fit into any of the existing properties available on this class.

Optionalimage

image?: string

The address of the product image.

price

price: number

The current unit price of the product (after discount or sale pricing).

productId

productId: string

The parent ID of the product.

regularPrice

regularPrice: number

The regular price of the product before sales or discounts.

Optionalreviews

reviews?: ProductReviews

The review and rating information for the product.

Optionalsize

size?: string

The size of the SKU item. (optional)

sku

sku: string

The specific SKU of the product/variant.

Optionalstock

stock?: number

The stock information for the product.

OptionalsubCategory

subCategory?: string

Further categorical identification of item. (optional)

title

title: string

The name or title of the product.

url

url: string

Deep link to app location.

Settings

Member Visibility

On This Page

Properties