# Cookies Source: https://docs.videowise.com/cookies Cookies used by Videowise and how Videowise follows the visitor's cookie consent. Videowise uses cookies to count video views, count each view once, and connect an order to the shopper who watched. We don't use cookies for advertising, and we don't store names, emails, or other personal data in them. **Videos always load and play**, whether or not the visitor accepts cookies. Consent only changes what Videowise stores and measures. ## Analytics cookies Set only when the visitor allows analytics (see [Consent](#consent)). | Name | Purpose | Duration | | - | - | - | | `reeview_uid` | Random, anonymous visitor ID. Links views to a later order. | 14 days | | `reeview_unique_uid` | Counts each view once. | 1 day | | `reeview_tracks_views` | Views already counted. | 1 day | | `reeview_referral` | The Videowise link the visitor came from. | 5 days | | `reeview_lsid` | The live show the visitor came from. | 5 days | | `reeview_ls_live` | Marks a visitor who came from a live show. | Session | | `REEVIEW_SESSION` | Keeps the same A/B test variant across pages. Set only on pages with an active A/B test. | 120 minutes after the last activity | The [order tracking pixel](/pixel/overview) reads `reeview_uid`, `reeview_lsid`, and `REEVIEW_SESSION`, so orders are attributed only for visitors who allow analytics. For the same reason, video campaign checkouts add the visitor ID to the cart only with consent. Until a visitor accepts, their A/B test variant is kept for the current page only. The live shopping player keeps its own `reeview_uid`: 1 day for anonymous viewers, 365 days for logged-in viewers. ## Set only after a visitor action These remember something the visitor did. They are never set on page load. | Name | Purpose | Duration | | - | - | - | | `videowise_hide_pip_` | The visitor closed the floating video. | 1, 3, 7, or 400 days (widget setting) | | `videowise_virtual_cart` | Cart contents (virtual cart). | Session | | `reeview_ls_session` | Keeps open a live show the visitor started. | Session | | `vw_gdpr_cookie_uid` | The visitor accepted the terms of a widget form. | 365 days | The player also keeps the list of submitted forms in `localStorage` (`reeview_completedForms`) and a few display flags in `sessionStorage` (`unmuteButtonDisplayed`, `swipeUpDisplayed`, `openCart`). ## Consent Videowise follows one consent signal per page: | Your store | What you need to do | | - | - | | **Shopify** | Nothing. Videowise follows the [Shopify Customer Privacy API](https://shopify.dev/docs/api/customer-privacy): the Shopify cookie banner, or a consent app that sends the choice to Shopify. | | **OneTrust** (any platform except Shopify, with or without TCF) | Nothing. Videowise reads OneTrust directly. | | **Another IAB TCF v2 consent platform** (for example Cookiebot or Didomi with TCF on) | Nothing. Load the platform's script before the Videowise script. | | **Any other consent banner** | Add the [snippet below](#other-consent-banners). | | **No consent banner** | Nothing. Cookies are set and tracking starts right away. | ### What happens The same rules apply on every platform. Tracking events are views, video engagement (play, watch time, sound), product clicks, add to cart, and A/B test events. | | Analytics cookies | Tracking events | | - | - | - | | **No consent needed** (no banner, or the visitor isn't asked) | Set right away | Sent right away | | **Before a choice** | Not set | Wait in memory on the current page | | **Visitor accepts** | Saved, with the same ID as the waiting events | Waiting events are sent once, in order. New events are sent right away. | | **Visitor declines** | Not set. Existing ones are removed. | Not sent. Waiting events are dropped. | ### When tracking starts Right away, when: * the store has no consent banner and no consent platform; * on Shopify, the visitor's region isn't in your cookie banner regions, so Shopify doesn't ask for consent; * with IAB TCF, GDPR doesn't apply to the visitor; * with OneTrust, no banner is shown to the visitor and the Videowise group is active; * the visitor has already accepted, on this page or an earlier one. When the visitor accepts, events from the current page are sent at that moment, so they are recorded with the time of acceptance. ### When tracking doesn't start Nothing is sent and no analytics cookies are set when: * the visitor hasn't answered the banner yet. If they leave the page before choosing, that page's events are never sent. Clicking a product isn't delayed. * the visitor declined. If they accept later on the same page, tracking starts from that moment; events from before are not sent. * on Shopify, your region settings require consent but nothing collects it, for example a consent app that doesn't send the choice to Shopify. Check that `Shopify.customerPrivacy.analyticsProcessingAllowed()` changes after the visitor accepts. * on Shopify, the consent API fails to load. * `vwConsentRequired` is set but `videowiseConsent` is never called. Up to 200 events wait per page; later ones are dropped until the visitor chooses. ### OneTrust Videowise listens to OneTrust's `OneTrustGroupsUpdated` event, so it follows every choice, including a change made later from the preference center. * Videowise belongs to the **Performance Cookies** group (`C0002`). If you assigned it to another group, set its ID before the Videowise script: `window.videowiseInfo.oneTrustGroup = 'C0003'`. * While the OneTrust banner waits for an answer, Videowise waits too, even if your OneTrust setup is opt-out and every group is active by default. If OneTrust shows no banner to the visitor, the group decides right away. * In OneTrust, list the `reeview_*` and `REEVIEW_SESSION` cookies under Performance Cookies. If you use OneTrust's automatic script blocking, don't categorize the `assets.videowise.com` script itself: blocking it would also block the videos. For IAB TCF, Videowise reads purpose 1 (store and/or access information on a device). ### Other consent banners Add this **before** the Videowise script: ```html theme={null} ``` Then call `videowiseConsent` from your banner: ```js theme={null} videowiseConsent('granted'); // the visitor allows analytics videowiseConsent('rejected'); // the visitor declines ``` > [!WARNING] > > Call `videowiseConsent` on every page load once the visitor has made a choice, and again whenever they change it. Until it is called, Videowise stores and sends nothing. Use `vwConsentRequired` only if your banner calls `videowiseConsent`. > [accordion] Example: Cookiebot (without TCF) > > ```js theme={null} > window.addEventListener('CookiebotOnAccept', function () { > videowiseConsent(Cookiebot.consent.statistics ? 'granted' : 'rejected'); > }); > window.addEventListener('CookiebotOnDecline', function () { > videowiseConsent('rejected'); > }); > ``` > [!NOTE] > > On Shopify, OneTrust, IAB TCF, and `vwConsentRequired` are not read: the Shopify consent always applies. On OneTrust pages, `vwConsentRequired` and `videowiseConsent` are not needed and are ignored. For the full policy, see [videowise.com/privacy](https://videowise.com/privacy). ## Related * [Order tracking pixel](/pixel/overview) — how these cookies attribute checkout * [Shoppable videos order tracking](/shoppable-videos/order-tracking) — `reeview_uid` * [Live shopping order tracking](/live-shopping/order-tracking) — `reeview_lsid` * [Shoppable videos](/shoppable-videos/overview) * [Live shopping](/live-shopping/overview) * [React Native SDK](/sdk/get-stored-data) — `getStoredData` reads the same `uid` and `lsId` values from app storage # Live channel page layout Source: https://docs.videowise.com/live-shopping/channel-layout Embed the live shopping channel as one full page, or as modular sections with your own HTML between them. The live shopping channel can render as a single full-page block, or as independent mount points so your theme can place merchant HTML between sections (campaign banners, copy, dividers, and so on). The existing single-container embed is unchanged. Use the same production channel script for both layouts: ```html theme={null} ``` ## Required `videowiseInfo` (custom / headless) On **Shopify Online Store**, the Videowise app usually injects shop identity for you (`window.Shopify.shop`). On **headless Shopify, custom platforms, or any page where `window.videowiseInfo` is missing**, set it **before** the channel script: ```html theme={null}
``` | Field | Required? | Why | | - | - | - | | `shop` | **Yes** (or `host`, or `window.Shopify.shop`) | Channel API calls use this as `host`. Without it, live / upcoming / past lists do not load. Prefer the `*.myshopify.com` domain. | | `cartType` | **Yes on non-Shopify / headless** | Selects the cart proxy (`shopify`, `magento`, `sfcc`, `tapcart`, `other`). On classic Shopify Online Store it is auto-detected from `window.Shopify`. Use `other` when you handle cart via custom events only. | | `currency` | Recommended | Used when a show opens (prices). Defaults to `USD` if omitted. | | `host` | Optional | Alias for shop identity. Resolution is `videowiseInfo.host` → `videowiseInfo.shop` → `Shopify.shop`. Setting `shop` alone is enough. | | `currencyRate` | Optional | Defaults to `'1'`. | | `locale` | Optional | Locale for channel copy when available. | | `vwHostOwnerId` | Optional | Filters lists to one host. See [below](#filter-shows-by-host-vwhostownerid). | | `forceDomain` | Optional | When `true`, product fetch and cart requests use `https://{videowiseInfo.shop}` instead of relative `/products/…` and `/cart/…` paths. See [forceDomain](/shoppable-videos/custom-platforms#forcedomain). | | `customCart` | Optional | When `true`, Shop Now does **not** call Shopify `/cart/add.js`, and the in-player virtual cart never opens. Listen for `videowiseProductAddToCart` to add items, and `show_cart` on `videowiseLiveOnInteraction` to open your cart. See [customCart](/live-shopping/custom-events#customcart). | | `lsPlayerCustomStyle` | Optional | CSS string injected into the live player iframe when a show opens. See [lsPlayerCustomStyle](/shoppable-videos/custom-platforms#lsplayercustomstyle). | `pid`, `route`, `siteID`, and product URLs are for shoppable widgets / platform-specific cart — **not** required for the channel page to load. Full field reference: [Custom platforms — videowiseInfo](/shoppable-videos/custom-platforms#setting-up-videowiseinfo). ## Filter shows by host (`vwHostOwnerId`) By default the channel lists **all** live / upcoming and past shows for the shop. To show only one host’s shows (multi-host setups), set the host owner id on `window.videowiseInfo` **before** the channel script runs: ```html theme={null}
``` Resolution order (first non-empty wins): 1. `window.videowiseInfo.vwHostOwnerId` 2. URL query param `?vwHostOwnerId=…` on the channel page When set, the channel passes that value as `hostId` when fetching: * **Active / upcoming** — live now + upcoming lists * **Past** — past recordings list Omit `vwHostOwnerId` (and the query param) to keep the unfiltered shop-wide channel. > [!TIP] > > Prefer `videowiseInfo.vwHostOwnerId` for permanent host-specific channel pages. Use the `vwHostOwnerId` query param for shareable or preview links without changing the page script. ## Monolith (default) One container receives the hero, live now, upcoming shows, and past recordings: ```html theme={null}
``` If `#videowise_stream_channel` is on the page, it always wins. Section containers on the same page are ignored. ## Section layout (modular) Omit `#videowise_stream_channel`. Place empty `div`s where each section should appear. Any HTML between them is left alone — Videowise only fills the mounts. ```html theme={null}
This week on live

``` ### Container ids | Id | Section | | - | - | | `videowise_stream_channel` | Full channel (monolith). Takes precedence over the rows below. | | `videowise_stream_channel_hero` | Subscribe / banner hero | | `videowise_stream_channel_livenow` | Live now grid | | `videowise_stream_channel_upcoming` | Upcoming shows | | `videowise_stream_channel_past` | Past recordings | | `videowise_stream_channel_shared` | Optional host for RSVP, sockets, and popups | You can use a subset of sections. A page with only `#videowise_stream_channel_past` still loads recordings. A missing or empty section stays empty when there is nothing to show (for example no live show is on air, or the hero banner is disabled in channel settings). ### Shared container (optional) RSVP, the channel socket, and popup portals are not tied to a visible section. They run from `#videowise_stream_channel_shared`. You do not need to add this `div`. If it is missing, the widget appends a hidden one to `document.body`. Add it yourself only when you want that host in a specific place in the DOM (for example outside a clipped layout wrapper): ```html theme={null}
``` ## How it works One React tree still owns channel settings, data fetching, sockets, RSVP, and autoplay. In section mode that tree mounts on the shared host and portals each section into the matching container. The same embed loader is used for both layouts. Any `div` whose `id` starts with `videowise_stream_channel` is enough to load the channel assets. ## Styling tips Videowise owns the look of each section. Keep theme CSS from fighting the embed: * Prefer class-scoped merchant styles. Avoid global rules on `button`, `input`, `form`, or `*` that cascade into Videowise UI (including the subscribe modal). * Do not put `overflow: hidden` on wrappers around the mounts — overlays and modals can be clipped. * Avoid forcing `text-align`, `font-family`, or `color` on ancestors of the mounts if you need Videowise defaults. * Do not duplicate hero copy/CTAs in merchant HTML if `#videowise_stream_channel_hero` is present — use the Videowise hero as the source of truth. ## Example: merchant framing around sections ```html theme={null}

Live now

Upcoming shows

Past shows

