pCon.basket - Integration
    Preparing search index...

    Interface HostGetCustomCatalogArticlesMessage

    Will be send to request the articles of a custom catalog. A wbk.customCatalogArticles message has to be send back to the basket. Note: Will not be called for external catalogs.

    interface HostGetCustomCatalogArticlesMessage {
        parameter: {
            baseArticleNumber?: string;
            catalogId?: string;
            language: string[];
            maxResults: number;
            queryString?: string;
            seriesId?: string;
        };
        type: "wbkHost.getCustomCatalogArticles";
    }

    Hierarchy (View Summary)

    Index
    parameter: {
        baseArticleNumber?: string;
        catalogId?: string;
        language: string[];
        maxResults: number;
        queryString?: string;
        seriesId?: string;
    }

    Type Declaration

    • OptionalbaseArticleNumber?: string

      If provided, the base article number of the returned aticles should match the provided base article number.

    • OptionalcatalogId?: string

      Id of the catalog. If undefined articles from all available catalogs should be returned.

    • language: string[]

      The requested language for the catalog data in order of priority.

    • maxResults: number

      The maxium number of results the query should return.

    • OptionalqueryString?: string

      Search string for the query to perfom a full text search.

    • OptionalseriesId?: string

      If provided, the series id of the returned aticles should match the provided series id.

    type: "wbkHost.getCustomCatalogArticles"