Product

A full reference to a product type for different Liquid Commerce APIs.

ProductType

Attribute	Description
id: string	identifier of the product
name: string	product name
brand: string	product brand
catPath: string	the category path normalized through our liquid taxonomy
category: string	normalized category
classification: string	product classification, ex: Canadian Whiskey
type: string	product type, ex: Whiskey
salsifyGrouping: string [optional]	optional Salsify grouping identifier
subType: string	product type, ex: Flavored Whiskey
region: string	product region, ex: Toronto
country: string	country of origin, ex: Canada
material: string	material used in production, ex: Grains
color: string	product color, ex: Tawny/Brown
flavor: string	product flavor profile, ex: Apple
variety: string	product variety, ex: Blend-Grains
appellation: string	similar to country or region, ex: Canada
abv: string	product alcohol by volume, ex: 40 (40%)
proof: string	alcohol proof
age: string	product age, ex: 14
vintage: string	year of production/harvest, ex: 2020
description: string	a products detailed description, max length: 250 characters
htmlDescription: string	a products detailed description with html tags, max length: 250 characters
tastingNotes: string	product tasting notes breakdown, max length: 250 characters
images: string[] | Array<Record<string, any>>	product images
sizes: Array<Size>	all of the available sizes for the product
attributes: Partial<Attributes> [optional]	optional product attributes
priceInfo: ProductPriceInfo | null	represents product price information

Size

Attribute	Description
id: string	identifier of the product size
size: string	product size, ex: 750ML
salsifyPid: string [optional]	optional Salsify product identifier
upc: string	each size's UPC
container: string	each size's container, ex: Bottle
containerType: string	each size's container type, ex: Glass
pack: boolean	whether the size is a pack, ex: true
packDesc: string	if the size is a pack and a description is available, ex: 8pk
volume: string	volume measurement
uom: string	unit of measure
image: string	product size specific image (if available, otherwise defaults to the mainImage)
attributes: ProductSizeAttributes	each size's attributes
modalities: Modalities	available fulfillment modalities
variants: Array<Variant>	each retailer's available variant for the size

ProductSizeAttributes

Attribute	Description
engraving: ProductSizeEngraving	Each size's engraving attributes
presale: ProductPresale	Representing a product presale

ProductPresale

Attribute	Description
canPurchaseOn: Date | null	The date when the product can be added to the cart
estimatedShipBy: Date | null	The date when the product is expected to ship
isActive: boolean	Indicates whether the presale is currently active
language: string	The language associated with the product presale

Attributes

Attribute	Description
brandOrigin: string	brand's origin information
originStatement: string	detailed origin description
ownershipType: Array<string>	types of ownership
tags: Array<string>	product tags
images: AttributesImage	product image configurations
awards: Array<AttributesAward>	product awards
recipes: Array<AttributesRecipe>	related recipes
video: Array<AttributesVideo>	product videos
tastingNotes: Array<AttributesTastingNote>	detailed tasting notes
personalizations: Array<AttributesPersonalization>	personalization options

ProductSizeEngraving

Attribute	Description
status: boolean	whether engraving is activated if true
validated: boolean	engraving validation
maxLines: number	the maximum number of line allowed, ex: the maximum allowed in this example id 2 (maxLines: 2) [ "Happy Birthday", "100 more!" ]
maxCharsPerLine: number	the maximum number of characters allowed per line, ex: 14 it includes whitespaces
fee: number	engraving price, ex: 5000 ($50.00)
location: string	engraving location on the product, ex: Above the label

Variants

Attribute	Description
partNumber: string	variant identifier (used to add to cart), ex: 00082002599562_6565f4e5ddec8ce19105d26
retailerId: string	retailer identifier (used to map the Array<Retailer>), ex: 6565f4e8700628ce19106b14
price: number	variant price, ex: 1499
isEngravable: boolean	whether this retailer's variant allows engraving, ex: true
modalities: string[]	the methods of fulfillment available for the variant, ex: [ 'shipping', 'onDemand' ]
salePrice: number	variant sale price, ex: 1199 ($11.99)
stock: number	variant stock quantity, ex: 82
fulfillmentTypes: VariantFulfillmentTypes	variants retailer offered fulfillment based on type
fulfillments: string[]	fulfillment identifier (used to map the Array<Fulfillment>), ex: ["6570c3ec700628ce1910c265", "6565f4e8700628ce19106b14"]

