К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-searchcatalog.mdиндекс документации — /llms.txt

searchCatalog

Обновлено

GET /api/v1/catalog/search

searchCatalog

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["catalog:read"]

Параметры запроса

ПолеЗначение
0.in"query"
0.name"q"
0.requiredfalse
0.schema0.schema
1.in"query"
1.name"currency"
1.requiredfalse
1.schema1.schema
2.in"query"
2.name"price_min"
2.requiredfalse
2.schema2.schema
3.in"query"
3.name"price_max"
3.requiredfalse
3.schema3.schema
4.in"query"
4.name"availability"
4.requiredfalse
4.schema4.schema
5.in"query"
5.name"sort"
5.requiredfalse
5.schema5.schema
6.in"query"
6.name"cursor"
6.requiredfalse
6.schema6.schema
7.description"Category ids, comma-separated (at most 20); a product in any of them matches"
7.in"query"
7.name"group_ids"
7.requiredfalse
7.schema7.schema
8.in"query"
8.name"limit"
8.requiredfalse
8.schema8.schema

Тело запроса

ПолеЗначение
Тело запросаnull

Ответы

ПолеЗначение
200.content.application/json.schemaCatalogSearchPage
200.description"One page of matching products with their availability, prices and unavailable combinations"

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"The search does not match the request schema (VALIDATION_ERROR) or the cursor belongs to another query (INVALID_CURSOR)"
401.content.application/problem+json.schemaProblemDetails
401.description"Missing or invalid authentication"
403.content.application/problem+json.schemaProblemDetails
403.description"Catalog read scope or resource policy refused the request"

Дополнительные условия

ПолеЗначение
description"Structured search over what a buyer can see (switched on, listed, showcase scope): words in the title or description, categories, a price range in one currency, availability, five sorts. One page per call; follow next_cursor. A page filtered by availability can be empty while has_more is true."
operationId"searchCatalog"
tags["catalog"]
x-idempotency"none"