Events

Product List Filtered

User filtered a product list or category.
Suggested source: website front-end
Properties
Name
Type
Description
Required
category
string
Product category being viewed

﻿
filters
object[]
Product filters that the customer is using

﻿
list_id
string
The ID of the list in which the item was presented to the user

﻿
item_list_id
string
The ID of the list in which the item was presented to the user

﻿
item_list_name
string
The name of the list in which the item was presented to the user

﻿
products
object[]
Products in the order

﻿
sorts
object[]
Product sorting that the customer is using

﻿
Example
JSON
{
    "category": "flowers",
    "filters": [
        {
            "type": "color",
            "value": "Purple"
        }
    ],
    "list_id": "123",
    "item_list_id": "123",
    "item_list_name": "Flower List",
    "products": [
        {
            "affiliation": "My Plant Store",
            "brand": "Green Thumb Nurseries",
            "bundle": false,
            "category": "Outdoor Plants",
            "currency": "USD",
            "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
            "image_url": "https://example.com/images/petunia.jpg",
            "name": "Petunia",
            "option_values": [
                "Purple",
                "Red",
                "White"
            ],
            "position": 3,
            "price": 7.99,
            "product_id": "123456789",
            "sku": "PETUNIA-001",
            "slug": "petunia",
            "url": "https://example.com/plants/petunia",
            "variant": "Purple"
        }
    ],
    "sorts": [
        {
            "type": "price",
            "value": "ascending"
        }
    ]
}
{
    "category": "flowers",
    "filters": [
        {
            "type": "color",
            "value": "Purple"
        }
    ],
    "list_id": "123",
    "item_list_id": "123",
    "item_list_name": "Flower List",
    "products": [
        {
            "affiliation": "My Plant Store",
            "brand": "Green Thumb Nurseries",
            "bundle": false,
            "category": "Outdoor Plants",
            "currency": "USD",
            "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
            "image_url": "https://example.com/images/petunia.jpg",
            "name": "Petunia",
            "option_values": [
                "Purple",
                "Red",
                "White"
            ],
            "position": 3,
            "price": 7.99,
            "product_id": "123456789",
            "sku": "PETUNIA-001",
            "slug": "petunia",
            "url": "https://example.com/plants/petunia",
            "variant": "Purple"
        }
    ],
    "sorts": [
        {
            "type": "price",
            "value": "ascending"
        }
    ]
}
﻿
  
filters[] array
Product filters that the customer is using
The filter
Item Properties
Name
Type
Description
Required
type
string
ID of the filter type that the customer is using

no
value
string
ID of the selection that the customer chose

no
Example
JSON
[
    {
        "type": "color",
        "value": "Purple"
    }
]
[
    {
        "type": "color",
        "value": "Purple"
    }
]
﻿
  
products[] array
Products in the order
The product
Item Properties
Name
Type
Description
Required
affiliation
string
Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")

no
brand
string
Brand associated with the product

no
bundle
boolean
Product belongs to a bundle

no
category
string
Product category

no
coupon
string
Coupon code associated with a product (for example, "MAY_DEALS_3")

no
description
string
Short description of the product

no
image_url
string
Image URL of the product

no
name
string
Name of the product

yes
option_values
string[]
Option values of the product variant

no
position
integer
Position in the product list (for example, 3)

no
price
number
Price ($) of the product

no
product_id
string
Database ID of the product

yes
quantity
integer
Quantity of the product

no
sku
string
SKU of the product variant

no
slug
string
Slug of the product, often used in URLs (for example, "product-red")

no
url
string
URL of the product page

no
variant
string
Name of the product variant

no
currency
string
Currency code of the transaction (for example, "USD")
Pattern: ^[A-Z]{3}$

no
Example
JSON
[
    {
        "affiliation": "My Plant Store",
        "brand": "Green Thumb Nurseries",
        "bundle": false,
        "category": "Outdoor Plants",
        "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
        "image_url": "https://example.com/images/petunia.jpg",
        "name": "Petunia",
        "option_values": [
            "Purple",
            "Red",
            "White"
        ],
        "position": 3,
        "price": 7.99,
        "product_id": "123456789",
        "sku": "PETUNIA-001",
        "slug": "petunia",
        "url": "https://example.com/plants/petunia",
        "variant": "Purple",
        "currency": "USD"
    }
]
[
    {
        "affiliation": "My Plant Store",
        "brand": "Green Thumb Nurseries",
        "bundle": false,
        "category": "Outdoor Plants",
        "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
        "image_url": "https://example.com/images/petunia.jpg",
        "name": "Petunia",
        "option_values": [
            "Purple",
            "Red",
            "White"
        ],
        "position": 3,
        "price": 7.99,
        "product_id": "123456789",
        "sku": "PETUNIA-001",
        "slug": "petunia",
        "url": "https://example.com/plants/petunia",
        "variant": "Purple",
        "currency": "USD"
    }
]
﻿
  
products[].option_values[] array
Option values of the product variant
Option value (for example, "red")
Item Type: stringExample
JSON
[
    "Purple"
]
[
    "Purple"
]
﻿
  
sorts[] array
Product sorting that the customer is using
The sort
Item Properties
Name
Type
Description
Required
type
string
ID of the sort type that the customer is using

no
value
string
ID of the selection type the the customer is using (ascending, descending)

no
Example
JSON
[
    {
        "type": "price",
        "value": "ascending"
    }
]
[
    {
        "type": "price",
        "value": "ascending"
    }
]
﻿
﻿

Name	Type	Description
category	string	Product category being viewed
filters	object[]	Product filters that the customer is using
list_id	string	The ID of the list in which the item was presented to the user
item_list_id	string	The ID of the list in which the item was presented to the user
item_list_name	string	The name of the list in which the item was presented to the user
products	object[]	Products in the order
sorts	object[]	Product sorting that the customer is using

Name	Type	Description	Required
type	string	ID of the filter type that the customer is using	no
value	string	ID of the selection that the customer chose	no

Name	Type	Description	Required
affiliation	string	Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")	no
brand	string	Brand associated with the product	no
bundle	boolean	Product belongs to a bundle	no
category	string	Product category	no
coupon	string	Coupon code associated with a product (for example, "MAY_DEALS_3")	no
description	string	Short description of the product	no
image_url	string	Image URL of the product	no
name	string	Name of the product	yes
option_values	string[]	Option values of the product variant	no
position	integer	Position in the product list (for example, 3)	no
price	number	Price ($) of the product	no
product_id	string	Database ID of the product	yes
quantity	integer	Quantity of the product	no
sku	string	SKU of the product variant	no
slug	string	Slug of the product, often used in URLs (for example, "product-red")	no
url	string	URL of the product page	no
variant	string	Name of the product variant	no
currency	string	Currency code of the transaction (for example, "USD") Pattern: ^[A-Z]{3}$	no

Name	Type	Description	Required
type	string	ID of the sort type that the customer is using	no
value	string	ID of the selection type the the customer is using (ascending, descending)	no

Product Details Clicked

Product List Viewed