@adcp/sdk API Reference - v7.9.0
    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 {
        adcp_major_version?: number;
        offering_id: string;
        intent?: string;
        context?: ContextObject;
        include_products?: boolean;
        product_limit?: number;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version? offering_id intent? context? include_products? product_limit? ext?

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    offering_id: string

    Offering identifier from the catalog to get details for

    intent?: string

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

    context?: ContextObject
    include_products?: boolean

    Whether to include matching products in the response

    product_limit?: number

    Maximum number of matching products to return

    1

    50

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties