selector.selected
The shopper picked another option, or switched a toggle on.
CODE
next.on('selector.selected', (data, event) => {});Data
Present: always; optional when it may be missing; campaign once the campaign is loaded; priced once the server priced the cart.
| Field | Type | Present | |
|---|---|---|---|
price | number | priced | total ÷ quantity: one package, after discounts. |
original_price | number | priced | subtotal ÷ quantity: one package, before discounts. |
subtotal | number | priced | What it costs before discounts. |
total_discount | number | priced | subtotal − total. |
discount_percentage | number | priced | total_discount ÷ subtotal × 100, to two decimals. |
selector_id | string | always | data-next-selector-id, or toggle:<package_id> for a toggle. |
type | "bundle" | "offer" | "toggle" | always | |
option_id | string | optional | The picked option's data-next-bundle-id; none for a toggle. |
lines | CartItem[] | always | The lines the picked option puts in the cart, at its quantity; the toggle's line for a toggle. Priced once the option has a price. |
currency | string | campaign | ISO 4217, such as USD. |
total | number | priced | What the picked option costs after discounts. |
quantity | number | always | Packages the picked option adds. |
in_cart | boolean | always | true while the picked option's lines are in the cart. |
options | SelectorOption[] | optional | Every option of a bundle or offer selector; none for a toggle. |
CartItem
A line of the cart. Its prices are there once the server priced the cart.
| Field | Type | Present | |
|---|---|---|---|
package_id | number | always | The package's ref_id in the campaign. |
quantity | number | always | Package quantity. |
is_upsell | boolean | optional | true for a line added after the order. |
properties | Record<string, string> | optional | Line properties, such as a variant picked in a bundle slot. |
product_id | number | campaign | The product in the store. |
product_title | string | campaign | The product's name as customers see it, as on an order line; the package's name for a package without one. |
variant_id | number | campaign | The product variant, for a product with variants. |
variant_title | string | campaign | The variant's name, such as Black / M, for a product with variants. |
sku | string | campaign | The product's Stock Keeping Unit. |
image | string | campaign | The package's image URL. |
price | number | priced | What one package costs after discounts. |
original_price | number | priced | What one package costs before discounts; equal to price when nothing is taken off. |
total_discount | number | priced | The discount on the line. |
total | number | priced | price × quantity. |
subtotal | number | priced | The line before discounts: total = subtotal − total_discount. |
discount_percentage | number | priced | total_discount ÷ subtotal × 100, to two decimals; 0 without a discount. |
discounts | Discount[] | priced | The discounts on the line. |
subscription | Subscription | campaign | For a package billed again every interval. |
SelectorOption
One option of a selector, at the quantity it would be added.
| Field | Type | Present | |
|---|---|---|---|
price | number | priced | total ÷ quantity: one package, after discounts. |
original_price | number | priced | subtotal ÷ quantity: one package, before discounts. |
subtotal | number | priced | What it costs before discounts. |
total_discount | number | priced | subtotal − total. |
discount_percentage | number | priced | total_discount ÷ subtotal × 100, to two decimals. |
option_id | string | always | The option's data-next-bundle-id, or data-next-option. |
lines | CartItem[] | always | The lines the option puts in the cart. Priced once the option has a price. |
quantity | number | always | Packages the option adds: its lines' quantities. |
selected | boolean | always | true for the selector's picked option. |
total | number | priced | What the option costs after discounts. |
original_total | number | priced | What the option costs before discounts. |
Discount
A discount on the cart's products or on its shipping. Amounts are in the cart's currency.
| Field | Type | Present | |
|---|---|---|---|
name | string | always | The offer's name. |
amount | number | always | The amount taken off. |
source | "offer" | "coupon" | always | coupon for a code the shopper entered (it is in coupons); offer for an automatic offer or a bundle card's own code. |
code | string | optional | The code, for a coupon. |
offer_id | number | always | The offer that gave it. |
percentage | number | optional | The percentage the offer is set to take off, as the API reports it, such as 20. Its configured value, for a label such as “20% off”; the amount actually taken off is amount. |
Subscription
A package billed again every interval.
| Field | Type | Present | |
|---|---|---|---|
interval | "day" | "month" | always | The unit of the renewal interval. |
interval_count | number | always | How many intervals between renewals. |
price | number | priced | What each renewal charges, after discounts. |
original_price | number | priced | What each renewal charges before discounts. |
Example
The second argument, with data inside. See Events for the envelope's fields.
CODE
{
"event_id": "3f2b8c1d9e7a4b6c8d5e2f1a0b9c8d7e",
"event_type": "selector.selected",
"object": "selector",
"data": {
"selector_id": "main",
"type": "bundle",
"option_id": "two",
"lines": [
{
"package_id": 2,
"quantity": 1,
"product_id": 400,
"product_title": "Olympus Earbuds",
"variant_id": 4002,
"variant_title": "Black",
"image": "https://cdn.test/2.png"
}
],
"currency": "USD",
"quantity": 1,
"in_cart": false,
"options": [
{
"option_id": "one",
"lines": [
{
"package_id": 1,
"quantity": 1,
"product_id": 400,
"product_title": "Olympus Earbuds",
"variant_id": 4001,
"variant_title": "Black",
"image": "https://cdn.test/1.png"
}
],
"quantity": 1,
"selected": false
},
{
"option_id": "two",
"lines": [
{
"package_id": 2,
"quantity": 1,
"product_id": 400,
"product_title": "Olympus Earbuds",
"variant_id": 4002,
"variant_title": "Black",
"image": "https://cdn.test/2.png"
}
],
"quantity": 1,
"selected": true
}
]
},
"created_at": "2026-11-04T08:30:00.000Z",
"session_id": "0b8f3c2d1e4a4f6b9c7d5e3f2a1b0c9d",
"sdk_version": "0.5.0"
}