eCommerceProductProperties

Hierarchy

  • eCommerceProductProperties

Index

Properties

Optional image_url

image_url: undefined | string

The URL of the product image. Cannot exceed 255 characters in length.

Optional metadata

metadata: undefined | { sku?: undefined | string }

Additional metadata about the product. Keys are limited to 255 characters in length, cannot begin with a $ character, and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.

price

price: number

The variant unit price of the product at the time of viewing (ex: 12.99).

product_id

product_id: string

A unique identifier for the product, such as product ID or SKU. Cannot exceed 255 characters in length.

product_name

product_name: string

The name of the product. Cannot exceed 255 characters in length.

Optional product_url

product_url: undefined | string

The URL of the product page. Cannot exceed 255 characters in length.

quantity

quantity: number

The number of units of the product.

variant_id

variant_id: string

A unique identifier for the product variant (ex: shirt_medium_blue). Cannot exceed 255 characters in length.