Skip to main content

product search

About endpoint Product Search*

The Product Search API enables you to obtain product information through keyword search and filtering based on specific attributes. You can conduct the search across the entire PIMS system or within a specific category, depending on your needs. With this API, you can easily retrieve details about products that match your search criteria and filter them based on desired attributes. This allows you to efficiently access the relevant information and use it to enhance your applications or services.

When performing a search, the following product attribute characteristics should be considered:

  • For a Search, the isSearchable parameter must be set to 'y'.
  • To search by attribute values, the isFilterable parameter must have the value 'y'.

The Product Search API endpoints for each product contain detailed information about the product, its variants, their corresponding attributes, and values. The data returned by the endpoints includes:

  • A definition object that provides complete information about the structure of each attribute in the PIMS system.

  • *found_in_categories: an array where each entry represents a separate category object in which the products were found.

  • *found_total: the number of products found.

  • *search_phrase: the search term in the URI parameter {searchWord}

  • *filters: the collection of cat_filters objects belonging to the categories in which the products were found.

    *returned only if products are found

✔All endpoints for the Product Search API offer sorting and pagination parameters for convenient navigation and finding relevant information.

✔All API endpoints utilize the ApiView header parameter (optional), which represents the View name from the PIM's view Dictionary

✔If the ApiView parameter is not passed (or wrongly set), data is returned according to the default View defined for the access group (for ApiKey Authorization).

Conditions for setting the ApiView parameter:

  • The View must be defined for the access group (for ApiKey Authorization).
  • If the access group has pim_manager or pim_security permissions, access is granted to the entire PIM's view Dictionary.