The searches resource family performs search actions using the Elastic Path Search server. Cortex API sends the search keywords entered by the shopper to the search server for processing and the server returns the results to Cortex API.
Elastic Path provides the following options:
- Offer search : Retrieves offers and the available facets
- Keyword search: Retrieves the results that match the keywords
GETthe search form
- Populate the form with the search keywords
POSTthe search form to create the search
- Follow the link returned by Cortex API to retrieve the search results
Search results for the keywords are paginated and ordered according to the relevance to the keywords.
Retrieve list of available search forms.
- Start with root
GETthe link with rel: searches
- Render the response
Retrieve all items matching the keywords in the search criteria, submitted using the form.
- Start with searches
GETthe link with rel: keywordsearchform
- Fill out the form
POSTthe form using the link with rel: itemkeywordsearchaction
|Defines the number of search results to list per page. This field is optional. If the field is not specified, Cortex API’s default |