Home > @vsf-enterprise/sap-commerce-webservices-sdk > ComponentApi > searchComponentsByIds

ComponentApi.searchComponentsByIds() method

Given a list of component identifiers in body, return cms component data. Get components' data by id given in body

Signature:

searchComponentsByIds(baseSiteId: string, componentIdList: ComponentIDList, catalogCode?: string, categoryCode?: string, currentPage?: number, fields?: 'BASIC' | 'DEFAULT' | 'FULL', pageSize?: number, productCode?: string, sort?: string, options?: any): Promise<import("axios").AxiosResponse<ListAdaptedComponents>>;

Parameters

Parameter Type Description
baseSiteId string Base site identifier
componentIdList ComponentIDList List of Component identifiers
catalogCode string Catalog code
categoryCode string Category code
currentPage number Optional pagination parameter. Default value 0.
fields 'BASIC' | 'DEFAULT' | 'FULL' Response configuration (list of fields, which should be returned in response)
pageSize number Optional pagination parameter. Default value 10.
productCode string Product code
sort string Optional sort criterion. No default value.
options any Override http request option.

Returns:

Promise<import("axios").AxiosResponse<ListAdaptedComponents>>

Exceptions

{RequiredError} ComponentApi