Offersearches

The offersearches resource family provides access to search for offers as well as facets and sort attributes resources.

Sort Attributes Selector

Retrieve the sort attribute selectors available for the store to sort the search result.

Workflow

1. Start with offer-search-result
2. GET the link with rel: sortattributes
3. GET the link with rel: choice
4. GET the link with rel: chosen
5. GET the link with rel: offersearchresult
6. GET the link with rel: description
7. POST the choice using the link with rel: selectaction

Read Sort Attribute

Retrieve the localized display name of the sort attribute.

Workflow

1. Start with sort-attribute-selector-choice
2. GET the link with rel: description
3. Render the response

Response Fields

Type: offersearch.sort-attribute

Name	Description	Type
display-name	The display name of the attribute in the given locale.	string

Offer Search

Retrieve offers with facets for the keywords in the search query, submitted using the form.

Workflow

1. Start with searches
2. GET the link with rel: offersearchform
3. Fill out the form
4. POST the form using the link with rel: offersearchaction
5. GET the link with rel: element
6. Render the response

Read Facets

Retrieve the facets available for the search query to refine the search results.

Workflow

1. Start with offer-search-result
2. GET the link with rel: facets
3. Render the response

Read Facet

Retrieve the display name of the facet and facet value selector resource.

Workflow

1. Start with facets
2. GET the link with rel: element
3. Render the response

Response Fields

Type: offersearch.facet

Name	Description	Type
display-name	The display name of the selected facet in the API.	string

Facet Selector

Retrieve the facet values available for the selected facet and the facet selector resource to select the required facet values. You can refine the search results by selecting the required choices in multiple facets and retrieve the updated results using the offer search result resource.

Workflow

1. Start with facet
2. GET the link with rel: facetselector
3. GET the link with rel: choice
4. GET the link with rel: chosen
5. GET the link with rel: offersearchresult
6. GET the link with rel: description
7. POST the choice using the link with rel: selectaction

Read Facet Value

Retrieve the facet value and the number of offers corresponding to the facet value selection.

Workflow

1. Start with facet-selector-choice
2. GET the link with rel: description
3. Render the response

Response Fields

Type: offersearch.facet-value

Name	Description	Type
value	The facet value.	string
count	The count of items corresponding to the selected facet value.	string