Interface UpdateLiveNotificationInput

Parameters for updating an existing order tracking live notification. Updates the live notification on the user's lock screen / Dynamic Island (iOS) or status bar chip / lock screen (Android).

Platform Support: iOS 16.2+ and Android 16 (API 36)+. On unsupported platforms, the method will throw an error.

interface UpdateLiveNotificationInput {
    estimatedTime?: string;
    message: string;
    orderId: string;
    status: OrderStatusInfo;
}

Properties

estimatedTime? message orderId status

Properties

OptionalestimatedTime

estimatedTime?: string

Optional: Updated estimated time remaining.

message

message: string

Required: Updated message describing the current order state.

orderId

orderId: string

Required: Order identifier matching the one used when starting the live notification.

status

status: OrderStatusInfo

Required: Updated status information for the order.

Settings

Member Visibility

On This Page

Properties