Product Tracking
Fanplayr can track the products that are added to the shopping cart and placed in orders.
Data Variables
The following variables must be provided in the data
object. Example:
[
{
id: 'WRS001',
sku: 'WRS001',
qty: 1,
name: 'Red Shoes',
price: 65.00,
catId: 'womens-shoes',
catName: 'Womens Shoes',
url: 'https://example.com/women/shoes/001.html',
image: 'https://example.com/images/products/WRS001.jpg'
}
]
id String
Required.
A unique product identifier. Used to differentiate products in the cart or order.
Caveats. Some shopping carts use the same identifier or SKU for different variants of a product. If multiple products appear with the same
id
, Fanplayr will consider them identical and merge their quantities together. This can lead to
Fanplayr will not be able to track these as separate products as they share the same id
:
[
{
id: 'aygwi',
sku: 'aygwi',
name: 'Crew Tee (Black)',
price: 10.00,
qty: 1
},
{
id: 'aygwi',
sku: 'aygwi',
name: 'Crew Tee (White)',
price: 15.00,
qty: 1
}
]
Instead, Fanplayr will see these as a single product because it merges quantities of products with the same id
. This can lead to incorrect calculation of product prices and quantities.
[
{
id: 'aygwi',
sku: 'aygwi',
name: 'Crew Tee (Black)',
price: 10.00,
qty: 2
}
]
This can be avoided by providing unique identifiers for products:
[
{
id: 'aygwi-black',
sku: 'aygwi',
name: 'Crew Tee (Black)',
price: 10.00,
qty: 1
},
{
id: 'aygwi-white',
sku: 'aygwi',
name: 'Crew Tee (White)',
price: 15.00,
qty: 1
}
]
qty Integer
Required.
The quantity of the line item in the cart or order.
sku String
The product SKU. This may be the same as id
, but is also made available as a segmentation option.
name String
The product name. E.g. "Red Shoes".
price Float
The unit price of the product visible to the user.
For carts that implement a base price and a discounted/sale price, use the discounted price if it is the price shown to users when they add the product to the cart.
catId String
The ID of the category that this product belongs to. Multiple categories can be specified by separating them by commas. E.g. "32,762".
catName String
The name of the category that this product belongs to. Multiple categories can be specified by separating them by commas. E.g. "Hardwood floors,Benches".
url String
The URL of the page that displays full details of the product.
image String
The URL of the product image.