ProductViewedEventProperties

Hierarchy

Index

Properties

currency

currency: string

Default USD. Currencies should be represented as an ISO 4217 currency code. Supported currency symbols include: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MTL, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMK, ZMW, and ZWL. Any other provided currency symbol will result in a logged warning and no other action taken by the SDK.

Optional image_url

image_url: undefined | string

The URL of the product image that was viewed. Cannot exceed 255 characters in length.

Optional metadata

metadata: undefined | { sku?: undefined | string; type?: string[] }

Additional metadata about the product viewed. Keys are limited to 255 characters in length, cannot begin with a $ character, and can only contain alphanumeric characters and punctuation. Total size of metadata cannot exceed 50KB.

price

price: number

The variant unit price of the product at the time of viewing.

product_id

product_id: string

A unique identifier for the product that was viewed. Cannot exceed 255 characters in length.

product_name

product_name: string

The name of the product that was viewed. Cannot exceed 255 characters in length.

Optional product_url

product_url: undefined | string

The URL to the product page for more details. Cannot exceed 255 characters in length.

source

source: string

The source the event is derived from. Cannot exceed 255 characters in length.

variant_id

variant_id: string

A unique identifier for the product variant that was viewed (ex: shirt_medium_blue). Cannot exceed 255 characters in length.