Product

Prev Next

Overview

This page lists every record-content field captured for product-related events — basket interactions, wishlist actions, and recommendation events. All field names below match the technical record schema (e.g. basket.status, basket.items[X].quantity).

For the sender-side perspective — how product tracking data is transmitted via Tag Integration / Smart Pixel — see Product in the Smart Pixel documentation.


Field Definitions

Name / Object

Key on Record

Description

Format

Comment

Basket Status

basket.status

Current status of the shopping basket. See Basket Status Values below for the full list of supported values.

String

Note that the basket status of the raw data stream contains the additional state list (this is not included in the raw data export).

Basket Item Quantity

basket.items[X].quantity

Amount of this item that exists on the basket.

Integer

Custom stream contain up to 25 items only.

Root Stream: available as a nested array structure

Custom Stream: X starts at 1

Basket Item Price

basket.items[X].price

Price of each unit of this item.

Double

-

Basket Item Product

basket.items[X].product

Product information on this item (see product information below).

Product

The order of the articles in the list indicates the basket position of this article.

Basket Item Rank

basket.items[X].rank

Contains the item rank (position) in the shopping cart/basket.

Integer

 

Basket Item Product List Position

basket.items[X].listPosition

Contains the product list position of the item in the basket.

Integer

 

Product (Text) Parameters

basket.parameters.textValues

Parameters for the basket if available.

Map<String, TextParameter>

Note that product parameters are provided in a single file in the RDE. In Data Streams those are separated as Product Parameters with single values relate to the basket and not the Product.

Product (Numeric) Parameters

basket.parameters.numericValues

Parameters for the basket if available.

Map<String, NumericParameter>

Note that product parameters are provided in a single file in the RDE. In Data Streams those are separated as Product Parameters with single values relate to the basket and not the Product.

Product Name

basket.items[X].product.name

The name of a product.

String

Custom stream contain up to 25 items only.

Root Stream: available as a nested array structure

Custom Stream: X starts at 1

Product URL

basket.items[X].product.url

The URL to the product.

String

-

Product (Text) Categories

basket.items[X].product.categories.textValues

Categories for the product.

Map<String, TextCategory>

Available for known products only (at latest beginning from the next day).

Product (Numeric) Categories

basket.items[X].product.categories.numericValues

Categories for the product.

Map<String, NumericCategory>

-

Product (Text) Parameters

basket.items[X].product.parameters.textValues

Parameters for the product.

Map<String, TextParameter>

-

Product (Numeric) Parameters

basket.items[X].product.parameters.numericValues

Parameters for the product.

Map<String, NumericParameter>

-


Stream and Export Mapping

The same fields, mapped to their availability in the Root Stream, Custom Streams, the current Raw Data Export, and the Classic Raw Data Export. Use the Name / Object column to cross-reference rows with Field Definitions above.

Name / Object

Available in Root Stream

Field in Custom Stream

Available in Custom Stream

File in the Raw Data Export

Field in the Raw Data Export

Available in Classic Raw Data Export

Basket Status

(tick)

basket_status

(tick)

getFullBasket

state

(tick)

Basket Item Quantity

(tick)

basket_items_X_quantity

(tick)

getFullBasket

quantity

(tick)

Basket Item Price

(tick)

basket_items_X_price

(tick)

getFullBasket

price

(tick)

Basket Item Product

(tick)

basket_items_X_product

(tick)

getFullBasket

bas_pos

(tick)

Basket Item Rank

(tick)

basket_items_X_rank

(tick)

 

 

(tick)

Basket Item Product List Position

(tick)

basket_items_X_listPosition

(tick)

 

 

(tick)

Product (Text) Parameters

(tick)

basket_parameters_textValues

(tick)

getFullCustParaProduct_X

cust_para_string_y, cust_para_generic_y

(tick)

Product (Numeric) Parameters

(tick)

basket_parameters_numericValues

(tick)

getFullCustParaProduct_X

cust_para_number_y

(tick)

Product Name

(tick)

basket_items_X_product_name

(tick)

getFullBasket

product

(tick)

Product URL

(tick)

basket_items_X_product_url

(tick)

getFullBasket

product

(minus)

Product (Text) Categories

(tick)

basket_items_X_product_categories_textValues

(tick)

n/a

n/a

(minus)

Product (Numeric) Categories

(minus)

basket_items_X_product_categories_numericValues

(minus)

n/a

n/a

(minus)

Product (Text) Parameters

(tick)

basket_items_X_product_parameters_textValues

(tick)

getFullCustParaProduct_X

cust_para_string_y, cust_para_generic_y

(tick)

Product (Numeric) Parameters

(tick)

basket_items_X_product_parameters_numericValues

(tick)

getFullCustParaProduct_X

cust_para_number_y

(tick)


Basket Status Values

The basket.status field can take one of the following values. The same status is also exposed as a numeric STATE code in the Raw Data Export.

API Value

Description

View

Product viewed on a product detail page.

List

Product viewed in a product list (category, search-result, or similar list view). The position within the list is transported separately in the LIST_POS field.

Add

Product added to the shopping basket.

Del

Product removed from the shopping basket.

Checkout

Product is in the checkout step (between basket and order confirmation).

Conf

Order confirmation — the product was purchased.

Add-Wl

Product added to the wishlist.

Del-Wl

Product removed from the wishlist.

Display-Reco

A product inside a recommendation slot was rendered. Only generated when the Recommendation Tracking extension is implemented.

Click-Reco

A product inside a recommendation slot was clicked. Only generated when the Recommendation Tracking extension is implemented.

Undefined

Internal fallback value used when no recognized status was supplied with the request.

Note

The values above are the API representation used in record contents. When sending tracking data via Tag Integration / Smart Pixel, the same statuses are transmitted as lowercase strings (e.g. add, del-wl, display-reco). In the Raw Data Export getFullBasket table, the same statuses are represented as a numeric STATE code covering values 07 (see Contents of Raw Data Tables) — Display-Reco, Click-Reco, and Undefined are not represented in the STATE mapping.


  • Product (Smart Pixel) — how to send product tracking data via the Smart Pixel.

  • Contents of Raw Data Tables — where product data appears in the Raw Data Export (see getFullBasket and related tables).