Product search API

Some composable configurators functionality require that users would be prevented with a choice of products:

• A sectional furniture configurator that presents a set of available sectional pieces

• Room configurator

• Electronics configurations

In those cases a configurator can use product search API to retrieve a list of compatible products.

Target URL

The product search API endpoint uses the following format:

/api/v2/blueprint/tagged/{styleCodes}/{versionId}/{siteIds}?tags=<list of tags>

Method

The product search API requests shall be done using GET HTTP method.

Inbound payload

The product search API is product-specific and will only return products compatible and scope by the current configuration. The available products list is validated using joints configuration.

The search parameters are provided using query string tags parameter, which should consist of a comma-separated list of tags to filter products by.

Response payload

The response payload consists of a JSON array that provides a list of product details. Each product record includes:

• styleCode — Product style code.

• name — Product name.

• tags — A complete list of product tags.

• description — Product description.

• custom — A set of essential product custom attributes.