Searches

Entry Point: /searches/{scope}

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

Search workflow:

1. GET the search form
2. Populate the form with the search keywords
3. POST the search form to create the search
4. 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.

Read Searches

Retrieve list of available search forms.

Workflow

1. Start with root
2. GET the link with rel: searches
3. Render the response

Keyword Search

Retrieve all items matching the keywords in the search criteria, submitted using the form.

Workflow

1. Start with searches
2. GET the link with rel: keywordsearchform
3. Fill out the form
4. POST the form using the link with rel: itemkeywordsearchaction

Request Fields

Type: searches.keyword-search

Name	Description	Type
keywords	Search keywords.	string
page-size	Defines the number of search results to list per page. This field is optional. If the field is not specified, Cortex API’s default page-size value is used, which can differ depending on your implementation.	integer