Auto-Suggest

POST

/auto-suggest

const url = 'https://api.vviinn.com/auto-suggest';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"query":"sneak"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.vviinn.com/auto-suggest \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "query": "sneak" }'

This endpoint returns auto-complete suggestions for a partial search query. Each suggestion completes the entered text and may carry a direct link (url) — for example to a product or a landing page when a campaign maps the query to a specific target.

Authorizations

read-only-token
site-credentials

Request Body

Auto Suggest request body

application/json

object

query

required

string

Example

sneak

Responses

200

application/json

object

data

required

object

query

required

string

completions

required

Array<object>

object

suggestion

required

string

url

string format: uri

nullable

Example

{
  "data": {
    "query": "sneak",
    "completions": [
      {
        "suggestion": "sneakers",
        "url": "https://www.example.com/sneakers"
      }
    ]
  }
}

401

Generic Error

application/json

object

message

string

Example

{
  "message": "Generic Error"
}

403

Generic Error

application/json

object

message

string

Example

{
  "message": "Generic Error"
}