react-native-firework-sdk
    Preparing search index...

    Interface TrackPurchaseParameters

    interface TrackPurchaseParameters {
        additionalInfo?: { [key: string]: string };
        countryCode?: string;
        currencyCode?: string;
        orderId: string;
        products?: PurchaseProduct[];
        shippingPrice?: number;
        subtotal?: number;
        totalDiscounts?: number;
        value?: number;
    }
    Index

    Properties

    additionalInfo?: { [key: string]: string }

    Any additional information associated to the purchase. Reserved keys: order_id, order_value, value, currency, country, shipping_price, subtotal, total_discounts, line_items, product. Any values passed in the additionalInfo that use a reserved key will be ignored.

    countryCode?: string

    The country code of the purchase.

    currencyCode?: string

    The ISO 4217 currency code of the purchase value.

    Required for Shopping V2 purchase tracking parity with Web.

    orderId: string

    A unique identifier for the user's order. Required.

    products?: PurchaseProduct[]

    The purchased items of the order. Sent as line_items.

    Required (non-empty) for Shopping V2 purchase tracking parity with Web.

    shippingPrice?: number

    The shipping price of the order.

    subtotal?: number

    The items cost before discounts, taxes, and shipping.

    Required for Shopping V2 purchase tracking parity with Web.

    totalDiscounts?: number

    The total discounts applied to the order. Sent as total_discounts.

    value?: number

    The final amount paid, including taxes, shipping, and discounts. Sent as order_value.

    Required for Shopping V2 purchase tracking parity with Web.