ProductRecord

Type: object

A product object record_type=product.
Product records are used to represent the current and historical products offered by your brand, including your product taxonomy.
The field referenced in product_reference_type should be unique and used in purchase and return events.

root product_id
Type: string

Unique product_id. Required if product_id is used as the product identifier in product_reference_type.
Example:

"b7c901..."

root sku
Type: string

Unique SKU. Required if sku is used as a product identifier in product_reference_type.
Example:

"ac6674..."

root upc
Type: string

Unique UPC. Required if upc is used as a product identifier in product_reference_type.
Example:

"ce6378..."

root product_reference_type
Type: enum (of string) Default: "product_id"

Which field is used to identify the product entity. A value must be provided in the specified field.

Must be one of:

  • "sku"
  • "upc"
  • "product_id"

root name
Type: string

Example:

"Organic Sawyer Rib Crew Knit"

root description
Type: string

Example:

"Whether your look is clean and casual or sharp and sophisticated, Staple Superior has what you need to achieve that effortlessly cool style."

root brand
Type: string

Example:

"Sawyer"

root size
Type: string

Example:

"L"

root color
Type: string

Example:

"Navy"

root price
Type: number

Example:

89.0

root options
Type: object

Key value pairs of options that define the product, such as departments, categories, styles, etc.
Example:

{
    "department": [
        "menswear"
    ],
    "category": [
        "outerwear"
    ],
    "subcategory": [
        "knits",
        "wool"
    ]
}

Each additional property must conform to the following schema

root options additionalProperties
Type: array of string
No Additional Items

Each item of this array must be:

root options additionalProperties additionalProperties items
Type: string

root url
Type: string

A URL to the product listed on the public internet - i.e., an ecommerce link.
Example:

"https://fake.com/menswear/sawyer-rib-crew-knit"

root images
Type: array of string

An array of Product Image URLs listed on the public internet.

 No Additional Items

Each item of this array must be:

root images images items
Type: stringFormat: uri

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

[
    "https://fake.com/images/menswear/sawyer-rib-crew-knit.jpg"
]