GET
/
search
/
complete?query=
{partialQuery}
Search API: Predictive Search
curl --request GET \
  --url 'https://app.uselayers.com/api/storefront/v1/search/complete?query={partialQuery}' \
  --header 'Accept: <accept>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Storefront-Access-Token: <x-storefront-access-token>'
{
    "matchedQueries": [
        {
            "query_text": "sup",
            "num_searches": 1
        },
        {
            "query_text": "supreme",
            "num_searches": 11
        }
    ],
    "originalQuery": "sup",
    "normalizedQuery": "sup"
}

Authorization

X-Storefront-Access-Token
string
required
Token-based authentication header in the form of <YOUR_LAYERS_TOKEN>.

Headers

Content-Type
string
default:"application/json"
required
Accept
string
default:"application/json"
required

Query Parameters

partialQuery
string
required
The query you want to retrieve suggestions for.

Response

matchedQueries
Array of Objects
originalQuery
string
The original query text.
normalizedQuery
string
The normalized version of the original query text.
{
    "matchedQueries": [
        {
            "query_text": "sup",
            "num_searches": 1
        },
        {
            "query_text": "supreme",
            "num_searches": 11
        }
    ],
    "originalQuery": "sup",
    "normalizedQuery": "sup"
}