Search products

Applies search filters in the catalog to retrieve one or more products that satisfy the search filter criteria provided in the parameters and the request body. To filter out a product you can use the following facets/search criteria.

  • Product Type(E.g., Equipment or service)
  • Family(E.g., Software or hardware)
  • Configuration Type(E.g., Standalone or bundle)
  • A custom multi-picklist field called AdminAuto_CustomMultiPicklistField_c(E.g., Bundle1, Bundle 2)

Please note that the search filter that you are passing must be associated with the category ID on which you are performing the search.

This API also does multiple search criteria to filter out the product, it considers one or more of the conditions using AND/OR association.For example, to search within the family facet (Software or hardware) the facet value will only take the OR logic.But to search products across the Family facet and Product Type facet, the AND logic will be applicable.This API also sorts records in ascending order and applies pagination on the retrieved result.

Pass the Pricelist ID and Category ID in the header and select the Search Type in the query parameters to call this API.When you pass a specific Category ID, the search filters will be applied to all products associated with that specific category ID.When you pass Category ID as All, the search filters will be applied to all the products across all the categories. The Pricelist ID and Search Type are mandatory fields.You can also use the Filter and Includes query parameter to deepen your search by passing the categories and pricelist items.When you do not pass the category ID in the header or pass an empty request body, the API returns all the products without any facets/search filter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Default is Product.

filter
array of strings

Contains conditional filters in standard URI that can be used to narrow down the search result. Only the AND operator is supported to associate multiple filters.

filter
string

A keyword to narrow down the search result. The API can match a maximum of 20 characters. If the keyword exceeds 20 characters, the API considers only first 20 characters of the keyword to find match in the record header fields. If the parameter is left blank, all relevant records after the filter is executed are retrieved.

includes
array of strings

Related data to include in response.

includes
string

The list of fields and sort order. The default sort order is ascending by name of the record.

int32
Defaults to 1

The page number of the resultset to view. Use this parameter with the "limit" parameter to configure pagination.

int32
Defaults to 50

The number of records to display on each page. A maximum of 500 records are displayed on each page. The current page and range index of the result set can be found in the content-range header field in the response with the total number of results. This helps paginate the result set.

boolean
Defaults to false

Set this as 'True' to display empty products first in the search result.

boolean
Defaults to false

Set this as 'True' to disable the currency conversion.

string
Defaults to ResponseFieldList_Default

Config Name that stores the Product search response field list

Body Params
boolean
lineItems
array of objects | null
lineItems
facets
array of objects | null
facets
Headers
string

The identifier of the price list to search on.

string

A unique identifier of the storefront.

string

The identifier of the category to search on.

string

Pass a cart id to filter the data relative to a specific cart.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses
200

OK

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json