---
title: Product List Filtered
slug: tracking-plan/product-list-filtered
docTags: 
createdAt: 2026-01-21T23:00:52.284Z
---

User filtered a product list or category.

**Suggested source:** website front-end

**Properties**

| Name                 | Type       | Description                                                            | Required |
| -------------------- | ---------- | ---------------------------------------------------------------------- | -------- |
| **category**         | `string`   | Product category being viewed<br />                                    |          |
| **filters**          | `object[]` | Product filters that the customer is using<br />                       |          |
| **list\_id**         | `string`   | The ID of the list in which the item was presented to the user<br />   |          |
| **item\_list\_id**   | `string`   | The ID of the list in which the item was presented to the user<br />   |          |
| **item\_list\_name** | `string`   | The name of the list in which the item was presented to the user<br /> |          |
| **products**         | `object[]` | Products in the order<br />                                            |          |
| **sorts**            | `object[]` | Product sorting that the customer is using<br />                       |          |

**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"
        }
    ]
}
```

&#x20;



## 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<br /> | no       |
| **value** | `string` | ID of the selection that the customer chose<br />      | no       |

**Example**

```json
[
    {
        "type": "color",
        "value": "Purple"
    }
]
```

&#x20;



## 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")<br /> | no       |
| **brand**          | `string`   | Brand associated with the product<br />                                                                                     | no       |
| **bundle**         | `boolean`  | Product belongs to a bundle<br />                                                                                           | no       |
| **category**       | `string`   | Product category<br />                                                                                                      | no       |
| **coupon**         | `string`   | Coupon code associated with a product (for example, "MAY\_DEALS\_3")<br />                                                  | no       |
| **description**    | `string`   | Short description of the product<br />                                                                                      | no       |
| **image\_url**     | `string`   | Image URL of the product<br />                                                                                              | no       |
| **name**           | `string`   | Name of the product<br />                                                                                                   | yes      |
| **option\_values** | `string[]` | Option values of the product variant<br />                                                                                  | no       |
| **position**       | `integer`  | Position in the product list (for example, 3)<br />                                                                         | no       |
| **price**          | `number`   | Price ($) of the product<br />                                                                                              | no       |
| **product\_id**    | `string`   | Database ID of the product<br />                                                                                            | yes      |
| **quantity**       | `integer`  | Quantity of the product<br />                                                                                               | no       |
| **sku**            | `string`   | SKU of the product variant<br />                                                                                            | no       |
| **slug**           | `string`   | Slug of the product, often used in URLs (for example, "product-red")<br />                                                  | no       |
| **url**            | `string`   | URL of the product page<br />                                                                                               | no       |
| **variant**        | `string`   | Name of the product variant<br />                                                                                           | no       |
| **currency**       | `string`   | Currency code of the transaction (for example, "USD")<br />Pattern: `^[A-Z]{3}$`<br />                                      | 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"
    }
]
```

&#x20;



### products\[].option\_values\[] array

Option values of the product variant

Option value (for example, "red")

**Item Type:** `string`
**Example**

```json
[
    "Purple"
]
```

&#x20;



## 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<br />                             | no       |
| **value** | `string` | ID of the selection type the the customer is using (ascending, descending)<br /> | no       |

**Example**

```json
[
    {
        "type": "price",
        "value": "ascending"
    }
]
```