``` > [!WARNING] > > Do not add `#videowise_stream_channel` on the same page as the section mounts. The monolith container takes precedence and the section mounts are ignored. ## React Native SDK In `@videowisehq/videowise-react-native-sdk`, pass the same section markup via `channelBodyHtml` on `LiveShoppingChannel`. The SDK injects that string into the WebView `` instead of the default monolith `#videowise_stream_channel` div. ```tsx theme={null}
`} /> ``` See [React Native SDK — Live Shopping Channel](/sdk/live-shopping-channel#custom-channel-body--modular-section-layout). ## Related * [Live shopping overview](/live-shopping/overview) * [Launch a live stream](/live-shopping/stream-rendering) — open a specific show with `videowiseLaunchLive` or `vwLsId`, or resize the player iframe with `videowiseChangeLivePlayerSize` * [Live shopping custom events](/live-shopping/custom-events) * [Custom platforms](/shoppable-videos/custom-platforms) — `videowiseInfo`, including optional `vwHostOwnerId` * [React Native SDK](/sdk/live-shopping-channel) — use `channelBodyHtml` on `LiveShoppingChannel` for the same section mounts inside the app WebView * [Order tracking](/live-shopping/order-tracking) * [Cookies](/cookies) # Custom events Source: https://docs.videowise.com/live-shopping/custom-events Listen for live player, product, and checkout interactions during a live show. Live shopping events are dispatched on `window`. Use `window.addEventListener` to intercept them. These events are for **live shopping**. Widget events are documented separately — see [Shoppable video custom events](/shoppable-videos/custom-events). On React Native, live events arrive through `onEvent` on `LiveShoppingChannel` — see [Live Shopping Channel](/sdk/live-shopping-channel). ```javascript Code Block Example theme={null} window.addEventListener("videowiseLiveOnInteraction", (event) => { console.log(event.detail.interactionType); // for example mute_player console.log(event.detail); // return Data from event }); ``` ## customCart Set `customCart: true` on `window.videowiseInfo` when the storefront owns add-to-cart (headless Shopify, custom cart drawer, Hydrogen, and so on). When `customCart` is `true`, a Shop Now click in the live player: 1. Does **not** call Shopify `/cart/add.js` (no Videowise Ajax cart, no in-player cart). 2. Minimizes the player. 3. Always dispatches [`videowiseProductAddToCart`](#videowiseproductaddtocart) on the **parent storefront** (the player iframe posts it to the host page). 4. Does **not** dispatch `videowiseLiveOnInteraction` with `interactionType = add_to_cart` — that interaction is only fired from Shopify Ajax add. The in-player **virtual cart never opens** when `customCart` is `true`. Cart icon taps still show, but they only dispatch `videowiseLiveOnInteraction` with `interactionType = show_cart` — open your own cart UI from that event. `hide_cart` is not sent (there is no in-player cart to close). You **must** listen for `videowiseProductAddToCart` on the parent page and add the item with your own cart logic. If you do not, nothing is added to the cart. Do not wait for `add_to_cart` on `videowiseLiveOnInteraction`. ```html theme={null} ``` For `videowiseProductAddToCart`, `event.detail` includes `productName`, `productId`, `variantId`, `qty`, `price`, `currencyCode`, `deviceType`, `url`, `subscriptionId`, and `selectedVariant`. When `customCart` is omitted or `false`, live shopping still adds via Shopify Ajax, fires `videowiseLiveOnInteraction` with `add_to_cart`, **and** still fires `videowiseProductAddToCart` (for tracking or extra UI). The custom event is required for cart only when `customCart` is `true`. This is separate from shoppable **widget** add-to-cart (Buy button → Virtual cart). Widgets use that dashboard setting; live shopping uses `videowiseInfo.customCart`. See [Shoppable video custom events](/shoppable-videos/custom-events). ## Events ### videowiseLiveOnPlay Triggered when the live stream is playing. * `clientTS` * `currentTime` * `device` * `eventType` * `interactionType = resume_player` * `isLive` * `lsId` * `organisationId` * `siteId` * `uid` * `url` * `videoElapsedMinutes` * `videoElapsedSeconds` ### videowiseLiveOnStop Triggered when the live stream is closed. * `clientTS` * `currentTime` * `device` * `eventType` * `interactionType = close_player` * `isLive` * `lsId` * `organisationId` * `siteId` * `uid` * `url` * `videoElapsedMinutes` * `videoElapsedSeconds` ### videowiseLiveOnInteraction Triggered when a user executes a specific interaction during the live stream. * `clientTS` * `currentTime` * `device` * `eventType` * `interactionType` * `isLive` * `lsId` * `organisationId` * `siteId` * `uid` * `url` * `videoElapsedMinutes` * `videoElapsedSeconds` The interactonType can be: * `mute_player` * `unmute_player` * `pause_player` * `resume_player` * `like_reaction` * `share` * `add_to_calendar` * `send_chat` * `minimize_player` * `maximize_player` * `show_product_list` * `hide_product_list` * `product_click` * `add_to_cart` — only when `customCart` is **not** set. With `customCart: true` this interaction is **not** dispatched; use [`videowiseProductAddToCart`](#videowiseproductaddtocart) instead. * `checkout` * `show_cart` — cart icon tap. With `customCart: true` this is how you open **your** cart (the in-player virtual cart does not open). Without `customCart`, this fires when the in-player cart opens. * `hide_cart` — in-player cart closed. Not sent when `customCart` is `true`. * `replay` * `progress` If `interactionType = share` then the event will contain in addition: * `socialShare` If `interactionType = product_click | add_to_cart` then the event will contain in addition: * `item` (which is data about product from the live stream) `add_to_cart` is emitted from Shopify Ajax add (`handleAddToCart`). When `window.videowiseInfo.customCart` is `true`, that path is skipped, so `videowiseLiveOnInteraction` will **not** have `interactionType = add_to_cart`. ### videowiseLiveStreamingPlayerInit Triggered when the live streaming player is initialized. ### videowiseProductAddToCart Dispatched on the **parent storefront** when the shopper clicks Shop Now in the live player (the iframe posts the event to the host page). Listen on the parent `window`, not inside the player iframe. `event.detail`: * `productName` * `productId` * `variantId` * `qty` * `price` * `currencyCode` * `deviceType` * `url` * `subscriptionId` * `selectedVariant` > [!WARNING] > > When `window.videowiseInfo.customCart` is `true`, this event is the **only** add-to-cart signal. The player does not call Shopify `/cart/add.js`, does not open the in-player virtual cart, minimizes after the click, and does **not** dispatch `videowiseLiveOnInteraction` with `interactionType = add_to_cart`. Cart icon taps dispatch `show_cart` instead — open your own cart from that interaction. If you do not handle `videowiseProductAddToCart`, the item is not added. When `customCart` is omitted or `false`, Shopify Ajax add still runs, `videowiseLiveOnInteraction` still includes `add_to_cart`, and `videowiseProductAddToCart` still fires (for tracking or extra UI). ```js theme={null} window.addEventListener('videowiseProductAddToCart', (event) => { const { variantId, qty, productId, price, currencyCode, selectedVariant, subscriptionId } = event.detail || {}; if (variantId && qty) { addToCart(variantId, qty); } }); ``` This is the same event name as shoppable widgets. For live shopping with a custom cart, set `customCart: true` — see [customCart](#customcart). ## Related * [Live shopping overview](/live-shopping/overview) * [Channel page layout](/live-shopping/channel-layout) * [Launch a live stream](/live-shopping/stream-rendering) * [Shoppable video custom events](/shoppable-videos/custom-events) * [React Native SDK](/sdk/live-shopping-channel) * [Order tracking](/live-shopping/order-tracking) # Order tracking Source: https://docs.videowise.com/live-shopping/order-tracking Attribute checkout to a live shopping session with reeview_lsid. When a shopper watches a live show, Videowise sets the `reeview_lsid` cookie (30 days). The order tracking pixel reads that cookie at checkout and sends it as `lsId`, so the order is attributed to the live session. You do **not** install a second pixel for live shopping. Use the same storefront pixel as shoppable videos. This page covers what is specific to live shows. ## How attribution works 1. The shopper opens a live show — channel page, [`videowiseLaunchLive`](/live-shopping/stream-rendering), or a `vwLsId` link. 2. Videowise writes `reeview_lsid` with the live stream ID. See [Cookies](/cookies). 3. On order confirmation, the pixel includes `lsId` in the tracking request. The pixel snippets already send `lsId`. Shopify, Magento, SFCC, and custom/GTM installs all read `reeview_lsid`. On React Native, persist and send the same ID with [`getStoredData`](/sdk/get-stored-data) (`lsId`) and [`trackingPixel`](/sdk/tracking-pixel). The order request also needs `referral`, URL-encoded: ```json theme={null} { "vw_referral_channel": "mobile_app", "vw_source_id": "", "vw_user_identifier": "" } ``` `VideowiseSDK.trackingPixel` sets that when `lsId` is stored. A custom mobile pixel must send it. Without it, the order is not attributed to **MOBILE APP**. Live Shopping add-to-cart uses the same referral on `/tracking/cart/pixel`. See [Tracking pixel](/sdk/tracking-pixel). ## Install the pixel Follow the platform guide in [Order tracking pixel](/pixel/overview). Install once per storefront. > [card] [Shopify](/pixel/shopify) > > Customer events pixel. Sends `lsId` from `reeview_lsid`. > [card] [Magento](/pixel/magento) > > Included on the default thank-you page. > [card] [Salesforce Commerce Cloud](/pixel/sfcc) > > Included on the default order confirmation page. > [card] [Other / GTM](/pixel/custom) > > Custom snippet. Passes `lsId` on the order payload. ## Related * [Live shopping overview](/live-shopping/overview) * [Launch a live stream](/live-shopping/stream-rendering) * [Shoppable videos order tracking](/shoppable-videos/order-tracking) * [Order tracking pixel](/pixel/overview) — platform install * [Cookies](/cookies) * [Tracking pixel (SDK)](/sdk/tracking-pixel) # Overview Source: https://docs.videowise.com/live-shopping/overview Embed the live shopping channel, open a specific show, and track live interactions. Live shopping is a separate embed from shoppable video widgets. Use it to render the channel page (hero, live now, upcoming, past) or to open a single live show. | Goal | Page | | - | - | | Embed the full channel, or split it into modular sections | [Channel page layout](/live-shopping/channel-layout) | | Open one show from a button or a shared URL | [Launch a live stream](/live-shopping/stream-rendering) | | Track play, chat, cart, and other live interactions | [Custom events](/live-shopping/custom-events) | | Attribute orders from a live show | [Order tracking](/live-shopping/order-tracking) | | Embed the channel in a mobile app | [Live Shopping Channel (SDK)](/sdk/live-shopping-channel) | On non-Shopify or headless storefronts, set `window.videowiseInfo` before the channel script runs — at least `shop` and `cartType` (plus `currency` recommended). If Shopify Ajax should hit `*.myshopify.com` instead of the current page origin, also set `forceDomain: true` on that object. If your storefront owns add-to-cart, set `customCart: true` and handle [`videowiseProductAddToCart`](/live-shopping/custom-events#customcart) on the parent page — the player will not call `/cart/add.js`, and cart icon taps dispatch `show_cart` instead of opening the in-player cart. See [Required videowiseInfo](/live-shopping/channel-layout#required-videowiseinfo-custom--headless) and [Custom platforms](/shoppable-videos/custom-platforms#live-shopping-channel-on-custom-platforms). For multi-host shops, set `window.videowiseInfo.vwHostOwnerId` (or `?vwHostOwnerId=`) so the channel lists only that host’s active and past shows. See [Filter shows by host](/live-shopping/channel-layout#filter-shows-by-host-vwhostownerid). The [order tracking](/live-shopping/order-tracking) flow attributes checkouts to a live session via the `reeview_lsid` cookie. Install the storefront pixel once — see [Order tracking pixel](/pixel/overview). > [card] [Channel page layout](/live-shopping/channel-layout) > > One full-page block, or modular hero, live now, upcoming, and past mounts. > [card] [Launch a live stream](/live-shopping/stream-rendering) > > Open a show with `videowiseLaunchLive` or the `vwLsId` URL parameter. Minimize or maximize the open player with `videowiseChangeLivePlayerSize`. > [card] [Custom events](/live-shopping/custom-events) > > Listen for live player, product, and checkout interactions. > [card] [Order tracking](/live-shopping/order-tracking) > > Attribute orders from live shopping sessions (`reeview_lsid`). > [card] [React Native SDK](/sdk/live-shopping-channel) > > `LiveShoppingChannel`, PiP, and the same section mounts in a WebView. ## Related * [Shoppable videos](/shoppable-videos/overview) — on-site widgets (stories, carousels, grids) * [Order tracking](/live-shopping/order-tracking) — attribute orders using the `reeview_lsid` cookie * [Cookies](/cookies) — live shopping session and analytics cookies # Launch a live stream Source: https://docs.videowise.com/live-shopping/stream-rendering Open a specific live show with videowiseLaunchLive or the vwLsId URL parameter, and minimize or maximize the player iframe. Use this when you want to open **one live show**, not the full channel page. > [!NOTE] > > To embed the live shopping **channel** (or split it into modular sections), see [Channel page layout](/live-shopping/channel-layout). ### Opening the live stream player with Videowise's global helper function Videowise provides a helper on `window` that opens the live stream player from any page. Attach it to a click handler and pass the live stream ID from the Videowise app. ```js Launch live stream theme={null} window.videowiseLaunchLive("live-stream-id-here"); ``` On React Native, pass the same ID as `lsId` on `LiveShoppingChannel`. See [Live Shopping Channel](/sdk/live-shopping-channel). ### Minimize or maximize the live player `window.videowiseChangeLivePlayerSize` is defined on the **storefront page** (`window.top`) by the live iframe-embed script — the same parent `window` as [`videowiseLaunchLive`](#opening-the-live-stream-player-with-videowises-global-helper-function). It is **not** available inside the player iframe. Call it from theme or custom JS on the host page. `true` expands to fullscreen; `false` collapses to the mini player. If the player is not open, the call is a no-op. ```html Storefront (parent page) theme={null} ``` Use this after the player has opened (`videowiseLaunchLive` or a `vwLsId` auto-launch). It uses the same path as tapping the player to expand or the close-fullscreen control to collapse. This helper is for the **web iframe** player. It is not used in the React Native SDK. ### Auto-launching the live stream player via URL parameter When `vwLsId` is present in the page URL and contains a valid live stream ID, the player launches automatically. Use this for shareable links that start playback on load. ```js Auto-launching theme={null} https://example.com/?vwLsId=68026acfc5be1a0058e6ce0a ``` #### 1. Go to live shopping ![Go to live shopping](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/images/image-1.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=5bfa218c1c51ba9a421333e706eda4b0) #### 2. Open the live show ![Open the live show](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/images/image-2.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=cbe417feaa2e22ee408c47260816139c) #### 3. Copy the ID from the URL ![Copy the ID from the URL](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/images/image-3.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=04ac83255bcebea48c248a2341d9a05d) ## Related * [Live shopping overview](/live-shopping/overview) * [Channel page layout](/live-shopping/channel-layout) * [Live shopping custom events](/live-shopping/custom-events) * [Custom platforms](/shoppable-videos/custom-platforms#live-shopping-channel-on-custom-platforms) * [Order tracking](/live-shopping/order-tracking) — attributes live checkouts via `reeview_lsid` * [Cookies](/cookies) — `reeview_lsid` is set when a show is opened # Other Source: https://docs.videowise.com/pixel/custom Learn how to install the Videowise Custom Pixel Code on your site. ### Custom Pixel Code ```js theme={null} // VIDEOWISE TRACKING PIXEL function VWPixel({ orderId, orderTotal, orderCurrency, orderItems, shippingCosts, taxAmount }) { var PIXEL_VERSION = "2.0.0"; var UID_COOKIE_NAME = "reeview_uid"; var CAMPAIGN_COOKIE_NAME = "reeview_campaign"; var LS_COOKIE_NAME = "reeview_lsid"; var REFERRAL_COOKIE_NAME = "reeview_referral"; var WIDGET_EXPERIMENT_COOKIE_NAME = "REEVIEW_SESSION"; function getCookie(name) { let cookieArr = document.cookie.split(";"); for (let i = 0; i < cookieArr.length; i++) { let cookiePair = cookieArr[i].split("="); if (name === cookiePair[0].trim()) { return decodeURIComponent(cookiePair[1]); } } return null; } function deleteCookie(name) { document.cookie = name + "=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;"; } function objectToQueryString(obj) { let result = ""; var keys = Object.keys(obj); for (let i = 0; i < keys.length; i++) { var key = keys[i]; result += `${key}=${obj[key]}`; if (i < keys.length - 1) { result += "&"; } } return result; } function getDeviceType() { var size = 1024; var isDesktop = window.screen.width > size; return isDesktop ? "DESKTOP" : "MOBILE"; } var shop = window.location.host; if (getCookie(UID_COOKIE_NAME) && shop && orderId && orderTotal) { var params = { uid: getCookie(UID_COOKIE_NAME), deviceType: getDeviceType(), orderId, shop, checkout_type: "OTHER", order_total: orderTotal, currency: orderCurrency, order_items: orderItems.length, campaignId: getCookie(CAMPAIGN_COOKIE_NAME), lsId: getCookie(LS_COOKIE_NAME), clientTs: new Date().toISOString(), experiment: getCookie(WIDGET_EXPERIMENT_COOKIE_NAME), referral: getCookie(REFERRAL_COOKIE_NAME), order_products: encodeURIComponent(JSON.stringify(orderItems)), shipping_costs: shippingCosts || 0, tax_amount: taxAmount || 0, pixel_version: PIXEL_VERSION, }; var trackingUrl = `https://api.videowise.com/tracking/pixel?${objectToQueryString( params, )}`; fetch(trackingUrl).then((res) => { console.log( `Videowise pixel -- order -- (version: ${PIXEL_VERSION}) executed correctly`, ); deleteCookie(CAMPAIGN_COOKIE_NAME); }); } } ``` ```ts The order item object type is: theme={null} type OrderItem = { id: string; quantity: number; title: string | null; variant: { id: string; image: { src: string | null; }; price: { amount: number; currencyCode: string; }; product: { id: string; title: string | null; vendor: string | null; type: string | null; untranslatedTitle: string | null; url: string; }; sku: string | null; title: string; untranslatedTitle: string; }; finalLinePrice: { amount: number; currencyCode: string; }; discountAllocations?: DiscountAllocation[]; }; type DiscountAllocation = { amount: { amount: number; currencyCode: string; }; discountApplication: { allocationMethod: string; targetSelection: string; targetType: "LINE_ITEM" | "SHIPPING_LINE"; title: string | null; type: string; value: { percentage: number } | { amount: number; currencyCode: string }; }; }; ``` `finalLinePrice` is the line total **before** discount allocations — typically `variant.price.amount * quantity`, matching Shopify checkout line items. Do not pre-subtract discounts. Pass Shopify `discountAllocations` on the line; Videowise subtracts them. Allocations whose `discountApplication.targetType` is `SHIPPING_LINE` are ignored. Example `orderItems` payload: ```js theme={null} [ { id: "1234567890", quantity: 1, title: "Product 1", variant: { id: "1234567890", image: { src: "https://example.com/image.jpg", }, price: { amount: 100, currencyCode: "USD", }, product: { id: "1234567890", title: "Product 1", vendor: "Vendor 1", type: "Type 1", untranslatedTitle: "Product 1", url: "https://example.com/product/1234567890", }, sku: "1234567890", title: "Product 1", untranslatedTitle: "Product 1", }, finalLinePrice: { amount: 100, currencyCode: "USD", }, discountAllocations: [ { amount: { amount: 10, currencyCode: "USD" }, discountApplication: { allocationMethod: "ACROSS", targetSelection: "ALL", targetType: "LINE_ITEM", title: "LIVE10", type: "DISCOUNT_CODE", value: { percentage: 10 }, }, }, ], }, ] ``` ## Running the pixel Copy the pixel code and use it as a custom js script on your website. Whenever you have a successful order, call the `VWPixel` function with the following arguments: * `orderId`: The order ID * `orderTotal`: The order total * `orderCurrency`: The order currency * `orderItems`: The order items (see the `OrderItem` type above, including optional `discountAllocations`) * `shippingCosts` (optional): Shipping amount. Sent as `shipping_costs`. Defaults to `0` * `taxAmount` (optional): Tax amount. Sent as `tax_amount`. Defaults to `0` **Note**: some keys are optional, but it's recommended to pass all the arguments. On the web, `referral` is **not** an argument. The snippet sends it from the `reeview_referral` cookie. For a **mobile app**, use [`trackingPixel`](/sdk/tracking-pixel) — the SDK sets `referral` with `vw_referral_channel: "mobile_app"`. A custom mobile pixel (no SDK) must send that object itself or the order is not attributed to **MOBILE APP**. See [Live shopping order tracking](/live-shopping/order-tracking). Example: ```js theme={null} VWPixel({ orderId: "1234567890", orderTotal: 90, orderCurrency: "USD", shippingCosts: 5, taxAmount: 8.25, orderItems: [ { id: "1234567890", quantity: 1, title: "Product 1", variant: { id: "1234567890", image: { src: "https://example.com/image.jpg", }, price: { amount: 100, currencyCode: "USD", }, product: { id: "1234567890", title: "Product 1", vendor: "Vendor 1", type: "Type 1", untranslatedTitle: "Product 1", url: "https://example.com/product/1234567890", }, sku: "1234567890", title: "Product 1", untranslatedTitle: "Product 1", }, finalLinePrice: { amount: 100, currencyCode: "USD", }, discountAllocations: [ { amount: { amount: 10, currencyCode: "USD" }, discountApplication: { allocationMethod: "ACROSS", targetSelection: "ALL", targetType: "LINE_ITEM", title: "LIVE10", type: "DISCOUNT_CODE", value: { percentage: 10 }, }, }, ], }, ], }); ``` ## Google Tag Manager (GTM) If you manage your scripts through [Google Tag Manager](https://tagmanager.google.com/), you can fire the Videowise pixel from a **Custom HTML tag** that reads the order data from the `dataLayer`. This is the recommended approach when you don't have direct access to your theme/template code, or when your order data is already available as a `dataLayer` event (for example a GA4 `purchase` event). The flow has three parts: 1. Your store/site **pushes** a purchase event with the order data to the `dataLayer`. 2. A GTM **trigger** listens for that event. 3. A GTM **Custom HTML tag** runs the `VWPixel` function using values read from the `dataLayer`. ### 1. Push the order data to the dataLayer On your order confirmation / thank-you page, push an event to the `dataLayer` as soon as the order is successful. Make sure `window.dataLayer` is initialized **before** the GTM snippet runs. ```html theme={null} ``` ### 2. Create the data layer variables In GTM, create **Data Layer Variables** so the tag can read each field: | Variable name | Data Layer Variable Name | | - | - | | `DLV - orderId` | `order.orderId` | | `DLV - orderTotal` | `order.orderTotal` | | `DLV - orderCurrency` | `order.orderCurrency` | | `DLV - orderItems` | `order.orderItems` | | `DLV - shippingCosts` | `order.shippingCosts` | | `DLV - taxAmount` | `order.taxAmount` | ### 3. Create the trigger Create a **Custom Event** trigger that fires on the event name you pushed: * **Trigger type**: Custom Event * **Event name**: `vw_purchase` (or your existing `purchase` event) ### 4. Create the Custom HTML tag Create a **Custom HTML** tag, set it to fire on the trigger above, and paste the `VWPixel` function (from the top of this page) followed by an invocation that uses the GTM variables: ```html theme={null} ``` > [!NOTE] > > GTM variable references like `{{DLV - orderId}}` are replaced with their actual > values when the tag runs. String values are inserted with surrounding quotes > automatically, while objects/arrays (such as `orderItems`) are injected as JSON, > so they don't need extra quotes. ### 5. Verify Use **GTM Preview mode** to place a test order and confirm the tag fires on the purchase event. When it runs successfully you'll see the following message in the browser console: ``` Videowise pixel -- order -- (version: 2.0.0) executed correctly ``` ## Related * [Pixel overview](/pixel/overview) * [Custom platforms](/shoppable-videos/custom-platforms) * [Live shopping order tracking](/live-shopping/order-tracking) * [Cookies](/cookies) * [React Native SDK](/sdk/tracking-pixel) — use `trackingPixel` in apps instead of this snippet (`shippingCosts`, `taxAmount`, `discountAllocations`, and mobile-app `referral`) # Magento Source: https://docs.videowise.com/pixel/magento Learn how to install the Videowise Order Tracking Pixel on your Magento store. # Pixel Integration for Magento ## Introduction This document provides instructions on how to integrate Order Tracking Pixel with Magento. > [!NOTE] > > Our Magento implementation includes the Order Tracking Pixel pre-installed on the default Thank you page. > > If you are utilizing the default Thank you page, no further action is required. ## Prerequisites * Magento 2.x installed * Admin access to your Magento backend files * Videowise Pixel Tracking activated from Videowise Application ## Integration Options There are two options to integrate the Order Tracking Pixel on other pages in your Magento store: ### Option 1: Using Magento XML Frontend Extensions You can add our already defined PHTML block to your preferred location using Magento XML frontend extensions. This method involves updating your layout XML file to include the tracking pixel block. Here is an example: ```xml theme={null} ``` Replace `your-container-name` with the appropriate container name where you want the tracking pixel to be placed. ## Option 2: Adding Custom JavaScript Code Alternatively, you can add custom JavaScript code to your preferred location after a successful order. You will need to complete the necessary fields in the script. Here is an example: ```JavaScript theme={null} ``` Make sure to replace the placeholders (`{{ ... }}`) with the actual values from your Magento store. All actual values can be retrieved manually with custom code or using our PHP public method `getOrderData` from `Videowise\VideowiseApp\Block\VideowiseTrackingPixel` which will return the following array: ```PHP theme={null} [ 'orderId' => 123, // Last Order ID from User Session 'orderTotal' => 123, // Order Total 'orderCurrency' => 'USD', // Order Currency 'orderItemsTotal' => 2, // Number of Order Products 'storeId' => 1, // Order Store ID ] ``` ## Conclusion You have successfully integrated Pixel with your Magento store. For further customization and advanced features, refer to our [FAQ page](https://videowise.com/faq). ## Related * [Pixel overview](/pixel/overview) * [Custom platforms](/shoppable-videos/custom-platforms) * [Live shopping order tracking](/live-shopping/order-tracking) * [Cookies](/cookies) # Overview Source: https://docs.videowise.com/pixel/overview Attribute orders from shoppable videos and live shopping across ecommerce platforms. The order tracking pixel tells Videowise when a shopper checks out. Shoppable videos send `uid` from `reeview_uid` — see [Shoppable videos order tracking](/shoppable-videos/order-tracking). Live shopping sends `lsId` from `reeview_lsid` — see [Live shopping order tracking](/live-shopping/order-tracking). Install the pixel once per storefront. That one install covers widgets and live shows. Install the pixel for your platform: > [card] [Shopify](/pixel/shopify) > > Custom pixel in **Settings → Customer events**. > [card] [Magento](/pixel/magento) > > Included on the default thank-you page; optional extra placements. > [card] [Salesforce Commerce Cloud](/pixel/sfcc) > > Included on the default order confirmation page; optional extra placements. > [card] [Other / GTM](/pixel/custom) > > Custom snippet or Google Tag Manager. On React Native, call [`trackingPixel`](/sdk/tracking-pixel) after checkout instead of installing a web pixel. That page covers `shippingCosts`, `taxAmount`, `discountAllocations`, and the mobile-app `referral` object. Live-show orders from the app are attributed to **MOBILE APP**, not ON SITE. On custom / GTM web installs, pass `shippingCosts`, `taxAmount`, and line-item `discountAllocations` into [`VWPixel`](/pixel/custom). Web `referral` comes from the `reeview_referral` cookie. ## Related * [Cookies](/cookies) * [Shoppable videos order tracking](/shoppable-videos/order-tracking) * [Live shopping order tracking](/live-shopping/order-tracking) * [Custom platforms](/shoppable-videos/custom-platforms) # Salesforce Commerce Cloud Source: https://docs.videowise.com/pixel/sfcc Learn how to install the Videowise Order Tracking Pixel on your SFCC instance. # Pixel Integration for SFCC ## Introduction This document provides instructions on how to integrate Order Tracking Pixel with SFCC. > [!NOTE] > > Our Salesforce Commerce Cloud implementation includes the Tracking Pixel pre-installed on the default Order Confirmation Page. > > If you are utilizing the default Order Confirmation Page, no further action is required. ## Prerequisites * Salesforce Commerce Cloud instance * Admin access to your Salesforce Commerce Cloud instance * Videowise Pixel Tracking activated from Videowise Application * Videowise Cartridge in your Business Manager Cartridge path ## Integration Options There are two options to integrate the Order Tracking Pixel on other pages on your SFCC instance: ### Option 1: Adding our pre-defined ISML code to your files You can add our already pre-defined ISML code to your preferred location. This method involves updating your ISML file to include our code. For example let's modify the `template/default/checkout/confirmation/confirmation.isml`: \[!WARNING] `dw.order.Order` object must be present in the PipelineDictionary (pdict) as key `order` 1. You will need to add our `` to the top of the file right under your decorate template (``) ```HTML theme={null} Videowise SFCC var shouldTrackPurchase = dw.system.Site.getCurrent().getCustomPreferenceValue('videoWiseEnabled'); var trackingAPIUrl = dw.system.Site.getCurrent().getCustomPreferenceValue('videowiseTrackingApiUrl'); if (shouldTrackPurchase) { assets.addJs('/js/videowisePurchaseTracking.js'); } ``` 2. Add our `` right before decorator ends ```HTML theme={null} ``` > [!TIP] > > Order Tracking Pixel should now be available after the next successful order. ## Option 2: Adding Custom JavaScript Code Alternatively, you can add custom JavaScript code to your preferred location after a successful order. You will need to complete the necessary fields in the script. Here is an example: ```JavaScript theme={null} ``` Make sure to replace the placeholders (`{{ ... }}`) with the actual values from your SFCC instance. All actual values can be retrieved manually with custom code or using our Javascript Helper public method `getTrackingPixelData` from `cartridge/scripts/helpers/videoWiseHelpers.js` which will return the following object: ```JavaScript theme={null} { grandTotal: 123, // Order Grand total orderNumber: 'ODEV-123', // Order Number productQuantityTotal: 5, // Order Total products quantity currency: 'USD', // Order Currency Code shop: 'https://instanceURL.com' // Order Instance URL } ``` > [!TIP] > > Order Tracking Pixel should now be available after the next successful order. ## Conclusion You have successfully integrated Pixel with your SFCC instance. For further customization and advanced features, refer to our [FAQ page](https://videowise.com/faq). ## Related * [Pixel overview](/pixel/overview) * [Custom platforms](/shoppable-videos/custom-platforms) * [Live shopping order tracking](/live-shopping/order-tracking) * [Cookies](/cookies) # Shopify Source: https://docs.videowise.com/pixel/shopify Install the Videowise order tracking pixel on Shopify via Customer events. ### Customer Events Pixel Code If your Shopify version supports web pixels go to "Settings -> Customer events" and click the "Add custom pixel". Give the new pixel a name like "Videowise Pixel" and add the following pixel code: ![](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/pixel/store-settings.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=d6bf5a8ae7473ed3cc79259a58c21afc) ![](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/pixel/customer-events.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=e0fea0ee3aa6a63012f0880d4a8a4818) ![](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/pixel/add-custom-pixel.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=ee213d443cf90cf28a8095b0563d3d13) ![](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/pixel/add-new-pixel.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=96bc787316efaa010a92c0ce8b113df2) ![](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/pixel/paste-code.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=3bd36a1cb9a7d0801ac01971d828a686) ![](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/pixel/save-pixel.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=b6aa1e8f4a9c41cb703dddaf95a70669) ![](https://mintcdn.com/videowise/8_1ghAJvj_CP-3qs/pixel/connect-pixel.png?fit=max\&auto=format\&n=8_1ghAJvj_CP-3qs\&q=85\&s=c27f61788b07ac48f3426e1fb3b6e84d) ```js Customer Events Pixel Code theme={null} // VIDEOWISE TRACKING PIXEL const PIXEL_VERSION = "2.0.0"; const UID_COOKIE_NAME = "reeview_uid"; const CAMPAIGN_COOKIE_NAME = "reeview_campaign"; const LS_COOKIE_NAME = "reeview_lsid"; const REFERRAL_COOKIE_NAME = "reeview_referral"; const WIDGET_EXPERIMENT_COOKIE_NAME = "REEVIEW_SESSION"; function setSessionCookie(name, value) { document.cookie = `${name}=${value}; path=/`; } function setReferralCookieFromParams(ev) { const url = ev.context.window.location.href; const params = new URL(url).searchParams; const sourceId = params.get("vw_source_id") const referralChannel = params.get("vw_referral_channel") const userIdentifier = params.get("vw_user_identifier") if(sourceId && referralChannel && userIdentifier){ setSessionCookie(REFERRAL_COOKIE_NAME, encodeURIComponent(JSON.stringify({ vw_user_identifier: userIdentifier, vw_referral_channel: referralChannel, vw_source_id: sourceId }))) } } function getCookie(name) { let cookieArr = document.cookie.split(";"); for (let i = 0; i < cookieArr.length; i++) { let cookiePair = cookieArr[i].split("="); if (name === cookiePair[0].trim()) { return decodeURIComponent(cookiePair[1]); } } return null; } function deleteCookie(name) { document.cookie = name + "=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;"; } function objectToQueryString(obj) { let result = ""; const keys = Object.keys(obj); for (let i = 0; i < keys.length; i++) { const key = keys[i]; result += `${key}=${obj[key]}`; if (i < keys.length - 1) { result += "&"; } } return result; } const getDeviceType = () => { const size = 1024; const isDesktop = window.screen.width > size; return isDesktop ? "DESKTOP" : "MOBILE"; }; function VW(orderId, orderTotal, orderCurrency, orderItemsLength, event, orderProducts, shippingCosts, taxAmount) { const shop = event.context.window.location.host if (getCookie(UID_COOKIE_NAME) && shop && orderId && orderTotal) { const params = { uid: getCookie(UID_COOKIE_NAME), deviceType: getDeviceType(), orderId, shop, checkout_type: "SHOPIFY", order_total: orderTotal, currency: orderCurrency, order_items: orderItemsLength, campaignId: getCookie(CAMPAIGN_COOKIE_NAME), lsId: getCookie(LS_COOKIE_NAME), clientTs: new Date().toISOString(), experiment: getCookie(WIDGET_EXPERIMENT_COOKIE_NAME), referral: getCookie(REFERRAL_COOKIE_NAME), order_products: encodeURIComponent(JSON.stringify(orderProducts)), shipping_costs: shippingCosts || 0, tax_amount: taxAmount || 0, pixel_version: PIXEL_VERSION }; const trackingUrl = `https://api.videowise.com/tracking/pixel?${objectToQueryString( params )}`; fetch(trackingUrl).then((res) => { console.log( `Videowise pixel -- order -- (version: ${PIXEL_VERSION}) executed correctly` ); deleteCookie(CAMPAIGN_COOKIE_NAME); }); } } analytics.subscribe("checkout_started", (event)=>{ setReferralCookieFromParams(event) }) analytics.subscribe("checkout_completed", (event) => { const checkout = event.data.checkout; VW( checkout.order.id, checkout.totalPrice.amount, checkout.currencyCode, checkout.lineItems.length, event, checkout.lineItems, checkout.shippingLine?.price?.amount || 0, checkout.totalTax?.amount || 0 ); }); analytics.subscribe("product_added_to_cart", (event) => { const productRefId = event.data.cartLine.merchandise.product.id; const shop = event.context.window.location.host; const referral = getCookie(REFERRAL_COOKIE_NAME); if (!referral) return; // const params = { uid: getCookie(UID_COOKIE_NAME), deviceType: getDeviceType(), shop, campaignId: getCookie(CAMPAIGN_COOKIE_NAME), lsId: getCookie(LS_COOKIE_NAME), clientTs: new Date().toISOString(), experiment: getCookie(WIDGET_EXPERIMENT_COOKIE_NAME), referral: referral, productRefId: productRefId, pixel_version: PIXEL_VERSION }; const trackingUrl = `https://api.videowise.com/tracking/cart/pixel?${objectToQueryString( params )}`; fetch(trackingUrl).then((res) => { console.log( `Videowise pixel -- cart -- (version: ${PIXEL_VERSION}) executed correctly` ); }); }); analytics.subscribe("page_viewed", (event) => { if (!event.context.window.location.search.includes("videowise_campaign_id")) { console.log("Videowise no campaign cookie detected"); return; } const vars = new URLSearchParams(event.context.window.location.search); const campaignId = vars.get("videowise_campaign_id"); if (campaignId) { setSessionCookie(CAMPAIGN_COOKIE_NAME, campaignId); } }); ``` ## Related * [Pixel overview](/pixel/overview) * [Cookies](/cookies) * [Shoppable videos order tracking](/shoppable-videos/order-tracking) * [Live shopping order tracking](/live-shopping/order-tracking) # Analytics Source: https://docs.videowise.com/product-api/analytics Retrieve live shopping performance for a show by live stream ID. ## Base URL `https://api.videowise.com` All analytics endpoints require [authentication](/product-api/authentication). Rate limit: 100 requests per minute. *** ### Live shopping performance by lsId #### **GET** `/external/analytics/v1/live-streams/:lsId` Returns show metadata, host, and the six main live shopping KPIs, aggregated across live, replay, and referral channels. #### Headers | Key | Type | Required | Description | | - | - | - | - | | `X-Videowise-Access-Token` | String | Yes | Store license key. Same token as Product and Media. | #### Path parameters | Key | Type | Required | Description | | - | - | - | - | | `lsId` | String | Yes | Live stream ID. | #### Example request ```bash theme={null} curl -X GET "https://api.videowise.com/external/analytics/v1/live-streams/" \ -H "X-Videowise-Access-Token: " ``` #### Example response ```json theme={null} { "id": "507f1f77bcf86cd799439011", "name": "Fall show", "startedAt": "2026-09-21T12:00:00.000Z", "endedAt": "2026-09-21T13:05:00.000Z", "durationSeconds": 3900, "host": { "name": "Jane Host", "email": "jane@example.com" }, "kpis": { "sales": { "live": 10, "replay": 5, "total": 17 }, "orders": { "live": 3, "replay": 1, "total": 6 }, "viewers": { "live": 100, "replay": 40, "total": 140 }, "addToCart": { "live": 12, "replay": 8, "avg": 10 }, "avgViewTime": { "live": 60, "replay": 30, "avg": 45 }, "devices": [ { "device": "mobile", "value": 70 }, { "device": "desktop", "value": 25 }, { "device": "unknown", "value": 5 } ] } } ``` | Field | Description | | - | - | | `startedAt` | Show start time. | | `endedAt` | Start plus duration for ended/archived shows. `null` while the show is live. | | `host` | Host name and email when a host owner is set. Otherwise `null`. | | `kpis.sales` / `kpis.orders` | Live, replay, and `total` (live + replay + referral channels). | | `kpis.viewers` | Distinct viewers, live + replay. | | `kpis.addToCart` | Add-to-cart rate (%). | | `kpis.avgViewTime` | Average view time in seconds. | | `kpis.devices` | Device share (%). | #### Response | Status | Description | | - | - | | `200` | Analytics for the show. | | `401` | Missing or invalid access token. | | `404` | Live stream not found, or it does not belong to this store. | ## Related * [Authentication](/product-api/authentication) * [API overview](/product-api/overview) # Authentication Source: https://docs.videowise.com/product-api/authentication Learn how to authenticate with the Videowise API. All endpoints in the **Product API**, **Media API**, and **Analytics API** require authentication via an access token. Include the token in the headers of every request. See the [API overview](/product-api/overview) for the base URL, rate limits, and which endpoints to use. *** ## How to get your X-Videowise-Access-Token ## How to Authenticate 1. Obtain your access token from your Videowise account settings. Go to Settings -> Stores -> Click **View license key** 2. Include the token in the `X-Videowise-Access-Token` header of your request. > [!NOTE] > > `siteId` and `siteType` are deprecated and no longer required. They were > previously obtained from Settings → Stores → **Edit** and were passed in the > request body. Existing integrations that still send these fields will continue > to work. Example: ```plaintext theme={null} X-Videowise-Access-Token: ``` ## Error Responses If the token is missing or invalid, the API will return a **401 Unauthorized** error: ```JavaScript theme={null} { "message": "Missing X-Videowise-Access-Token header" } ``` ## Related * [API overview](/product-api/overview) * [Product](/product-api/product) * [Media](/product-api/media) * [Analytics](/product-api/analytics) # Media Source: https://docs.videowise.com/product-api/media Upload video and image files to associate with your Videowise content. ## Base URL `https://api.videowise.com` *** ### Upload Media #### **POST** `/external/media/v1` Uploads a video or image file to Videowise. #### Headers | Key | Type | Required | Description | | - | - | - | - | | `X-Videowise-Access-Token` | String | Yes | Access token to authorize the request. | #### Request Body The request must be sent as `multipart/form-data`. Authenticate with [X-Videowise-Access-Token](/product-api/authentication). | Field | Type | Required | Description | | - | - | - | - | | `fileContent` | File | Yes | The media file to upload. | #### File Limitations > [card] Video Files > > **Max size:** 50 MB > > **Supported formats:** > > * `.mp4` > * `.mov` > [card] Image Files > > **Max size:** 5 MB > > **Supported formats:** > > * `.jpeg` / `.jpg` > * `.webp` > * `.png` > * `.gif` > * `.avif` #### Example Request ```bash theme={null} curl -X POST https://api.videowise.com/external/media/v1 \ -H "X-Videowise-Access-Token: " \ -F "fileContent=@/path/to/your/video.mp4" ``` #### Response | Field | Type | Description | | - | - | - | | `id` | String | The unique identifier of the uploaded media. | | `url` | String | The URL of the uploaded media file. | ```json theme={null} { "id": "6a0ef7bd30cc5df396bf8bbf", "url": "https://cdn2.videowise.com/media/custom-videos/videos/1779365821653_wid_NmEwZWY3YmQzMGNjNWRmMzk2YmY4YmJm.mp4", "hostKey": "custom-videos/videos/1779365821653_wid_NmEwZWY3YmQzMGNjNWRmMzk2YmY4YmJm.mp4" } ``` | Status | Description | | - | - | | `200` | Media uploaded successfully. | | `400` | Bad request. File type or size is not supported. | | `401` | Unauthorized access. | *** ## Error Codes | Status | Description | | - | - | | `400` | Bad request. File type is not allowed or file exceeds the size limit. | | `401` | Unauthorized. Access token is missing or invalid. | *** ## Related * [Authentication](/product-api/authentication) * [Product](/product-api/product) * [API overview](/product-api/overview) # Overview Source: https://docs.videowise.com/product-api/overview Import products, upload media, and read live shopping analytics with the Videowise API. The Videowise API is for **catalog, media, and analytics** — not for embedding widgets or live shopping. For on-site embeds, start with [Shoppable videos](/shoppable-videos/overview) or [Live shopping](/live-shopping/overview). Use the Product API when you are not on Shopify (or need to sync a custom catalog) to import, retrieve, and delete products. Use the Media API to upload video and image files. Use the Analytics API to read live shopping performance by show. > [card] [Authentication](/product-api/authentication) > > Send `X-Videowise-Access-Token` on every request. > [card] [Product](/product-api/product) > > Bulk import, CSV import, retrieve, and delete products. > [card] [Media](/product-api/media) > > Upload video and image files. > [card] [Analytics](/product-api/analytics) > > Live shopping performance by show ID. ## Operations * **Bulk import** — import multiple products in a single request * **Single import** — import or modify one product * **Retrieve product** — fetch details by reference ID or SKU * **Delete product** — delete a product by reference ID or SKU * **Upload media** — upload a video or image file * **Live shopping analytics** — performance KPIs for a show by live stream ID ## Base URL All API requests use: ```plaintext theme={null} https://api.videowise.com ``` ## Limitations * **Product limit:** maximum of 10,000 products per request * **Rate limit:** 100 requests per minute ## Recommendations * Send bulk imports in smaller chunks to avoid timeouts, even though the maximum is 10,000 products per request * Prefer bulk import over many single-import requests ## Related * [Custom platforms](/shoppable-videos/custom-platforms) — embed widgets after the catalog is synced * [Shoppable videos](/shoppable-videos/overview) * [Live shopping](/live-shopping/overview) * [Analytics](/product-api/analytics) # Product Source: https://docs.videowise.com/product-api/product This API handles operations related to importing, retrieving, and deleting products in bulk or individually. ## Base URL `https://api.videowise.com` All product endpoints require [authentication](/product-api/authentication). For limits and when to use bulk vs single import, see the [API overview](/product-api/overview). *** ### Bulk Product Import #### **POST** `/external/product/v1/bulk` Imports or modifies list of products into the system. #### Headers | Key | Type | Required | Description | | - | - | - | - | | `X-Videowise-Access-Token` | String | Yes | Access token to authorize the request. | #### Request Body * **siteId** (string, deprecated): The site ID to associate with the products. * **siteType** (string, deprecated): The type of site to associate with the products. * **products** (array of **Product Object**, required): List of products to be imported. **Product Object**: | Field | Type | Required | Description | | - | - | - | - | | `id` | String | Yes | The unique identifier of the product. | | `sku` | String | Yes | The SKU of the product. | | `title` | String | Yes | The name of the product. | | `description` | String | No | The description of the product. | | `price` | Number | No | The price of the product. | | `price_min` | Number | No | The minimum price of the product. | | `price_max` | Number | No | The maximum price of the product. | | `available` | Boolean | Yes | Whether the product is available. | | `images` | \[String] | No | List of image URLs for the product. | | `featured_image` | String | Yes | The image URL of the product. | | `url` | String | Yes | The URL of the product. | #### Example Request ```json theme={null} { "siteId": "YourSiteID", "siteType": "Salesforce", "products": [ { "id": "008884303989", "sku": "008884303989", "title": "Platinum Blue Stripes Easy Care Fitted Shirt", "description": "An elegant fitted shirt with blue stripes.", "price": 35, "price_min": 35, "price_max": 35, "available": true, "images": ["https://example.com/image1.jpg"], "featured_image": "https://example.com/image1.jpg", "url": "https://example.com/product1" }, { "id": "008884303990", "sku": "008884303990", "title": "Test Shirt", "description": "A test product.", "price": 60, "available": true, "featured_image": "https://example.com/image2.jpg", "url": "https://example.com/product2" } ] } ``` #### Response | Status | Description | | - | - | | `200` | Products imported successfully. | | `400` | Bad request or site not found. | | `401` | Unauthorized access. | *** ### Bulk Product Import CSV #### **POST** `/external/product/v1/bulk/csv` Imports or modifies list of products into the system. #### Headers | Key | Type | Required | Description | | - | - | - | - | | `X-Videowise-Access-Token` | String | Yes | Access token to authorize the request. | #### Request Body * **siteId** (string, deprecated): The site ID to associate with the products. * **siteType** (string, deprecated): The type of site to associate with the products. * **csvContent** (string, required): CSV Content. **CSV Content**: The CSV content should be formatted as follows: * **First row**: Headers containing the field names (id, sku, title, description, price, price_min, price_max, available, images, featured_image, url) * **Following rows**: Product data corresponding to each **Product Object** field **CSV Format**: ``` id,sku,title,description,price,price_min,price_max,available,images,featured_image,url 008884303989,008884303989,Platinum Blue Stripes Easy Care Fitted Shirt,An elegant fitted shirt with blue stripes,35,35,35,true,https://example.com/image1.jpg,https://example.com/image1.jpg,https://example.com/product1 008884303990,008884303990,Test Shirt,A test product.,60,60,60,true,["https://example.com/image1.jpg","https://example.com/image2.jpg"],https://example.com/image1.jpg,https://example.com/product2 ``` **Field Requirements**: Same as the **Product Object** defined in the [Bulk Product Import](#bulk-product-import) section. **Notes**: * For single images use string format * For multiple images, use JSON array format: `[\"url1\",\"url2\"]` * Boolean values should be `true` or `false` * Ensure proper CSV escaping for fields containing commas or quotes #### Example Request ```json theme={null} { "siteId": "YourSiteID", "siteType": "Salesforce", "csvContent": "id,sku,title,description,price,price_min,price_max,available,images,featured_image,url\n008884303989,008884303989,Platinum Blue Stripes Easy Care Fitted Shirt,An elegant fitted shirt with blue stripes,35,35,35,true,https://example.com/image1.jpg,https://example.com/image1.jpg,https://example.com/product1\n008884303990,008884303990,Test Shirt,A test product.,60,60,60,true,[\"https://example.com/image1.jpg\",\"https://example.com/image2.jpg\"],https://example.com/image1.jpg,https://example.com/product2" } ``` #### Response | Status | Description | | - | - | | `200` | Products imported successfully. | | `400` | Bad request or site not found. | | `401` | Unauthorized access. | *** ### Single Product Import #### **POST** `/external/product/v1` Imports or modifies single product into the system. #### Headers | Key | Type | Required | Description | | - | - | - | - | | `X-Videowise-Access-Token` | String | Yes | Access token to authorize the request. | #### Request Body * **siteId** (string, deprecated): The site ID to associate with the product. * **siteType** (string, deprecated): The type of site to associate with the product. * **product** (**Product Object**, required): The product to be imported. **Product Object**: Same as defined in the [Bulk Product Import](#bulk-product-import) section. #### Example Request ```json theme={null} { "siteId": "YourSiteID", "siteType": "Magento", "product": { "id": "008884303989", "sku": "008884303989", "title": "Platinum Blue Stripes Easy Care Fitted Shirt", "description": "An elegant fitted shirt with blue stripes.", "price": 35, "price_min": 35, "price_max": 35, "available": true, "images": ["https://example.com/image1.jpg"], "featured_image": "https://example.com/image1.jpg", "url": "https://example.com/product1" } } ``` #### Response | Status | Description | | - | - | | `200` | Product imported successfully. | | `400` | Bad request or site not found. | | `401` | Unauthorized access. | *** ### Retrieve Product #### **GET** `/external/product/v1/:productId` Retrieves a product by its reference ID or SKU. #### Headers | Key | Type | Required | Description | | - | - | - | - | | `X-Videowise-Access-Token` | String | Yes | Access token to authorize the request. | #### Query Parameters | Parameter | Type | Required | Description | | - | - | - | - | | `siteId` | String | Deprecated | The site ID to search for. | | `siteType` | String | Deprecated | The site type to search for. | #### Example Request ```bash theme={null} GET /external/product/v1/008884303989?siteId=YourSiteID&siteType=Salesforce ``` #### Response | Field | Type | Description | | - | - | - | | `id` | String | The unique identifier of the product. | | `sku` | String | The SKU of the product. | | `title` | String | The name of the product. | | `featured_image` | String | The image URL of the product. | | `url` | String | The URL of the product. | ```json theme={null} { "id": "008884303989", "sku": "008884303989", "title": "Platinum Blue Stripes Easy Care Fitted Shirt", "featured_image": "https://example.com/image1.jpg", "url": "https://example.com/product1" } ``` | Status | Description | | - | - | | `200` | Product retrieved successfully. | | `400` | Bad request or product not found. | | `401` | Unauthorized access. | *** ### Delete Product #### **DELETE** `/external/product/v1/:productId` Deletes a product by its reference ID or SKU. #### Headers | Key | Type | Required | Description | | - | - | - | - | | `X-Videowise-Access-Token` | String | Yes | Access token to authorize the request. | #### Query Parameters | Parameter | Type | Required | Description | | - | - | - | - | | `siteId` | String | Deprecated | The site ID to search for. | | `siteType` | String | Deprecated | The site type to search for. | #### Example Request ```bash theme={null} DELETE /external/product/v1/008884303989?siteId=YourSiteID&siteType=Salesforce ``` #### Response | Field | Type | Description | | - | - | - | | `message` | String | Confirmation of product deletion. | ```json theme={null} { "message": "Product deleted successfully." } ``` | Status | Description | | - | - | | `200` | Product deleted successfully. | | `400` | Bad request or product could not be deleted. | | `401` | Unauthorized access. | *** ## Error Codes | Status | Description | | - | - | | `400` | Bad request. This occurs when required parameters or body fields are missing. | | `401` | Unauthorized. Access token is missing or invalid. | | `404` | Resource not found. Site or product does not exist. | *** ## Related * [Authentication](/product-api/authentication) * [Media](/product-api/media) * [API overview](/product-api/overview) * [Custom platforms](/shoppable-videos/custom-platforms) — embed widgets after products are imported # Floating Source: https://docs.videowise.com/sdk/floating Floating shoppable video overlay for React Native. > [!NOTE] > > `Inline`, `Floating`, and `VideoFeed` must be wrapped in ``. The Provider manages modal video state when a shopper taps a video. [`LiveShoppingChannel`](/sdk/live-shopping-channel) does not use the Provider. ```tsx theme={null} {/* Your components here */} ``` A floating widget overlay that appears at the bottom-left of the screen. It dynamically sizes itself based on the widget content. When a user taps on a video, a full-screen `VideoFeed` modal opens. ### Props | Prop | Type | Required | Default | Description | | - | - | - | - | - | | `videowiseInfo` | `object` | Yes | — | Store configuration (same as VideoFeed) | | `widgetId` | `string` | Yes | — | The ID of the Videowise widget | | `rightActionButtonsTop` | `number` | No | — | Top offset (px) for the right action buttons | | `marketingLogoTop` | `number` | No | — | Top offset (px) for the marketing logo | | `shoppableTop` | `number` | No | — | Top offset (px) for the shoppable product list | | `shoppableBottom` | `number` | No | — | Bottom padding (px) for shoppable UI | | `shoppableCardListBottom` | `number` | No | — | Bottom offset (px) for the shoppable card list | | `shoppableListAspectRatio` | `` `${number}/${number}` \| `"auto"` `` | No | — | Aspect ratio of product list items | | `loggedInUserData` | `{ email?: string; fullName?: string }` | No | — | Logged-in user info passed to the embed | | `onEvent` | `(event: OnEventType<'custom-event'>) => void` | No | — | Callback for custom events | | `onAddToCart` | `(event: OnEventType<'add-to-cart'>) => void` | No | — | Callback when a product is added to cart | | `onCheckout` | `(event: OnEventType<'custom-event'>) => void` | No | — | Callback for checkout events | | `environment` | `'local' \| 'staging' \| 'production'` | No | `'production'` | Environment target | #### `videowiseInfo` object | Property | Type | Required | Default | Description | | - | - | - | - | - | | `shop` | `string` | Yes | — | Your store domain (e.g. `storename.myshopify.com`) | | `cartType` | `'Shopify' \| 'Magento' \| 'SFCC' \| 'Tapcart' \| 'Other'` | No | `'Shopify'` | Cart platform type | | `currency` | `string` | No | `'USD'` | Display currency | | `currencyRate` | `number` | No | `1` | Currency conversion rate | | `productId` | `number \| null` | No | `null` | Filter by specific product ID | #### `onEvent` callback Triggered for all custom events from the widget. The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'custom-event'` | Event type identifier | | `detail` | `object` | Event detail payload (see below) | | `name` | `string` | Event name (see list below) | | `targetTag` | `null` | Reserved for future use | **`detail` object** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `variantId` | `number` | Variant ID | | `selectedVariant` | `number` | Selected variant ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code (e.g. `'USD'`) | | `videoTitle` | `string` | Video title | | `videoId` | `string` | Video ID | | `widgetId` | `string` | Widget ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | | `campaignId` | `string` | Campaign ID | | `items` | `array` | Array of products (see `onCheckout`) | > All `detail` properties are optional and depend on the event type. **Possible event names (`name`)** * `videowiseProductAddToCart` — Product added to cart * `videowiseProductBuyNow` — Buy now clicked * `videowiseCheckoutClick` — Checkout clicked * `videowiseProductClick` — Product clicked * `videowiseVideoClick` — Video clicked * `videowisePlayerOpen` — Player opened (full-screen or mini player) * `videowiseVideoStart` — Video played more than 3 seconds * `videowiseVideoIsPlaying` — Video is currently playing * `videowiseVideoFull` — Video played more than 80% * `videowiseVideoSwipe` — Video swiped * `videowisePlayerClose` — Player closed * `videowiseVideoSoundOn` — Sound turned on * `videowiseVideoSoundOff` — Sound turned off * `videowiseVideoBounce` — Video closed/swiped before 3 seconds * `videowiseDataReady` — Widget data loaded * `videowiseCampaignReady` — Campaign rendered * `videowiseCampaignCheckout` — Redirecting to checkout * `videowiseBackgroundV2Rendered` — Background V2 rendered * `videowiseCtaClick` — CTA button clicked * `videowiseTriggerPlayerClose` — Player close triggered #### `onAddToCart` callback Triggered when a user adds a product to the cart (`videowiseProductAddToCart` event). The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'add-to-cart'` | Event type identifier | | `detail` | `object` | Event detail payload | **`detail` object** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `variantId` | `number` | Variant ID | | `selectedVariant` | `number` | Selected variant ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code (e.g. `'USD'`) | | `videoTitle` | `string` | Video title | | `videoId` | `string` | Video ID | | `widgetId` | `string` | Widget ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | #### `onCheckout` callback Triggered when a user clicks checkout (`videowiseCheckoutClick` event). The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'custom-event'` | Event type identifier | | `detail` | `object` | Event detail payload | | `name` | `string` | Event name | | `targetTag` | `null` | Reserved for future use | **`detail` object** | Property | Type | Description | | - | - | - | | `campaignId` | `string` | Campaign ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | | `items` | `array` | Array of products in the checkout | **`items` array element** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code | ### Example ```tsx theme={null} console.log("onEvent", event)} onAddToCart={(event) => console.log("onAddToCart", event)} onCheckout={(event) => console.log("onCheckout", event)} /> ``` ## Related * [React Native SDK](/sdk/react-native) * [VideoFeed](/sdk/video-feed) * [Inline](/sdk/inline) * [Widget custom events](/shoppable-videos/custom-events) # getStoredData Source: https://docs.videowise.com/sdk/get-stored-data Read persisted Videowise user and live shopping IDs from app storage. `VideowiseSDK.getStoredData` reads persisted Videowise values from async storage (set automatically when SDK components run). Use it when you need access to these IDs outside of `trackingPixel` — for example custom analytics or deep linking. It is a plain async function and does not need to be called inside `VideowiseSDK.Provider`. These map to the web cookies `reeview_uid` and `reeview_lsid`. See [Cookies](/cookies). It returns `Promise`. Individual fields are `null` when missing or expired. Additional fields may be added to this object in future SDK versions. ### Return value (`StoredData`) | Property | Type | Description | | - | - | - | | `uid` | `string \| null` | Videowise user ID (`reeview_uid`). `null` if missing or expired | | `lsId` | `string \| null` | Live shopping session ID (`reeview_lsid`). `null` if missing or expired | ### Example ```jsx theme={null} import VideowiseSDK from "@videowisehq/videowise-react-native-sdk"; const { uid, lsId } = await VideowiseSDK.getStoredData(); ``` ## Related * [React Native SDK](/sdk/react-native) * [Tracking pixel (SDK)](/sdk/tracking-pixel) * [Cookies](/cookies) * [Live shopping](/live-shopping/overview) # Inline Source: https://docs.videowise.com/sdk/inline Inline shoppable video widgets for React Native. > [!NOTE] > > `Inline`, `Floating`, and `VideoFeed` must be wrapped in ``. The Provider manages modal video state when a shopper taps a video. [`LiveShoppingChannel`](/sdk/live-shopping-channel) does not use the Provider. ```tsx theme={null} {/* Your components here */} ``` An inline widget that embeds directly within the page flow. It starts with minimal height and dynamically expands as content loads, making it suitable for placing inside scrollable layouts. When a user taps on a video, a full-screen `VideoFeed` modal opens. ### Available Widget Types The following widget layouts are supported for the Inline component: * Single Video * In-Page Video Player * Quick Shop Carousel * Stories * Video Carousel * Highlighted Carousel * Overlapping Carousel * Scattered Videos * Masonry Grid * Grid Gallery * Floating * Gallery Highlight ### Props | Prop | Type | Required | Default | Description | | - | - | - | - | - | | `videowiseInfo` | `object` | Yes | — | Store configuration (same as VideoFeed) | | `widgetId` | `string` | Yes | — | The ID of the Videowise widget | | `rightActionButtonsTop` | `number` | No | — | Top offset (px) for the right action buttons | | `marketingLogoTop` | `number` | No | — | Top offset (px) for the marketing logo | | `shoppableTop` | `number` | No | — | Top offset (px) for the shoppable product list | | `shoppableBottom` | `number` | No | — | Bottom padding (px) for shoppable UI | | `shoppableCardListBottom` | `number` | No | — | Bottom offset (px) for the shoppable card list | | `shoppableListAspectRatio` | `` `${number}/${number}` \| `"auto"` `` | No | — | Aspect ratio of product list items | | `loggedInUserData` | `{ email?: string; fullName?: string }` | No | — | Logged-in user info passed to the embed | | `onEvent` | `(event: OnEventType<'custom-event'>) => void` | No | — | Callback for custom events | | `onAddToCart` | `(event: OnEventType<'add-to-cart'>) => void` | No | — | Callback when a product is added to cart | | `onCheckout` | `(event: OnEventType<'custom-event'>) => void` | No | — | Callback for checkout events | | `environment` | `'local' \| 'staging' \| 'production'` | No | `'production'` | Environment target | #### `videowiseInfo` object | Property | Type | Required | Default | Description | | - | - | - | - | - | | `shop` | `string` | Yes | — | Your store domain (e.g. `storename.myshopify.com`) | | `cartType` | `'Shopify' \| 'Magento' \| 'SFCC' \| 'Tapcart' \| 'Other'` | No | `'Shopify'` | Cart platform type | | `currency` | `string` | No | `'USD'` | Display currency | | `currencyRate` | `number` | No | `1` | Currency conversion rate | | `productId` | `number \| null` | No | `null` | Filter by specific product ID | #### `onEvent` callback Triggered for all custom events from the widget. The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'custom-event'` | Event type identifier | | `detail` | `object` | Event detail payload (see below) | | `name` | `string` | Event name (see list below) | | `targetTag` | `null` | Reserved for future use | **`detail` object** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `variantId` | `number` | Variant ID | | `selectedVariant` | `number` | Selected variant ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code (e.g. `'USD'`) | | `videoTitle` | `string` | Video title | | `videoId` | `string` | Video ID | | `widgetId` | `string` | Widget ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | | `campaignId` | `string` | Campaign ID | | `items` | `array` | Array of products (see `onCheckout`) | > All `detail` properties are optional and depend on the event type. **Possible event names (`name`)** * `videowiseProductAddToCart` — Product added to cart * `videowiseProductBuyNow` — Buy now clicked * `videowiseCheckoutClick` — Checkout clicked * `videowiseProductClick` — Product clicked * `videowiseVideoClick` — Video clicked * `videowisePlayerOpen` — Player opened (full-screen or mini player) * `videowiseVideoStart` — Video played more than 3 seconds * `videowiseVideoIsPlaying` — Video is currently playing * `videowiseVideoFull` — Video played more than 80% * `videowiseVideoSwipe` — Video swiped * `videowisePlayerClose` — Player closed * `videowiseVideoSoundOn` — Sound turned on * `videowiseVideoSoundOff` — Sound turned off * `videowiseVideoBounce` — Video closed/swiped before 3 seconds * `videowiseDataReady` — Widget data loaded * `videowiseCampaignReady` — Campaign rendered * `videowiseCampaignCheckout` — Redirecting to checkout * `videowiseBackgroundV2Rendered` — Background V2 rendered * `videowiseCtaClick` — CTA button clicked * `videowiseTriggerPlayerClose` — Player close triggered #### `onAddToCart` callback Triggered when a user adds a product to the cart (`videowiseProductAddToCart` event). The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'add-to-cart'` | Event type identifier | | `detail` | `object` | Event detail payload | **`detail` object** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `variantId` | `number` | Variant ID | | `selectedVariant` | `number` | Selected variant ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code (e.g. `'USD'`) | | `videoTitle` | `string` | Video title | | `videoId` | `string` | Video ID | | `widgetId` | `string` | Widget ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | #### `onCheckout` callback Triggered when a user clicks checkout (`videowiseCheckoutClick` event). The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'custom-event'` | Event type identifier | | `detail` | `object` | Event detail payload | | `name` | `string` | Event name | | `targetTag` | `null` | Reserved for future use | **`detail` object** | Property | Type | Description | | - | - | - | | `campaignId` | `string` | Campaign ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | | `items` | `array` | Array of products in the checkout | **`items` array element** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code | ### Example ```tsx theme={null} console.log("onEvent", event)} onAddToCart={(event) => console.log("onAddToCart", event)} onCheckout={(event) => console.log("onCheckout", event)} /> ``` ## Related * [React Native SDK](/sdk/react-native) * [VideoFeed](/sdk/video-feed) * [Floating](/sdk/floating) * [Widget custom events](/shoppable-videos/custom-events) # Live Shopping Channel Source: https://docs.videowise.com/sdk/live-shopping-channel Embed the live shopping channel in React Native, including modular layout and Picture-in-Picture. Install the SDK first. See [React Native SDK](/sdk/react-native). A full-screen live shopping channel component that embeds the Videowise live streaming experience. It renders a WebView with the live shopping channel and dispatches typed live-shopping events for user interactions like adding products to cart. > **Note:** The `LiveShoppingChannel` component does **not** need to be wrapped inside ``. It operates independently. ### Props | Prop | Type | Required | Default | Description | | - | - | - | - | - | | `videowiseInfo` | `object` | Yes | — | Store configuration (see below) | | `lsId` | `string` | No | — | Live shopping ID (for autostart) | | `offsetY` | `number` | No | `0` | Reduces the height of the component wrapper by `screenHeight - offsetY` | | `playerTopOffset` | `number` | No | — | Top offset (px) for the Live Player component elements | | `playerBottomOffset` | `number` | No | — | Bottom offset (px) for the Live Player component elements | | `vwStyle` | `string` | No | — | Custom CSS injected into the live shopping embed. On web, use `videowiseInfo.lsPlayerCustomStyle` instead — see [lsPlayerCustomStyle](/shoppable-videos/custom-platforms#lsplayercustomstyle). | | `channelBodyHtml` | `string` | No | monolith mount | Optional HTML for the WebView `` (overrides default monolith) | | `enabledPipButton` | `boolean` | No | `true` | Show the PiP button in the live shopping player (`window.vwEnabledPipButton`) | | `style` | `StyleProp` | No | — | Custom style overrides for the component wrapper | | `loggedInUserData` | `{ email?: string; fullName?: string }` | No | — | Logged-in user info passed to the embed | | `onEvent` | `(event: OnEventType<'live-shopping'>) => void` | No | — | Callback for live shopping events | | `onAddToCart` | `(event: OnEventType<'add-to-cart'>) => void` | No | — | Callback when a product is added to cart | | `onCheckout` | `(event: OnEventType<'live-shopping'>) => void` | No | — | Callback for checkout events | | `environment` | `'local' \| 'staging' \| 'production'` | No | `'production'` | Environment target | #### `videowiseInfo` object | Property | Type | Required | Default | Description | | - | - | - | - | - | | `shop` | `string` | Yes | — | Your store domain (e.g. `storename.myshopify.com`) | | `vwHostOwnerId` | `string` | No | — | When set, filters channel **live / upcoming** and **past** lists to that host only (multi-host shops) | | `customCart` | `boolean` | No | — | When `true`, Shop Now skips Shopify Ajax and the in-player cart never opens. Handle `onAddToCart` and `show_cart` on `onEvent`. See [customCart](/live-shopping/custom-events#customcart). | #### `onEvent` callback Triggered for all live shopping interaction events. The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'live-shopping'` | Event type identifier | | `detail` | `object` | Event detail payload (see below) | **`detail` object (`LSTrackingEventData`)** | Property | Type | Required | Description | | - | - | - | - | | `lsId` | `string` | Yes | Live shopping session ID | | `siteId` | `string` | Yes | Site ID | | `organisationId` | `string` | Yes | Organisation ID | | `clientTS` | `Date` | Yes | Client timestamp | | `videoElapsedMinutes` | `number` | Yes | Minutes elapsed in the video | | `videoElapsedSeconds` | `number` | Yes | Seconds elapsed in the video | | `currentTime` | `number` | No | Current playback time | | `uid` | `string` | Yes | Unique user ID | | `device` | `'mobile' \| 'desktop'` | Yes | Device type | | `isLive` | `boolean` | Yes | Whether the stream is currently live | | `url` | `string` | Yes | Page URL | | `interactionType` | `string` | Yes | Interaction type (see list below) | | `eventType` | `string` | Yes | Host event type: `'play'`, `'pause'`, `'stop'`, `'load'`, `'pending'`, `'interaction'` | | `item` | `object` | No | Product data (present for `add_to_cart` and `product_click` interactions) | **`item` object (when present)** | Property | Type | Description | | - | - | - | | `name` | `string` | Product name | | `sku` | `string` | Product SKU | | `id` | `string` | Product ID | | `highlighted` | `boolean` | Whether the product is highlighted | | `meta.customId` | `string` | Custom variant ID | | `meta.vendor` | `string` | Product vendor | | `meta.price` | `number \| string` | Product price | | `meta.compareAtPrice` | `unknown` | Compare at price | | `meta.quantity` | `number` | Quantity | | `meta.currency` | `string` | Currency code | **Possible interaction types (`interactionType`)** * `mute_player` — Player muted * `unmute_player` — Player unmuted * `pause_player` — Player paused * `resume_player` — Player resumed * `like_reaction` — Like reaction * `share` — Share clicked * `add_to_calendar` — Added to calendar * `send_chat` — Chat message sent * `close_player` — Player closed * `minimize_player` — Player minimized * `maximize_player` — Player maximized * `show_product_list` — Product list shown * `hide_product_list` — Product list hidden * `product_click` — Product clicked * `add_to_cart` — Product added to cart. Not sent when `videowiseInfo.customCart` is `true`; use `videowiseProductAddToCart` / `onAddToCart` instead. * `checkout` — Checkout clicked * `show_cart` — Cart icon tapped. When `videowiseInfo.customCart` is `true`, the in-player virtual cart does not open — handle this on `onEvent` to show your own cart. When `customCart` is omitted, this fires as the in-player cart opens. * `hide_cart` — In-player cart hidden. Not sent when `videowiseInfo.customCart` is `true`. * `toggle_cc_on` — Closed captions enabled * `toggle_cc_off` — Closed captions disabled * `replay` — Replay clicked * `progress` — Playback progress #### `onAddToCart` callback Triggered when a user adds a product to the cart (`add_to_cart` interaction). The product data is unified into a standard format. The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'add-to-cart'` | Event type identifier | | `detail` | `object` | Unified product payload | **`detail` object** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `variantId` | `number` | Variant ID | | `selectedVariant` | `number` | Selected variant ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code | #### `onCheckout` callback Triggered when a user clicks checkout. The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'live-shopping'` | Event type identifier | | `detail` | `object` | `LSTrackingEventData` payload (same structure as `onEvent` detail) | ### Example ```tsx theme={null} console.log("onEvent", event.detail.interactionType, event) } onAddToCart={(event) => console.log("onAddToCart", event.detail)} onCheckout={(event) => console.log("onCheckout", event)} /> ``` To filter the channel to one host, set `videowiseInfo.vwHostOwnerId` (same field as on web). See [Filter shows by host](/live-shopping/channel-layout#filter-shows-by-host-vwhostownerid). See the full list of live shopping events: [Live shopping custom events](/live-shopping/custom-events) ### Custom channel body / modular section layout By default the WebView body is a single monolith mount: ```html theme={null}
``` Pass `channelBodyHtml` to replace that body content and use [modular channel sections](/live-shopping/channel-layout) with your own HTML between mounts. Omit `#videowise_stream_channel` when using sections — the monolith container takes precedence and section mounts are ignored. ```tsx theme={null}

Upcoming

Past shows

`} /> ``` Mount ids: `videowise_stream_channel_hero`, `videowise_stream_channel_livenow`, `videowise_stream_channel_upcoming`, `videowise_stream_channel_past`, optional `videowise_stream_channel_shared`. See [Live channel page layout](/live-shopping/channel-layout) for the full web embed contract (same mount ids on the web and in the RN WebView body). ### Live player and mini player From SDK version 3.0.0, tapping a show opens the live player in its own view drawn at the root of your app, above every screen, instead of a native modal. * When the viewer taps a cart icon or the chevron, the player shrinks into a floating mini player (132x224, the same size as on web). Your app stays usable behind it, so your cart and screens can open while the show keeps playing. The `show_cart` event still fires so you can open your cart. * The mini player can be dragged and snaps to the left or right side, at the top, middle or bottom, like the web player. Tapping it brings the player back to full screen; its X closes the player. * On Android, the back button closes the full-screen player. While the player is minimized, back belongs to your app. To minimize or expand the player from your own code, use [`changePlayerSize`](/sdk/change-player-size). > [!WARNING] > > To draw above every screen, the SDK registers a root wrapper with `AppRegistry.setWrapperComponentProvider` when it is imported. This replaces a wrapper provider your app set before. Apps with several root views (for example `react-native-navigation`), or apps that load the SDK after startup, fall back to showing the player inside the channel. The player is drawn below your app's native modals. ### Picture-in-Picture (PiP) When a user taps PiP inside the live shopping WebView, the SDK: 1. Receives a `PIP_ENTER` message from the embed with the HLS stream URL, `lsId`, and playback position 2. Swaps the WebView for a native `react-native-video` player and enters system PiP 3. On PiP exit, remounts the WebView with the same `lsId` so the embed reloads the stream; for **recordings**, also writes playback position to session storage so the web player can seek on resume 4. On iOS, automatically calls `VwAppMinimizer.minimize()` when PiP becomes active (if the host app implements the native module) Android typically backgrounds the app automatically when PiP starts. #### Setup in your app **1. Install peer dependencies** ```bash theme={null} npm install react-native-video cd ios && pod install && cd .. ``` **2. Render `LiveShoppingChannel`** No extra PiP wiring is needed in JS — just render the component: ```tsx theme={null} import VideowiseSDK from "@videowisehq/videowise-react-native-sdk"; export function LiveShoppingScreen() { return ( console.log(event)} onAddToCart={(event) => console.log(event)} /> ); } ``` Pass `lsId` to open a specific stream on first load: ```tsx theme={null} ``` Disable the PiP button if needed (enabled by default): ```tsx theme={null} ``` **3. iOS — `Info.plist`** Add background audio so PiP playback continues when the app is backgrounded: ```xml theme={null} UIBackgroundModes audio ``` **4. Android — `AndroidManifest.xml`** Enable PiP on your main activity: ```xml theme={null} ``` **5. Optional — iOS `VwAppMinimizer` (host app native module)** iOS has no public API to programmatically send the app to the background. The SDK calls `VwAppMinimizer.minimize()` automatically when PiP becomes active on iOS. Implement this native module in **your host app** (not in the SDK npm package) to enable auto-minimize. > **App Store note:** the example below uses a private API (`UIApplication.suspend`). Use only if your team accepts that trade-off. `ios/YourApp/VwAppMinimizer.swift`: ```swift theme={null} import UIKit import React @objc(VwAppMinimizer) class VwAppMinimizer: NSObject { @objc static func requiresMainQueueSetup() -> Bool { true } @objc func minimize() { DispatchQueue.main.async { UIApplication.shared.perform(Selector(("suspend"))) } } } ``` `ios/YourApp/VwAppMinimizer.m`: ```objc theme={null} #import @interface RCT_EXTERN_MODULE(VwAppMinimizer, NSObject) RCT_EXTERN_METHOD(minimize) @end ``` **Register the files in your Xcode project** Creating the files is not enough — they must be registered in your app target so Xcode compiles them. You can do this in Xcode or by editing `project.pbxproj` directly (useful if you manage the iOS project as code). *Option A — Xcode UI* 1. Open `ios/YourApp.xcworkspace` in Xcode 2. Right-click your app folder (same group as `AppDelegate.swift`) → **Add Files to "YourApp"...** 3. Select `VwAppMinimizer.swift` and `VwAppMinimizer.m` 4. Ensure your app target is checked under **Add to targets** *Option B — Edit `project.pbxproj`* 1. Place both files in `ios/YourApp/` next to `AppDelegate.swift` 2. Open `ios/YourApp.xcodeproj/project.pbxproj` 3. Generate four unique IDs (run `uuidgen` four times, remove dashes, uppercase) 4. Add entries following the same pattern as `AppDelegate.swift`: ```text theme={null} /* PBXBuildFile — add to PBXBuildFile section */ SWIFT_BUILD_ID /* VwAppMinimizer.swift in Sources */ = {isa = PBXBuildFile; fileRef = SWIFT_FILE_ID /* VwAppMinimizer.swift */; }; OBJC_BUILD_ID /* VwAppMinimizer.m in Sources */ = {isa = PBXBuildFile; fileRef = OBJC_FILE_ID /* VwAppMinimizer.m */; }; /* PBXFileReference — add to PBXFileReference section */ SWIFT_FILE_ID /* VwAppMinimizer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = VwAppMinimizer.swift; path = YourApp/VwAppMinimizer.swift; sourceTree = ""; }; OBJC_FILE_ID /* VwAppMinimizer.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = VwAppMinimizer.m; path = YourApp/VwAppMinimizer.m; sourceTree = ""; }; ``` 5. Add `SWIFT_FILE_ID` and `OBJC_FILE_ID` to your app's `PBXGroup` `children` array (same group that lists `AppDelegate.swift`) 6. Add `SWIFT_BUILD_ID` and `OBJC_BUILD_ID` to `PBXSourcesBuildPhase` → `files` array (Compile Sources) Replace `YourApp` with your iOS app folder name. Use the code blocks above for the file contents and mirror how `AppDelegate.swift` is registered in your `project.pbxproj`. If `VwAppMinimizer` is not registered, the SDK safely skips minimization — PiP still works. **6. Install the SDK in your app and rebuild** Install from npm in your React Native project (not a local `file:` link): ```bash theme={null} npm install @videowisehq/videowise-react-native-sdk react-native-webview @react-native-async-storage/async-storage react-native-video cd ios && pod install && cd .. npx react-native run-ios # physical iPhone/iPad required for PiP npx react-native run-android ``` #### Testing notes | Platform | Notes | | - | - | | iOS (physical device) | **Required** for PiP testing | | iOS Simulator | PiP does not work — `isPictureInPictureSupported()` returns false | | Android | PiP works on supported devices; app usually backgrounds automatically | The floating PiP window always shows **system playback controls** (play/pause, close). Those cannot be removed by the SDK. #### WebView → native PiP protocol The live shopping embed sends this message when the user requests PiP: ```json theme={null} { "request": "PIP_ENTER", "payload": { "lsId": "live-shopping-stream-id", "url": "https://your-cdn.example.com/live/stream.m3u8", "startTime": 142.5 } } ``` | Field | Required | Description | | - | - | - | | `lsId` | Yes | Used to restore the correct stream when PiP ends | | `url` | Yes | HLS (`.m3u8`) live stream URL | | `startTime` | No | Playback position in seconds where native PiP should start | #### Native PiP → WebView resume When PiP ends, the SDK remounts the WebView with `window.lsId` set so the embed auto-loads the same stream. For **recordings** (not live streams), the SDK also writes the native player's current playback time to session storage: ```js theme={null} sessionStorage.getItem("reeview_ls_session_recording_time"); // e.g. '{"time":187.4,"lsId":"live-shopping-stream-id"}' ``` The embed reads this key on init for recordings only, parses `{ time, lsId }`, and seeks the web player to resume from that position. Live streams do not use this key — they resume at the live edge. ## Related * [React Native SDK](/sdk/react-native) * [Live shopping](/live-shopping/overview) * [Channel page layout](/live-shopping/channel-layout) * [Live shopping custom events](/live-shopping/custom-events) * [Order tracking](/live-shopping/order-tracking) * [Tracking pixel (SDK)](/sdk/tracking-pixel) * [changePlayerSize](/sdk/change-player-size) # React Native SDK Source: https://docs.videowise.com/sdk/react-native Install the Videowise React Native SDK and choose components for shoppable video and live shopping. The Videowise React Native SDK embeds shoppable video widgets and live shopping in a mobile app. ```bash theme={null} npm install @videowisehq/videowise-react-native-sdk react-native-webview @react-native-async-storage/async-storage ``` For **Live Shopping Picture-in-Picture**, also install `react-native-video` (>= 6.0.0) and run `pod install` in your `ios/` folder. Setup is on [Live Shopping Channel](/sdk/live-shopping-channel#picture-in-picture-pip). Web embeds, events, and cookies: * [Shoppable videos](/shoppable-videos/overview) * [Live shopping](/live-shopping/overview) * [Order tracking pixel](/pixel/overview) (web); use [`trackingPixel`](/sdk/tracking-pixel) in the app * [Cookies](/cookies) — [`getStoredData`](/sdk/get-stored-data) returns the same `uid` / `lsId` values > [card] [Live Shopping Channel](/sdk/live-shopping-channel) > > Channel embed, modular layout, and Picture-in-Picture. > [card] [VideoFeed](/sdk/video-feed) > > Full-screen shoppable video player. > [card] [Floating](/sdk/floating) > > Overlay widget that opens VideoFeed on tap. > [card] [Inline](/sdk/inline) > > Stories, carousels, grids, and other in-flow widgets. > [card] [Tracking pixel](/sdk/tracking-pixel) > > Attribute orders after checkout. Live-show orders from the app count as MOBILE APP, not ON SITE. > [card] [getStoredData](/sdk/get-stored-data) > > Read persisted `uid` and `lsId` from app storage. > [card] [changePlayerSize](/sdk/change-player-size) > > Minimize the live player or bring it back to full screen from your app. ## SDK surface ```ts theme={null} interface VideowiseSDKProps { Provider: React.FC; Inline: React.FC; Floating: React.FC; VideoFeed: React.FC; LiveShoppingChannel: React.FC; trackingPixel: (parameters: ParametersType) => Promise; getStoredData: () => Promise; changePlayerSize: (size: PlayerSize) => void; } ``` Event callbacks use discriminated unions via `OnEventType`: | Callback | Type parameter | `event.type` | `event.detail` | | - | - | - | - | | `onEvent` (widgets) | `'custom-event'` | `'custom-event'` | `EventDetailType` + `name: EventType` | | `onEvent` (Live Shopping) | `'live-shopping'` | `'live-shopping'` | `LSTrackingEventData` | | `onAddToCart` | `'add-to-cart'` | `'add-to-cart'` | `EventDetailType` | | `onCheckout` | `'custom-event'` or `'live-shopping'` | matches component | matches component | Widget `onEvent` names match [Widget custom events](/shoppable-videos/custom-events). Live shopping `onEvent` payloads match [Live shopping custom events](/live-shopping/custom-events). ### Shared props Available on `Inline`, `Floating`, `VideoFeed`, and `LiveShoppingChannel`: | Prop | Type | Required | Default | Description | | - | - | - | - | - | | `environment` | `'local' \| 'staging' \| 'production'` | No | `'production'` | Environment target | | `loggedInUserData` | `{ email?: string; fullName?: string }` | No | — | Logged-in user info passed to the embed | | `onEvent` | `(event: OnEventType) => void` | No | — | Callback for custom events (`T` depends on component) | | `onAddToCart` | `(event: OnEventType<'add-to-cart'>) => void` | No | — | Callback when a product is added to cart | | `onCheckout` | `(event: OnEventType) => void` | No | — | Callback for checkout events | > [!NOTE] > > `Inline`, `Floating`, and `VideoFeed` must be wrapped in ``. [`LiveShoppingChannel`](/sdk/live-shopping-channel) does not. ```tsx theme={null} {/* Your components here */} ``` ## Related * [Shoppable videos](/shoppable-videos/overview) * [Live shopping](/live-shopping/overview) * [Order tracking pixel](/pixel/overview) * [Cookies](/cookies) # Tracking pixel Source: https://docs.videowise.com/sdk/tracking-pixel Send order data to Videowise after checkout in a React Native app. `VideowiseSDK.trackingPixel` is an async function that sends order data to Videowise analytics after a successful checkout. Call it once per completed order, after order confirmation. It is a plain async function and does not need to be rendered inside `VideowiseSDK.Provider`. On the web, the equivalent is the [order tracking pixel](/pixel/overview). When a stored live shopping session ID (`lsId`) is present, the order request must include `referral`. `VideowiseSDK.trackingPixel` sets it automatically. It is not a `trackingPixel` argument. A custom mobile pixel has to send the same value. Live Shopping add-to-cart uses it on `/tracking/cart/pixel` as well. `referral` is that object, URL-encoded: ```json theme={null} { "vw_referral_channel": "mobile_app", "vw_source_id": "", "vw_user_identifier": "" } ``` `vw_source_id` is the live stream id (`reeview_lsid`). `vw_user_identifier` is the Videowise user id (`reeview_uid`). With `referral` empty, the order is stored but not attributed to **MOBILE APP**. It returns `Promise`. The resolved value is `null` when the SDK has no stored user identifier, when a required parameter is missing, or when the request throws. ### Parameters `trackingPixel(params)` takes a single object with the following properties: | Property | Type | Required | Description | | - | - | - | - | | `shop` | `string` | Yes | Store domain (e.g. `storename.myshopify.com`) | | `orderId` | `number` | Yes | Numeric order ID | | `orderTotal` | `number` | Yes | Total order amount | | `orderCurrency` | `string` | Yes | ISO currency code (e.g. `USD`) | | `orderItems` | `OrderItem[]` | Yes | Array of purchased items (see below) | | `shippingCosts` | `number` | No | Shipping amount. Sent as `shipping_costs`. Defaults to `0` | | `taxAmount` | `number` | No | Tax amount. Sent as `tax_amount`. Defaults to `0` | #### `orderItems` element (`OrderItem`) | Property | Type | Description | | - | - | - | | `id` | `string` | Line item ID | | `quantity` | `number` | Quantity purchased | | `title` | `string \| null` | Line item title | | `variant` | `object` | Variant details (see below) | | `finalLinePrice` | `object` | Final line price (see below) | | `discountAllocations` | `DiscountAllocation[]` | Optional. Discount shares on this line (see below) | `finalLinePrice` is the line total **before** discount allocations — typically `variant.price.amount * quantity`, matching Shopify checkout line items. Do not pre-subtract discounts. Pass Shopify `discountAllocations` on the line; Videowise subtracts them. Allocations whose `discountApplication.targetType` is `SHIPPING_LINE` are ignored. **`variant` object** | Property | Type | Description | | - | - | - | | `id` | `string` | Variant ID | | `image.src` | `string \| null` | Variant image URL | | `price.amount` | `number` | Variant unit price | | `price.currencyCode` | `string` | Variant price currency code | | `product.id` | `string` | Product ID | | `product.title` | `string \| null` | Product title | | `product.vendor` | `string \| null` | Product vendor | | `product.type` | `string \| null` | Product type | | `product.untranslatedTitle` | `string \| null` | Untranslated product title | | `product.url` | `string` | Product URL | | `sku` | `string \| null` | Variant SKU | | `title` | `string` | Variant title | | `untranslatedTitle` | `string` | Untranslated variant title | **`finalLinePrice` object** | Property | Type | Description | | - | - | - | | `amount` | `number` | Line total before discount allocations | | `currencyCode` | `string` | Final line price currency | **`discountAllocations` element** | Property | Type | Description | | - | - | - | | `amount.amount` | `number` | Discount share on this line | | `amount.currencyCode` | `string` | Currency of that share | | `discountApplication.allocationMethod` | `string` | Shopify allocation method | | `discountApplication.targetSelection` | `string` | Shopify target selection | | `discountApplication.targetType` | `string` | `LINE_ITEM` or `SHIPPING_LINE` | | `discountApplication.title` | `string \| null` | Discount title | | `discountApplication.type` | `string` | Discount type | | `discountApplication.value` | `{ percentage: number }` or `{ amount, currencyCode }` | Discount value | ### Example ```jsx theme={null} import VideowiseSDK from "@vidystar/videowise-react-native-sdk"; await VideowiseSDK.trackingPixel({ shop: "storename.myshopify.com", orderId: 12345, orderTotal: 99.99, orderCurrency: "USD", shippingCosts: 5, taxAmount: 8.25, orderItems: [ { id: "item-1", quantity: 1, title: "Product Name", variant: { id: "variant-1", image: { src: "https://..." }, price: { amount: 99.99, currencyCode: "USD" }, product: { id: "prod-1", title: "Product Name", vendor: "Vendor", type: "Type", untranslatedTitle: "Product Name", url: "https://...", }, sku: "SKU-123", title: "Variant", untranslatedTitle: "Variant", }, finalLinePrice: { amount: 99.99, currencyCode: "USD" }, discountAllocations: [ { amount: { amount: 10, currencyCode: "USD" }, discountApplication: { allocationMethod: "ACROSS", targetSelection: "ALL", targetType: "LINE_ITEM", title: "LIVE10", type: "DISCOUNT_CODE", value: { percentage: 10 }, }, }, ], }, ], }); ``` ## Related * [React Native SDK](/sdk/react-native) * [Order tracking pixel (web)](/pixel/overview) * [getStoredData](/sdk/get-stored-data) * [Cookies](/cookies) * [Shoppable videos order tracking](/shoppable-videos/order-tracking) * [Live shopping order tracking](/live-shopping/order-tracking) # VideoFeed Source: https://docs.videowise.com/sdk/video-feed Full-screen shoppable video player for React Native. > [!NOTE] > > `Inline`, `Floating`, and `VideoFeed` must be wrapped in ``. The Provider manages modal video state when a shopper taps a video. [`LiveShoppingChannel`](/sdk/live-shopping-channel) does not use the Provider. ```tsx theme={null} {/* Your components here */} ``` A full-screen video feed component that displays a single video with shopping capabilities. The video player is shown immediately upon render. ### Props | Prop | Type | Required | Default | Description | | - | - | - | - | - | | `videowiseInfo` | `object` | Yes | — | Store configuration (see below) | | `widgetId` | `string` | Yes | — | The ID of the Videowise widget | | `style` | `StyleProp` | No | — | Custom style overrides for the component wrapper | | `videoId` | `string` | No | `''` | Specific video ID to display | | `rightActionButtonsTop` | `number` | No | `7` | Top offset (px) for the right action buttons (close, etc.) | | `marketingLogoTop` | `number` | No | `20` | Top offset (px) for the marketing logo | | `shoppableTop` | `number` | No | `0` | Top offset (px) for the shoppable product list | | `shoppableBottom` | `number` | No | `16` / `20` | Bottom padding (px) for shoppable UI | | `shoppableCardListBottom` | `number` | No | `0` | Bottom offset (px) for the shoppable card list | | `shoppableListAspectRatio` | `` `${number}/${number}` \| `"auto"` `` | No | `"1/1"` | Aspect ratio of product list items | | `disableIndependentApiCall` | `boolean` | No | `true` | Disables independent API calls | | `loggedInUserData` | `{ email?: string; fullName?: string }` | No | — | Logged-in user info passed to the embed | | `onEvent` | `(event: OnEventType<'custom-event'>) => void` | No | — | Callback for custom events | | `onAddToCart` | `(event: OnEventType<'add-to-cart'>) => void` | No | — | Callback when a product is added to cart | | `onCheckout` | `(event: OnEventType<'custom-event'>) => void` | No | — | Callback for checkout events | | `environment` | `'local' \| 'staging' \| 'production'` | No | `'production'` | Environment target | #### `videowiseInfo` object | Property | Type | Required | Default | Description | | - | - | - | - | - | | `shop` | `string` | Yes | — | Your store domain (e.g. `storename.myshopify.com`) | | `cartType` | `'Shopify' \| 'Magento' \| 'SFCC' \| 'Tapcart' \| 'Other'` | No | `'Shopify'` | Cart platform type | | `currency` | `string` | No | `'USD'` | Display currency | | `currencyRate` | `number` | No | `1` | Currency conversion rate | | `productId` | `number \| null` | No | `null` | Filter by specific product ID | #### `onEvent` callback Triggered for all custom events from the widget. The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'custom-event'` | Event type identifier | | `detail` | `object` | Event detail payload (see below) | | `name` | `string` | Event name (see list below) | | `targetTag` | `null` | Reserved for future use | **`detail` object** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `variantId` | `number` | Variant ID | | `selectedVariant` | `number` | Selected variant ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code (e.g. `'USD'`) | | `videoTitle` | `string` | Video title | | `videoId` | `string` | Video ID | | `widgetId` | `string` | Widget ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | | `campaignId` | `string` | Campaign ID | | `items` | `array` | Array of products (see `onCheckout`) | > All `detail` properties are optional and depend on the event type. **Possible event names (`name`)** * `videowiseProductAddToCart` — Product added to cart * `videowiseProductBuyNow` — Buy now clicked * `videowiseCheckoutClick` — Checkout clicked * `videowiseProductClick` — Product clicked * `videowiseVideoClick` — Video clicked * `videowisePlayerOpen` — Player opened (full-screen or mini player) * `videowiseVideoStart` — Video played more than 3 seconds * `videowiseVideoIsPlaying` — Video is currently playing * `videowiseVideoFull` — Video played more than 80% * `videowiseVideoSwipe` — Video swiped * `videowisePlayerClose` — Player closed * `videowiseVideoSoundOn` — Sound turned on * `videowiseVideoSoundOff` — Sound turned off * `videowiseVideoBounce` — Video closed/swiped before 3 seconds * `videowiseDataReady` — Widget data loaded * `videowiseCampaignReady` — Campaign rendered * `videowiseCampaignCheckout` — Redirecting to checkout * `videowiseBackgroundV2Rendered` — Background V2 rendered * `videowiseCtaClick` — CTA button clicked * `videowiseTriggerPlayerClose` — Player close triggered #### `onAddToCart` callback Triggered when a user adds a product to the cart (`videowiseProductAddToCart` event). The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'add-to-cart'` | Event type identifier | | `detail` | `object` | Event detail payload | **`detail` object** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `variantId` | `number` | Variant ID | | `selectedVariant` | `number` | Selected variant ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code (e.g. `'USD'`) | | `videoTitle` | `string` | Video title | | `videoId` | `string` | Video ID | | `widgetId` | `string` | Widget ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | #### `onCheckout` callback Triggered when a user clicks checkout (`videowiseCheckoutClick` event). The event object has the following structure: | Property | Type | Description | | - | - | - | | `type` | `'custom-event'` | Event type identifier | | `detail` | `object` | Event detail payload | | `name` | `string` | Event name | | `targetTag` | `null` | Reserved for future use | **`detail` object** | Property | Type | Description | | - | - | - | | `campaignId` | `string` | Campaign ID | | `deviceType` | `string` | Device type | | `url` | `string` | Page URL | | `items` | `array` | Array of products in the checkout | **`items` array element** | Property | Type | Description | | - | - | - | | `productName` | `string` | Product name | | `productId` | `number` | Product ID | | `qty` | `number` | Quantity | | `price` | `number` | Product price | | `currencyCode` | `string` | Currency code | ### Example ```tsx theme={null} console.log("onEvent", event)} onAddToCart={(event) => console.log("onAddToCart", event)} onCheckout={(event) => console.log("onCheckout", event)} /> ``` ## Related * [React Native SDK](/sdk/react-native) * [Floating](/sdk/floating) * [Inline](/sdk/inline) * [Widget custom events](/shoppable-videos/custom-events) * [Tracking pixel (SDK)](/sdk/tracking-pixel) # Custom events Source: https://docs.videowise.com/shoppable-videos/custom-events Listen for playback, product, and checkout events from Videowise widgets. Widget events are dispatched on `window`. Use `window.addEventListener` to intercept them. These events are for **shoppable video widgets**. Live shopping uses a different set — see [Live shopping custom events](/live-shopping/custom-events). On React Native, the same widget events arrive through `onEvent` on SDK components — see [VideoFeed](/sdk/video-feed), [Floating](/sdk/floating), and [Inline](/sdk/inline). ```javascript Code Block Example theme={null} window.addEventListener("videowiseVideoClick", (event) => { // Your code here }); ``` ```javascript Code Block Example theme={null} window.addEventListener("videowiseVideoClick", (event) => { console.log("videowiseVideoClick executed"); console.log(event.detail); // return Data from event }); ``` ## Events ### videowiseProductAddToCart Triggered when a user adds a product to the cart. * productName * productId * variantId * selectedVariant * qty * price * currencyCode * videoTitle * videoId * widgetId * deviceType * url ### videowiseVideoClick Triggered when a user clicks on a video. * videoTitle * videoId * widgetId * deviceType * url ### videowisePlayerOpen Triggered when the video player opens — either the full-screen player, or the inline mini player used by floating widgets. * videoTitle * videoId * widgetId * deviceType * url ### videowiseVideoStart Triggered when a video played more than 3 seconds. * videoTitle * videoId * widgetId * deviceType * url ### videowiseVideoFull Triggered when played more than 80% of the video. * videoTitle * videoId * widgetId * deviceType * url ### videowiseVideoSwipe Triggered when a user swipes a video. * videoTitle * videoId * widgetId * deviceType * url ### videowisePlayerClose Triggered when a user closes the player. * videoTitle * videoId * widgetId * deviceType * url ### videowiseVideoSoundOn Triggered when a user turns on the sound of the video. * videoTitle * videoId * widgetId * deviceType * url ### videowiseVideoSoundOff Triggered when a user turns off the sound of the video. * videoTitle * videoId * widgetId * deviceType * url ### videowiseProductClick Triggered when a user clicks on a shoppable product. * productId * productName * videoTitle * videoId * widgetId * deviceType * url ### videowiseProductBuyNow Triggered when a user clicks on the buy now button of a shoppable product. * productId * productName * variantId * selectedVariant * qty * price * currencyCode * videoTitle * videoId * widgetId * deviceType * url ### videowiseVideoBounce Triggered when a user close/swipe the video without playing it, noted video played less than 3 seconds. * videoTitle * videoId * widgetId * deviceType * url ### videowiseDataReady Triggered when the widget has all the necessary data and is ready for rendering * widgetIds * deviceType * url ### videowiseCampaignReady Triggered after campaign rendered * campaignId * deviceType * url ### videowiseCampaignCheckout Triggered before redirecting the user to the Shopify checkout page * campaignId * deviceType * url * items \[array] * productName * productId * qty * price * currencyCode ### videowiseCtaClick Triggered when a user clicks on a call to action button. * videoTitle * videoId * widgetId * deviceType * buttonClicked (text in the button) * url ### videowiseCheckoutClick Triggered when a user clicks the checkout button on the cart. * products \[array] * productId * productName * variantId * selectedVariant * qty * price * currencyCode * videoTitle * videoId * widgetId * deviceType * url ### videowiseExpandedProducts Triggered when a user expands the shoppable products list on an inline widget. `event.detail` is an array (`product[]`) containing the expanded products. ## Related * [Custom platforms](/shoppable-videos/custom-platforms) — handle `videowiseProductAddToCart` with your own cart * [Widget re-rendering](/shoppable-videos/re-rendering) * [Live shopping custom events](/live-shopping/custom-events) * [VideoFeed](/sdk/video-feed), [Floating](/sdk/floating), [Inline](/sdk/inline) * [Order tracking](/shoppable-videos/order-tracking) * [Cookies](/cookies) # Working with custom platforms Source: https://docs.videowise.com/shoppable-videos/custom-platforms Learn how to integrate Videowise on non-Shopify platforms, headless Shopify, and custom storefronts. Integrating Videowise on custom platforms has two parts: 1. **Script initialization** — adding Videowise scripts to your website 2. **Widget locations** — setting where you want widgets to appear This guide covers script setup via `window.videowiseInfo`, and how to handle add-to-cart on headless or custom storefronts. For Shopify Online Store, the Videowise app injects scripts for you — skip to [custom events](/shoppable-videos/custom-events) or [widget re-rendering](/shoppable-videos/re-rendering) only if you need them. > [!NOTE] > > Use `window.videowiseInfo` on all non-Shopify platforms (SFCC, Magento, WooCommerce) and on headless Shopify. ## Setting up `videowiseInfo` ### Minimum implementation To add scripts to your website, insert the following code before the closing `` tag: ```html theme={null} ``` ### Populating `videowiseInfo` correctly | Field | Notes | | - | - | | `shop` | Must be set to the correct `myshopify.com` domain. For the live channel this (or `host` / `Shopify.shop`) is what loads show lists. | | `cartType` | Required on non-Shopify / headless. Possible values: `shopify`, `magento`, `sfcc`, `tapcart`, `other`. On classic Shopify Online Store it is auto-detected. | | `currency` | Store currency (e.g. `USD`). Recommended for live shopping; defaults to `USD` if omitted. | | `currencyRate` | Optional; defaults to `'1'`. | | `pid` | Product ID when rendering a product page; `null` or `''` on non-product pages (shoppable widgets) | | `locale` | Current locale the customer is navigating | | `route` | Equivalent to `window.Shopify.routes.root` when available. For a URL like `myshopify.com/en`, use `"/en/"`; otherwise fall back to `"/"` | | `host` | Optional alias for shop identity (`shop` alone is enough for the channel) | | `vwHostOwnerId` | Optional. When set on a live channel page, filters **active / upcoming** and **past** lists to that host only. See [Filter shows by host](/live-shopping/channel-layout#filter-shows-by-host-vwhostownerid). | | `forceDomain` | Optional. When `true`, live shopping Shopify Ajax uses `https://{host or shop}` instead of relative URLs. See [forceDomain](#forcedomain). | | `lsPlayerCustomStyle` | Optional. Live shopping only. CSS string injected into the live player iframe. See [lsPlayerCustomStyle](#lsplayercustomstyle). | | `channelCustomStyle` | Optional. Video channel only. CSS string injected into the channel embed (into the shadow root when shadow DOM is enabled). See [channelCustomStyle](#channelcustomstyle). | ### `forceDomain` By default, live shopping Shopify Ajax calls (`/products/{handle}.js`, `/cart/add.js`, `/cart.json`) use **relative** URLs, so they hit the current page origin. On headless or custom domains that origin may not serve Shopify Ajax. Set `forceDomain: true` on `window.videowiseInfo` **before** the live shopping script so those requests go to `https://{videowiseInfo.host || videowiseInfo.shop}` instead: ```html theme={null} ``` The player copies this flag into the live iframe with the rest of `videowiseInfo`. It is also on automatically in the React Native webview and Videowise preview. Absolute URLs already passed into the player are left unchanged. ### `lsPlayerCustomStyle` Set a CSS string on `window.videowiseInfo.lsPlayerCustomStyle` **before** the live shopping script. When the live player iframe opens, that CSS is appended as a `