@adcp/client API Reference - v3.11.2
    Preparing search index...

    Interface SIGetOfferingRequest

    Get offering details and availability before session handoff. Returns offering information, availability status, and optionally matching products based on context.

    interface SIGetOfferingRequest {
        offering_id: string;
        context?: string;
        include_products?: boolean;
        product_limit?: number;
        ext?: ExtensionObject;
    }
    Index

    Properties

    offering_id context? include_products? product_limit? ext?

    Properties

    offering_id: string

    Offering identifier from promoted offerings to get details for

    context?: string

    Optional natural language context about user intent for personalized results (e.g., 'mens size 14 near Cincinnati'). Must be anonymous - no PII.

    include_products?: boolean

    Whether to include matching products in the response

    product_limit?: number

    Maximum number of matching products to return

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties