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

    Interface SIGetOfferingResponse

    Offering details, availability status, and optionally matching products. Use the offering_token in si_initiate_session for correlation.

    interface SIGetOfferingResponse {
        available: boolean;
        offering_token?: string;
        ttl_seconds?: number;
        checked_at?: string;
        offering?: {
            offering_id?: string;
            title?: string;
            summary?: string;
            tagline?: string;
            expires_at?: string;
            price_hint?: string;
            image_url?: string;
            landing_url?: string;
        };
        matching_products?: {
            product_id: string;
            name: string;
            price?: string;
            original_price?: string;
            image_url?: string;
            availability_summary?: string;
            url?: string;
        }[];
        total_matching?: number;
        unavailable_reason?: string;
        alternative_offering_ids?: string[];
        errors?: Error[];
        ext?: ExtensionObject;
    }
    Index

    Properties

    available offering_token? ttl_seconds? checked_at? offering? matching_products? total_matching? unavailable_reason? alternative_offering_ids? errors? ext?

    Properties

    available: boolean

    Whether the offering is currently available

    offering_token?: string

    Token to pass to si_initiate_session for session continuity. Brand stores the full query context server-side (products shown, order, context) so they can resolve references like 'the second one' when the session starts.

    ttl_seconds?: number

    How long this offering information is valid (seconds). Host should re-fetch after TTL expires.

    checked_at?: string

    When this offering information was retrieved

    offering?: {
        offering_id?: string;
        title?: string;
        summary?: string;
        tagline?: string;
        expires_at?: string;
        price_hint?: string;
        image_url?: string;
        landing_url?: string;
    }

    Offering details

    Type Declaration

    • Optionaloffering_id?: string

      Offering identifier

    • Optionaltitle?: string

      Offering title

    • Optionalsummary?: string

      Brief summary of the offering

    • Optionaltagline?: string

      Short promotional tagline

    • Optionalexpires_at?: string

      When this offering expires

    • Optionalprice_hint?: string

      Price indication (e.g., 'from $199', '50% off')

    • Optionalimage_url?: string

      Hero image for the offering

    • Optionallanding_url?: string

      Landing page URL

    matching_products?: {
        product_id: string;
        name: string;
        price?: string;
        original_price?: string;
        image_url?: string;
        availability_summary?: string;
        url?: string;
    }[]

    Products matching the request context. Only included if include_products was true.

    Type Declaration

    • product_id: string

      Product identifier

    • name: string

      Product name

    • Optionalprice?: string

      Display price (e.g., '$129', '$89.99')

    • Optionaloriginal_price?: string

      Original price if on sale

    • Optionalimage_url?: string

      Product image

    • Optionalavailability_summary?: string

      Brief availability info (e.g., 'In stock', 'Size 14 available', '3 left')

    • Optionalurl?: string

      Product detail page URL

    total_matching?: number

    Total number of products matching the context (may be more than returned in matching_products)

    unavailable_reason?: string

    If not available, why (e.g., 'expired', 'sold_out', 'region_restricted')

    alternative_offering_ids?: string[]

    Alternative offerings to consider if this one is unavailable

    errors?: Error[]

    Errors during offering lookup

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties