Flutter SDK Integration — Legacy (Shoppable Ads)

注記

This guide is for the Legacy Rokt SDK (rokt_sdk). For new integrations, we recommend the Flutter SDK+ Integration guide which uses SDK+.

This guide covers how to integrate Shoppable Ads into your Flutter app using the Legacy Rokt SDK. Shoppable Ads enable post-purchase upsell offers with in-app catalog browsing and instant checkout (via Apple Pay or Stripe) — all within the Rokt placement.

For the general Rokt Flutter SDK reference, see the Flutter SDK documentation.

注記

Shoppable Ads in Flutter are currently supported on iOS only.

Prerequisites

• iOS 15.0+ deployment target
• rokt_sdk 5.x
• RoktStripePaymentExtension CocoaPods pod (required for Apple Pay / Stripe payment processing)
• A Rokt account with Shoppable Ads enabled — contact your Rokt account manager

Step 1: Install dependencies

Flutter

Add the Rokt SDK to your pubspec.yaml:

pubspec.yaml

dependencies:
  rokt_sdk: ^5.0.0

Then run:

flutter pub get

iOS native (Podfile)

Add the Stripe payment extension to your ios/Podfile:

ios/Podfile

pod 'RoktStripePaymentExtension', '~> 0.1'

Then install the pods:

cd ios && pod install

Step 2: Initialize the SDK

SDK initialization is the same as for standard placements. See Integrating and initializing the Flutter SDK.

Step 3: Configure Apple Pay

Before registering a payment extension, you need to create an Apple Pay merchant ID, configure your Xcode project, and generate a Payment Processing Certificate.

Follow the steps in Apple Pay — iOS setup, then return here to register the payment extension.

Step 4: Register a payment extension (native)

After configuring Apple Pay, set up the payment extension factory in your native iOS code. This enables Apple Pay and Stripe payment processing within the placement.

ios/Runner/AppDelegate.swift

import RoktStripePaymentExtension
import rokt_sdk

// In application(_:didFinishLaunchingWithOptions:), after GeneratedPluginRegistrant.register:
SwiftRoktSdkPlugin.paymentExtensionFactory = { type, config in
    switch type {
    case "stripe":
        guard let merchantId = config["applePayMerchantId"] else { return nil }
        return RoktStripePaymentExtension(
            applePayMerchantId: merchantId,
            countryCode: config["countryCode"] ?? "US"
        )
    default:
        return nil
    }
}

注記

For the Legacy SDK path, you must provide your Stripe publishable key explicitly in the config dictionary when calling registerPaymentExtension from Dart (Step 5).

Step 5: Register payment extension from Dart

Register the payment extension from Dart after initialize and before selectShoppableAds:

import 'package:rokt_sdk/rokt_sdk.dart';

RoktSdk.registerPaymentExtension(
  extensionType: 'stripe',
  config: {
    'stripeKey': 'YOUR_STRIPE_PUBLISHABLE_KEY',
    'applePayMerchantId': 'merchant.com.yourapp.rokt',
  },
);

注意

You must call registerPaymentExtension after SDK initialization (Step 2) and before calling selectShoppableAds (Step 6) from your Dart code. If no payment extension is registered, selectShoppableAds will fire a PlacementFailure event.

Step 6: Display Shoppable Ads

Shoppable Ads always display as an overlay — no embedded views or placeholders are needed.

Call selectShoppableAds from your Dart code once all required attributes are available:

import 'package:rokt_sdk/rokt_sdk.dart';

final attributes = {
  "email": "j.smith@example.com",
  "firstname": "Jane",
  "lastname": "Smith",
  "confirmationref": "ORD-8829-XK2",
  "amount": "52.25",
  "currency": "USD",
  "paymenttype": "visa",
  "shippingaddress1": "123 Main St",
  "shippingcity": "Brooklyn",
  "shippingstate": "NY",
  "shippingzipcode": "11201",
  "shippingcountry": "US",
};

RoktSdk.selectShoppableAds(
  viewName: "ConfirmationPage",
  attributes: attributes,
);

Step 7: Handle events

Shoppable Ads emit the following events in addition to the standard placement events. Subscribe to events using the RoktEvents EventChannel:

import 'package:flutter/services.dart';

final EventChannel roktEventChannel = EventChannel('RoktEvents');

roktEventChannel.receiveBroadcastStream().listen((dynamic event) {
  switch (event["event"]) {
    case "CartItemInstantPurchaseInitiated":
      debugPrint("Purchase started: ${event["catalogItemId"]}");
      break;
    case "CartItemInstantPurchase":
      debugPrint("Purchase completed: ${event["catalogItemId"]} — ${event["totalPrice"]} ${event["currency"]}");
      break;
    case "CartItemInstantPurchaseFailure":
      debugPrint("Purchase failed: ${event["error"]}");
      break;
    case "CartItemDevicePay":
      debugPrint("Device payment triggered: ${event["paymentProvider"]}");
      break;
    case "InstantPurchaseDismissal":
      debugPrint("User dismissed purchase");
      break;
    case "PlacementClosed":
      debugPrint("Shoppable Ads placement closed");
      break;
    default:
      break;
  }
});

Shoppable Ads events

Event	Description	Properties
CartItemInstantPurchaseInitiated	Purchase flow started — user tapped "Buy"	identifier, catalogItemId, cartItemId
CartItemInstantPurchase	Purchase completed successfully	identifier, cartItemId, catalogItemId, currency, description, linkedProductId, quantity, totalPrice, unitPrice
CartItemInstantPurchaseFailure	Purchase failed	identifier, catalogItemId, cartItemId, error
CartItemDevicePay	Apple Pay / device payment triggered	identifier, catalogItemId, cartItemId, paymentProvider
InstantPurchaseDismissal	User dismissed the purchase overlay	identifier

Recommended attributes

The following attributes are particularly important for Shoppable Ads:

Attribute	Type	Required	Description
email	string	Yes	Customer email (unhashed). Used for order confirmation.
confirmationref	string	Yes	Order or transaction reference number.
amount	string	Recommended	Decimal transaction amount (e.g., "52.25").
currency	string	Recommended	ISO 4217 currency code (e.g., "USD").
paymenttype	string	Recommended	Payment method used for the primary purchase (e.g., "visa", "apple_pay"). Used for payment method prioritization.
shippingaddress1	string	Recommended	Shipping street address.
shippingcity	string	Recommended	Shipping city.
shippingstate	string	Recommended	Shipping state or province.
shippingzipcode	string	Recommended	Shipping postal code.
shippingcountry	string	Recommended	ISO Alpha-2 country code (e.g., "US").

For the full list of supported attributes, see the recommended attributes table.

注記

If your platform does not have shipping address details (e.g., ticket or digital goods purchases), pass billing address details instead. Rokt will provide a UI for the customer to confirm or edit their shipping address before completing the purchase.

Payment methods

For detailed setup of individual payment methods, see:

• Apple Pay — Native Apple Pay within the Rokt placement
• Card Forwarding — Reuse the customer's vaulted card from the primary purchase