Execute the search query.

get

https://api-us.bluestonepim.com/search/find

Query Params

context

string

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.

query

string

Search query.

searchableFields

array of strings

List of searchable fields with optional field boosting Format: <field_name>[:<field_boosting>] Available fields: PRODUCT_NAME, PRODUCT_DESCRIPTION, PRODUCT_NUMBER, PRODUCT_ATTRIBUTES

searchableFields

archiveState

string

enum

Defaults to ACTIVE

Archive state.

Allowed:

highlight

boolean

Enable or disable highlighting.

fragmentSize

int32

0 to 1000

Defaults to 20

The size of the highlighted fragment in characters.

fuzziness

string

enum

Defaults to AUTO

The fuzziness maximum edit distance.

Allowed:

page

int32

≥ 0

Defaults to 0

Page to be returned.

pageSize

int32

1 to 1000

Defaults to 10

Number of items to be returned.

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.