VariantFulfillmentTypes

Attribute	Description
shipping: string	retailer's shipping fulfillment Id, * ONLY SHIPPING RETAILERS CAN HANDLE ENGRAVING ORDER *
onDemand: string	retailer's onDemand fulfillment Id

AttributesImage

Attribute	Description
backOfBottle: string	url for back of bottle image
frontOfBottle: string	url for front of bottle image
lifestyle: Array<string>	array of lifestyle image urls

AttributesAward

Attribute	Description
image: string	award image url
statement: string	award statement text
title: string	award title

AttributesRecipe

Attribute	Description
image: string	recipe image url
ingredients: Array<AttributesRecipeIngredient>	array of recipe ingredients
steps: Array<string>	array of recipe steps
title: string	recipe title

AttributesRecipeIngredient

Attribute	Description
name: string	ingredient name
amount: string	amount needed for recipe

AttributesVideo

Attribute	Description
link: string	video url
image: string	video thumbnail image url
title: string	video title

AttributesTastingNote

Attribute	Description
statement: string	tasting note description
image: string	associated image url
title: string	tasting note title

AttributesPersonalization

Attribute	Description
type: string	type of personalization
engravingMaxLines: number	maximum number of lines for engraving
engravingMaxCharsPerLine: number	maximum characters per line for engraving
location: Array<string>	available locations for personalization
width: number	width for personalization area
height: number	height for personalization area
image: string	personalization reference image url
fee: number	cost of personalization
availableFrom: Date	start date for personalization availability
availableTo: Date	end date for personalization availability

ProductPriceInfo

Attribute	Description
currency: string	the currency code for the prices
minimum: number	the lowest price available for this product across all retailers
average: number	the average price of the product across all retailers
maximum: number	the highest price available for this product across all retailers

Sample product

Product Object

  {
            "id": "ful_def456uvw123",
            "salsifyGrouping": "GRP-78392",
            "name": "Maestro Dobel® Diamante Tequila Cristalino",
            "brand": "Maestro Dobel",
            "catPath": "Spirits > Tequila > Cristalino",
            "category": "",
            "classification": "",
            "type": "",
            "subType": "",
            "region": "Jalisco",
            "country": "Mexico",
            "material": "Agave",
            "color": "White",
            "flavor": "",
            "variety": "100% Blue Agave",
            "appellation": "",
            "abv": "40",
            "proof": "80",
            "age": "",
            "vintage": "",
            "description": "Maestro Dobel® Diamante® is the original Cristalino. Blended extra Añejo, Añejo and reposado tequilas are aged in Balkan new white wood barrels, then filtered again to retain an elegant flavor. The Cristalino tequila has a mild oak aroma with a touch of vanilla. It has a citrus and prickly pear flavor with a smooth, crisp, clean finish. Pour one shot of straight Diamante Tequila to sip, into an old-fashioned glass with ice and a lemon slice, or as a Margarita. (80 proof)",
            "htmlDescription": "<p>Maestro Dobel® Diamante® is the original Cristalino. Blended extra Añejo, Añejo and reposado tequilas are aged in Balkan new white wood barrels, then filtered again to retain an elegant flavor. The Cristalino tequila has a mild oak aroma with a touch of vanilla. It has a citrus and prickly pear flavor with a smooth, crisp, clean finish. Pour one shot of straight Diamante Tequila to sip, into an old-fashioned glass with ice and a lemon slice, or as a Margarita. (80 proof)</p>",
            "tastingNotes": "World's first multi-aged clear tequila.",
            "images": [
                "https://example.com/products/dobel-diamante-1.jpg",
                "https://example.com/products/dobel-diamante-2.jpg"
            ],
            "sizes": [
                {
                    "id": "sz_xy789zw456",
                    "upc": "00811538012034",
                    "size": "750 ML",
                    "volume": "750",
                    "uom": "MILLILITRE",
                    "container": "Bottle",
                    "containerType": "Bottle",
                    "pack": false,
                    "packDesc": "",
                    "image": "https://example.com/products/dobel-diamante-bottle.jpg",
                    "attributes": {
                        "engraving": {
                            "status": true,
                            "maxLines": 3,
                            "maxCharsPerLine": 16,
                            "fee": 5000,
                            "location": "Back of the Bottle"
                        }
                    }
                }
            ]
        }