---
title: Context Events Parameters
slug: sdks/context-events-parameters
docTags: 
createdAt: 2026-01-02T07:13:12.012Z
---

## CustomVariable Fields

| <font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>**** |
| ---------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------ |
| variable                                       | String                                    | Yes                                           | Name of the custom variable.                     |
| value                                          | String                                    | Yes                                           | Value associated with the custom variable.       |

***

## IpAddress Fields

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>**** |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------ |
| ipAddress                                          | String                                    | Yes                                           | IP address value to be set on the context.       |

***

## Meta Data Parameters

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>****                |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- |
| language                                           | Language                                  | Yes                                           | Language metadata representing the language context (e.g., EN). |

***

## Page Details Parameters

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>****      |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ----------------------------------------------------- |
| pageType                                           | String                                    | Yes                                           | Type of the page viewed (e.g., homepage, PDP).        |
| url                                                | String                                    | Conditional                                   | Complete URL. Required if path is not provided.       |
| path                                               | String                                    | Conditional                                   | Path portion of URL. Required if url is not provided. |
| categories                                         | String\[]                                 | Optional                                      | Categories used for filtering evaluated actions.      |
| breadcrumbs                                        | String\[]                                 | Optional                                      | Breadcrumbs used for filtering evaluated actions.     |

***

## PageEvent Parameters

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>**** |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------ |
| pageEventsData                                     | String\[]                                 | Yes                                           | List of page event identifiers / values.         |

***

## Product Detail  Parameters

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>**** |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------ |
| productId                                          | String                                    | Yes                                           | Unique identifier for the product.               |
| sku                                                | String                                    | Optional                                      | SKU associated with the product.                 |

***

## Product Thumbnail Parameters

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>****             |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------------------ |
| products                                           | String\[]                                 | Yes                                           | List of product identifiers associated with thumbnail views. |

***

## Purachase Parameters

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>**** |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------ |
| purchaseId                                         | String                                    | Yes                                           | Unique identifier for the purchase transaction.  |
| purchaseLineData                                   | PurchaseLine\[]                           | Yes                                           | List of purchased items.                         |

## PurchaseLine Fields

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>**** |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------ |
| sku                                                | String                                    | Yes                                           | Unique identifier for the purchased product.     |
| pid                                                | String                                    | Yes                                           | Parent identifier for a related group of SKUs.   |
| quantity                                           | Integer                                   | Yes                                           | Number of units purchased.                       |
| currency                                           | String                                    | Yes                                           | Currency code of the purchase value.             |
| value                                              | String                                    | Yes                                           | Total value in the specified currency.           |

***

## CartLine Fields

| ****<font color="#2166ae">**Parameter**</font>**** | <font color="#2166ae">**Type**</font>**** | <font color="#2166ae">**Required**</font>**** | <font color="#2166ae">**Description**</font>**** |
| -------------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------------ |
| sku                                                | String                                    | Yes                                           | Unique identifier for the product.               |
| pid                                                | String                                    | Yes                                           | Parent identifier for a related group of SKUs.   |
| quantity                                           | Integer                                   | Yes                                           | Number of units added to the cart.               |
| currency                                           | String                                    | Yes                                           | Currency code of the purchase value.             |
| value                                              | String                                    | Yes                                           | Total value in the specified currency.           |

***