marketplace
GET /v1/marketplace/{vertical}/search
Filter, sort and page one vertical's live Zinn®s.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/marketplace/{vertical}/search \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
docs/83 §2 step 4. Anonymous, single-variant, and answered entirely from the derived publication projection — never from the org-scoped authoring tables. ⛔ **The facet parameters are generic on purpose.** Fields are defined by staff in admin, so a typed parameter per filter would mean a spec change, an SDK regeneration and a deploy every time somebody added one — which is the exact property this milestone exists to remove. A filter is `facet=key:op:value`, repeated; values of the same key are OR-ed, different keys are AND-ed. ⛔ **A numeric filter requires `type`.** The promoted slot behind `da` holds a different field for every listing type, so asking `da:gte:50` across a whole vertical would compare a domain authority against whatever the next kind of listing stores in the same column — wrong, plausible, and impossible to notice. It is refused with 422. ⛔ **`declared`/`of` on every facet are not decoration.** A field added in schema v2 does not exist on v1 listings, so filtering on it silently excludes them and "DA ≥ 50" quietly becomes "and authored after the day DA was added". The two numbers are what let the page say "482 of 1,930 Zinn®s declare DA" instead of implying the other 1,448 failed the filter. ⛔ `total` is probed to 10,000 and `total_is_capped` says so. An exact count of a large filtered set costs as much as returning it.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
vertical (path) | string | Да | — |
locale (query) | string | Нет | Render every operator-authored string — field labels, help text, enum option labels — in this locale, falling back to the source language per string. ⛔ A query parameter rather… |
type (query) | string | Нет | A listing type key. Required before any facet filter can be applied. |
category (query) | string | Нет | A category path. Matches that category AND everything beneath it. |
q (query) | string | Нет | What the buyer typed. Truncated at 120 characters rather than refused — pasting an essay into a search box is not an attack. ⭐ Answered by **hybrid retrieval** (docs/83 §2a, own… |
facet (query) | string[] | Нет | `key:op:value`, repeatable. `op` is `gte`/`lte` for numbers and `eq` for choices and yes/no fields. |
sort (query) | string<newest, price, -price, rating, sales> | Нет | — |
cursor (query) | string | Нет | Keyset page marker from a previous response. Never an offset. |
limit (query) | integer | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
marketplace | object | Да | — |
canonical_vertical | string | Нет | Set when the request used a SUPERSEDED slug — the segment this page should 301 to. `null` on the normal path. ⛔ A retired slug still RESOLVES rather than 404ing: docs/83 §6 puts… |
listing_type | string | Нет | — |
results | MarketplaceSearchCard[] | Да | — |
next_cursor | string | Да | Empty when there is no next page. Opaque — never build one by hand. |
total | integer | Да | — |
total_is_capped | boolean | Да | True when there are more than `total` results. The page renders "10,000+"; showing a flat "10,000" for a catalogue of two million would be false. |
sort | string | Да | — |
sorts | string[] | Да | The sorts this catalogue offers, served with the data so the storefront is not compiled against a copy of the list. |
facets | MarketplaceFacet[] | Да | — |
query | string | Да | What was actually searched for, after the filter language took its bite. Empty when no phrase was given. ⭐ Differs from what the buyer typed whenever `interpreted` is non-empty:… |
interpreted | string[] | Да | Human-readable chips for filters INFERRED from the phrase rather than ticked on the rail — already in the requested locale. ⛔⛔ **Render these.** A search box that silently rewri… |
retrieval | string<lexical, trigram, semantic>[] | Да | Which retrieval paths actually ran for this request (docs/83 §2a, D-W15-9). Empty when no phrase was given, or when the deployment has no retrieval objects. ⛔⛔ **Not diagnostics… |
Ошибки, которые может возвращать этот эндпоинт
404 · 422