OpenAPI и Postman

Файлы​

• OpenAPI (YAML): https://docs.shopstory.live/downloads/public-openapi.yaml
• Postman коллекция: https://docs.shopstory.live/examples/postman/ShopStory%20Public%20API.postman_collection.json
• Просмотр схем: https://docs.shopstory.live/swagger/

В спецификации указаны структура ответов, обязательные поля и правила обработки ошибок:

• /v3/streams и /v3/translation/quick-state передают ошибки приложения внутри конверта при HTTP 200;
• /v2/mini-player/* выставляет HTTP-код ошибки и повторяет его в поле status.

Доступность товара и API остатков​

body.products[].feedProductAvailable в ответе GET /v3/streams содержит булевый снимок доступности из фида. Он не передаёт количество единиц, остаток выбранного магазина или время обновления товара. serverTime — время ответа API.

Public API не вызывает stock API клиента и не содержит метода проверки текущего остатка: остаток по магазину — данные ритейлера, и запрашивает их его собственный код. В Web SDK это делает штатный обработчик наличия, при интеграции через Public API — интерфейс клиента. Контракт обработчика и приоритет источников описаны в разделе Наличие товара и остатки.

Обработчик наличия не добавляет HTTP-методов: в спецификации его нет и не будет.

Использование Postman​

Переменные приложения, товара и эфира оставлены пустыми. Коллекция не содержит идентификаторов реальных клиентов или демонстрационных данных.

После импорта заполните:

Переменная	Значение
applicationId	Идентификатор приложения, выданный ShopStory.
feedProductId	Строковый идентификатор тестового товара из согласованного фида.
productCode	Артикул товара, если для проекта согласован поиск по vendorCode.
categoryId	Категория из ответа /v3/streams, если проверяется фильтр.
translationId	Идентификатор тестового эфира.

applicationId выбирает область данных и не авторизует запрос. Не добавляйте в публичную коллекцию токены, cookie, реквизиты фида или реальные пользовательские данные.

Связанные разделы​

• Quickstart — примеры первых запросов к API
• Каталог эфиров — семантика фильтров и пагинации
• Mini-player — состояния по товару и текущий live
• Товарный фид — идентификаторы и снимок доступности