Search typeahead

post

https://apis.kentro.live/store/v1/catalog.suggest

The products and categories this buyer can see that match a short query, ranked and capped, for a search box. Limited per buyer, guest or visitor address (send X-Storefront-Client-Ip); past the limit the answer is 429 RATE_LIMITED with Retry-After.

Who may call it: Anyone on a public store (store.get answers access: "public"); on an invite or approval store a signed-in buyer (X-Storefront-Buyer), else 401 UNAUTHORIZED.

Body Params

query

string

required

length between 2 and 80

limit

integer

1 to 8

locationId

string

^[0-9a-fA-F-]{36}$

searchLocation

object | null

postalCode

string

length ≤ 32

country

string

^[A-Z]{2}$

Headers

X-Storefront-Host

string

required

length between 1 and 253

The published storefront host the request serves (shop.example.com, lower case). It must belong to the tenant of the API key; 404 NOT_FOUND when no published storefront answers it, 403 FORBIDDEN when it belongs to another account.

X-Storefront-Buyer

string

The signed-in buyer's access token (accessToken from POST https://apis.kentro.live/auth/login/customer). Absent for a guest or an anonymous visitor.

X-Storefront-Guest

string

The guest token session.guest answered, which identifies a guest cart and a guest checkout. Send it along with X-Storefront-Buyer at sign-in so the buyer can choose between the guest cart and the account cart.

X-Storefront-Client-Ip

string

The end buyer's IP address as your storefront server saw it. Used for per-visitor limits (search typeahead, sign-up); without it the limits apply to your server.

X-Expected-Portal

string

The store id (store.get answers id) your page was rendered for. When the host now resolves to another store the answer is 409 CONFLICT, so a stale page never acts on the wrong store.

X-Expected-Buyer

string

The identity your page was rendered for: the buyer id, guest:<guestId> for a guest, or guest for an anonymous visitor. A mismatch with the tokens sent is 409 CONFLICT, so a stale page never acts for the wrong buyer.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Matching products and categories.

defaultThe request was refused or could not be completed; the status says why (400 validation, 401 sign-in needed, 403 not allowed, 404 unknown, 409 stale revision or version, 422 commerce rule, 429 too many, 503 unavailable).