Search for products using an Elasticsearch query and scroll.

post

https://api.bluestonepim.com/search/products/scroll/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

archiveState

string

enum

Archive state.

Allowed:

Body Params

pageSize

int32

required

scrollId

string

column

string

enum

Allowed:

sortDirection

string

enum

Allowed:

attributeIdToSortBy

string

typeFilter

object

typesFilter

object

productCreateDateFilter

array of objects

productCreateDateFilter

productCreateDateRelativeFilter

array of objects

productCreateDateRelativeFilter

productLastUpdateFilter

array of objects

productLastUpdateFilter

productLastUpdateRelativeFilter

array of objects

productLastUpdateRelativeFilter

baseFilters

array of objects

baseFilters

publishStateFilter

object

validationStatusFilter

object

attributeFilters

array of objects

attributeFilters

labelFilters

array of objects

labelFilters

relationsFilter

object

assetFilters

array of objects

assetFilters

variantFilters

array of objects

variantFilters

bundleFilters

array of objects

bundleFilters

categoryFilters

array of objects

categoryFilters

scoreFilter

object

scoreRequirementResultFilters

array of objects

scoreRequirementResultFilters

outOfSyncFilter

object

lastSyncStateFilter

object

Headers

context

string

Defaults to en

Specifies the context in which to operate. If omitted, the default context en is used.

In Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: The default context is identified by the ID "en". IDs for additional contexts begin with a lowercase "L", not with the digit "1", followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.

context-fallback

boolean

Specifies whether to enable the fallback mechanism for the context. If omitted, the default value true will be used. When set to true, the system will provide a default translation or relevant information if the requested context's specific translation is missing.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: Setting the context-fallback parameter to false disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing.

Responses

200OK

400Bad Request This response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.