---
title: "Hermès search suggestions"
method: GET
path: "/hermes/suggest"
tags: ["Hermes"]
---

# Hermès search suggestions

`GET /hermes/suggest`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/hermes/suggest`
- Auth: API key in header `x-api-key`

Returns Hermès' own search-box autocomplete for a partial term: matching categories with the number of items behind each, and matching products. The category codes returned are the same codes hermes-category accepts, so a suggestion feeds straight into a category browse. An empty query is supported and returns Hermès' default suggestions rather than an error.

## Query parameters

- `query` string
- `locale` 'at_de' | 'au_en' | 'be_en' | 'be_fr' | 'br_pt' | 'ca_en' | 'ca_fr' | 'ch_de' | 'ch_fr' | 'cz_en' | 'de_de' | 'dh_en' | 'dk_en' | 'es_es' | 'fi_en' | 'fr_fr' | 'gr_en' | 'hk_en' | 'ie_en' | 'it_it' | 'jp_ja' | 'kr_ko' | 'lu_fr' | 'mo_en' | 'mx_es' | 'my_en' | 'nl_en' | 'no_en' | 'pl_en' | 'pt_en' | 'ri_en' | 'se_en' | 'sg_en' | 'th_en' | 'tw_zh' | 'uk_en' | 'us_en'

## Headers

- `x-api-key` string, required

## Response `200`

OK

- HermesSuggestResponseDoc
  - `code` integer
  - `data` HermesSuggestResponse
    - `categories` HermesSuggestedCategory[]
      - `code` string
      - `label` string
      - `results` integer
    - `locale` string
    - `products` HermesSuggestedProduct[]
      - `image` string
      - `label` string
      - `sku` string
      - `url` string
    - `query` string
  - `msg` string

## Other responses

- `400`: Bad Request
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)