List of APIs
Search APIs
Search
Search Navigations
Null Search Terms
Search Term Performance
Search Products
Trending Searches
get

/sayt/products/

The sayt/products (GET) call has been deprecated. Product suggestions can be generated using the Search API, to ensure that the products suggested match the results returned when the shopper selects a search suggestion. For assistance with implementing product suggestions using the Search API, please contact GroupBy Support.

Deprecated

Avoid using this API operation if possible. It will be removed in a future version.

Request Parameters

6 Query Parameters

Request Body

1 Example
Schema
object
query
string

The search term of which SAYT will be triggered based on.

required
collection
string

The collection of which SAYT will be triggered with. If not specified, the default collection is assumed.

area
string

The Command Center area to use in the resulting products. If used, the query rewrites and biasing rules within the area will be applied to the product results. If not specified, the Production area is used.

langauge
string

Specifies the language of the suggestions. Please note, if languageField was specified in the SAYT configuration, this field is required.

refinements
string

An optional way to add pre-refinements for products returned by the SAYT endpoint. Format is a tilde-separated list of refinements: ~Brand=Bose~price:20..80

searchItems
number

Specifies the number of search terms suggestions that the Web Service will return. This applies to the sayt/search endpoint only.

2 validations
navigationItems
number

Specifies the number of navigation suggestions that the Web Service will return. This applies to the sayt/search endpoint only.

2 validations
productItems
string

Specifies the number of product suggestions that the Web Service will return.

1 validation
productSort
string

Specifies the sort order of product suggestions that the Web Service will return. Please refer to the Search API Query Reference for details on sorting. The format accepted by this API is a tilde-separated list of sort objects: ~_relevance~price. You can optionally define Ascending or Descending sorts for a field by adding :A or :D respectively after a field name: ~_relevance~price:D. When order is not defined, the default is to sort ascending. Relevance is always sorted descending, and can be specified using the special _relevance field. If productSort not specified, the default is to sort relevance.

Responses

API Deprecated

1 Example
Schema
object
status
object
result
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
customerid