@avvyr/storefront-sdk - v0.19.0
    Preparing search index...

    Interface CreateAssistantConversationParams

    interface CreateAssistantConversationParams {
        cart?: { id: string; token?: string | null } | null;
        context?: AssistantContext;
        continueFrom?: { conversationId: string; token: string };
        locale?: string;
        pageUrl?: string;
        timeZone?: string;
        visitorId?: string;
    }
    Index
    cart? context? continueFrom? locale? pageUrl? timeZone? visitorId?
    cart?: { id: string; token?: string | null } | null

    The shopper's cart, so the staff see it with the conversation. token is the cart access token (sent as x-cart-token); leave it out when it is already set on the client.

    context?: AssistantContext

    Where the shopper is when the conversation starts.

    continueFrom?: { conversationId: string; token: string }

    Continue a conversation that was closed for being too long (closedReason: "turn_limit"): its verified order, contact and recent messages come along. Needs that conversation's token.

    locale?: string

    The shopper's language, e.g. "sv" or "en-GB".

    pageUrl?: string

    The page the chat was opened on (absolute http(s) URL).

    timeZone?: string

    IANA time zone. Defaults to the browser's; a signed-in customer without one gets it.

    visitorId?: string

    The pseudonymous visitor id (the avvyr_visitor cookie), so the shop's staff see where the shopper is on the site. Send it ONLY when the visitor has consented to statistics/analytics.

    Settings
    Member Visibility

    On This Page
    Properties