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.

Product ID

Type: string

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


Example:

"b7c901..."

SKU

Type: string

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


Example:

"ac6674..."

UPC

Type: string

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


Example:

"ce6378..."

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"

Product Name

Type: string

Example:

"Organic Sawyer Rib Crew Knit"

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."

Brand Name

Type: string

Example:

"Sawyer"

Size

Type: string

Example:

"L"

Color

Type: string

Example:

"Navy"

Price

Type: number

Example:

89.0

Categories

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

Type: array of string
No Additional Items

Each item of this array must be:

Product 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"

Image URLs

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:

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"
]

Product Availability

Type: object

The availability status of the product.

Available

Type: boolean

A product is available when it is suitable for sale in any channel, or can be promoted in marketing communications.


Example:

false

Channels Availability

Type: array

A list of channel specific availability statuses.

No Additional Items

Each item of this array must be:

Type: object

Type: enum (of string)

The channel which this availability record relates to.

Must be one of:

  • "physical"
  • "ecommerce"

Example:

"ecommerce"

Available

Type: boolean

Is the product available for purchase via this specific channel?


Example:

false

Published At

Type: stringFormat: date-time

An ISO8601 datetime string for when the product was published, or is going to be published to this channel.


Example:

"2024-01-01T00:00:00Z"

Unpublished At

Type: stringFormat: date-time

An ISO8601 datetime string for when the product was unpublished, or is going to be unpublished to this channel.


Example:

"2025-01-01T00:00:00Z"

Product Inventory

Type: object

The inventory status of the product.

Id

Type: string

Identifier of product in the inventory system.


Example:

"lzx0h1..."

Source

Type: string

Source of inventory product data, e.g. Shopify, Magento..


Example:

"Shopify"

Quantity

Type: integer

Total number of remaining product units.


Example:

99

Cost

Type: number

Total expenditure incurred to produce, store and sell one unit of product.

Value must be greater or equal to 0


Example:

50.0

Backorder Allowed

Type: boolean

Can the product item be ordered when it's out of stock?


Example:

false

Tracked

Type: boolean

Is the product quantity being tracked?


Example:

false

Updated At

Type: stringFormat: date-time

An ISO8601 datetime string for when the product inventory status was last updated.


Example:

"2024-01-01T00:00:00Z"