Interface StartLiveNotificationInput

Parameters for starting a new order tracking live notification. This creates a new live notification on the user's device.

Platform Support: iOS 16.2+ only. On other platforms, the method will throw an error.

interface StartLiveNotificationInput {
    orderId: string;
    orderIdDisplayText: string;
    storeName: string;
    status: OrderStatusInfo;
    message: string;
    estimatedTime?: string;
}

Properties

orderId orderIdDisplayText storeName status message estimatedTime?

Properties

orderId

orderId: string

Required: Unique identifier for the order. Used to update or end this specific live notification.

orderIdDisplayText

orderIdDisplayText: string

Required: Display text for the order identifier shown in the live notification (e.g., "Order #ORD-12345").

storeName

storeName: string

Required: Name of the store or merchant handling the order.

status

status: OrderStatusInfo

Required: Current status information for the order.

message

message: string

Required: Human-readable message describing the current order state.

OptionalestimatedTime

estimatedTime?: string

Optional: Estimated time remaining for the next status change (e.g., "30 min", "15 minutes").

Settings

Member Visibility

On This Page

Properties