Product

Search-term redirect

Changed on

Call before searching. When the term has a redirect URL in Marketing > Search Terms for the current channel and locale, the storefront sends the shopper there instead of showing results; redirectUrl is that URL, or null. suggestion is the "did you mean" term when the store searches with Elasticsearch (the product listing searches with it unless suggest=0), otherwise null. Returned as a list of one entry.

get/search-redirect

Request

Query parameters

querystring required
Example:summer sale

The search term.

suggest'0' | '1'

Send 0 to skip the "did you mean" lookup; suggestion is then null.

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Response

The redirect for the term.

Changes