Tracking pixel - Videowise

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. 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:

{
  "vw_referral_channel": "mobile_app",
  "vw_source_id": "<lsId>",
  "vw_user_identifier": "<uid>"
}

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<Response | null>. 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

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 },
          },
        },
      ],
    },
  ],
});

​Parameters

​orderItems element (OrderItem)

​Example

​Related

Parameters

`orderItems` element (`OrderItem`)

Example

Related