Docs / Search API
Reference
Search API
Base path /v1/catalog/{shop}. The agent reads items and catalog.stale.
Search
POST /v1/catalog/{shop}/search with {"q":"drill","limit":5}. GET is equivalent. Use POST when the query is not plain ASCII.
| Field | Default | Meaning |
|---|---|---|
q | empty | Search query |
sku | empty | Exact SKU, wins over q |
limit | 5 | From 1 to 20 |
in_stock_only | false | Only stock=in_stock |
Other methods
GET /products/{sku}— one card, otherwise 404GET /tools?format=openai— openai, anthropic, or schema
401 bad token. 403 a key for another shop. 404 no profile or no SKU. 422 a parameter outside the schema. 429 the search limit is used up. 402 the product or shop allowance is exceeded.