Item Search API

The Item Search API is a configuration driven API, which is determined by your Search Settings. For example, items returned in the API response data can be filtered by the facets you defined on the Search Index subtab when you set up Search Settings. For more information, see Search Settings Overview.

The Item Search API uses a REST/JSON style of communication, and supports searching, sorting, faceting, pagination, or any combination of these as they can operate independently. Web Developers can use this API to build facet filtering and keyword search on item data.

Note

To use the Item Search API, you must have a SuiteCommerce website, and you must have configured item search settings for your site.


See the following topics for more information about the Item Search API:

  • Items Available to the Item Search API – This topic describes the factors that affect whether an item can be retrieved by the Item Search API.

  • The Base URL – The base URL is the URL sent in the HTTP request to the Item Search API in order to retrieve a list of items. This topic describes the structure of the base URL.

  • Item Search API Input Parameters – This topic describes all the input parameters that can be used in query strings to retrieve item record attributes. 

  • Sample Item Search Query and Results – This topic provides sample Item Search API queries and descriptions of response data.