The product object

The product object represents information about one product or product variation (SKU). Refer to individual events for details about how product price and quantity are used based on the event type.

The following table lists attributes in the product object:

Name

Type

Description

sku

string

Required.

Product variation SKU.

quantity

integer | float

Required.

Quantity of product selected by user.

psku (deprecated)

string

Required if it is a parent product.

Parent product SKU.

product_group

string

Required if it is a parent product.

Product group or style ID that is used to represent a group of SKUs.

price

float

Required.

Price of product (if all variations have same price).

price_original

float

Optional.

Used when the price paid is not the same as the original price.

attributes

object

Optional.

Product attributes such as color, size, and so on.

fitment

Fitment object

Required if set up with fitment.

User fitment object that either has an array of IDs (customers having fitment feed) or array of fitment items (customers that do not have fitment feed).

store

Store object

Optional.

Store object that represents the store that this product is being bought from or being picked up from and so on (see Shipping Methods).

Store specified at the product level overrides store that might be specified in checkout object or context object.

shipping_method

string

Required only when the order is a BOPIS order or something specific other than the regular order.

Used to identify the type of order. For valid values, refer to Shipping Methods.

Note

The required keys for reporting parent products (psku) and variation products (sku) are different. Product variation must be reported in events where an exact item must be detected, like the add to cart or order event. Parent products can be reported in events like product detail page view or add to favorites.

Do you have some feedback for us?

If you have suggestions for improving this article,