KnowledgeProduct

Object

id

Unique identifier representing a single product. Once an id is assigned to a product and imported, the id may not be used for a different product.

internalId

Unique identifier representing a single product, unique globally.

itemGroupId

The item group id is an identifier used to group together similar products. It can consist of alphanumeric characters and is assigned to a parent-level product. This means that a product can be expressed as a collection of child products, and all of them can share the same item group id. It's important to note that several products can have the same value for item group id since it can represent a collection of products (variants).

title

The title is the product’s name, typically displayed on the product’s page. It will be used to display the product's name during conversations or research. The title should include variant information like color, size, or others. Can be used to identify product with semantic research.

description

The product description provides additional information beyond its name to help answer visitor's questions.

link

URL of the product page on the brand's website. The information on this page should match the information provided in the catalog. This link can be used to identify a product during conversation if no id is provided in custom data.

availability

Information about accurate product availability that matches the product page and checkout.

availabilityDate

The date a preordered product becomes available for delivery.

price

The product's original price. It should match the standard price displayed on your product page. It should include the currency in which the price is expressed.

salePrice

The product's sale price. It should match the new sales price from your product page and at checkout. It should include the currency in which the sale price is expressed.

productTypes

Product category defined for the product. It should include the full category. Example: Home > Men > Clothes > Shirts.

gender

The gender your product is intended for.

brand

The brand name of the product, the one known by consumers to ensure the best user experience.

color

The product’s color. May include multiple colors, list the primary color first. Note: You can use item_group_id to regroup multiple color variants of the same product.

size

The product’s size. Note: You can use item_group_id to regroup multiple-size variants of the same product.

productDetails

Generic extra information on the product. Use this field to add details that won't fit on root fields.

material

The product's fabric or material. It can be indicated by a primary material followed by secondary materials (using a separator like a coma, slash, or others). Note: You can use item_group_id to regroup multiple material variants of the same product.

condition

The condition of the product for sale. Note: You can use item_group_id to regroup multiple condition variants of the same product.

imageLink

Link to the main image of your product (URL).

additionalImageLink

Link to a secondary image of your product (URL).

compatibleWith

List of products compatible with this product.

crossSellProducts

List of products which can be cross sell with this product.

weight

The weight of the product.

returnPolicyLink

Link to the return policy.

returnWindow

Return window in days.

sellerName

Name of the seller.

sellerPrivacyPolicyLink

Link to the seller's privacy policy.

sellerTermsOfServiceLink

Link to the seller's terms of service.

inventoryQuantity

Current inventory quantity.

productPopularity

Product popularity score.

salesVolume

Sales volume.

extraImagesLinks

Links to extra product images.

positionInGroup

The order of the product in the list of product group.