Документация API

REST API магазина на «Океано»: товары, остатки, заказы и покупатели — из вашей программы. О событиях магазина сообщают вебхуки.

Адрес API: https://api.okeysait.ru/v1 · JSON · OpenAPI 3.1

Разделы

Право выбирается при создании ключа. GET /shop открыт любому действующему ключу.

Метод	Путь	Право	Что делает
GET	`/shop`	любое	Магазин и права ключа
GET	`/products`	`products:read`	Список товаров
POST	`/products`	`products:write`	Создать товар
GET	`/products/{id}`	`products:read`	Товар
PATCH	`/products/{id}`	`products:write`	Изменить товар
DELETE	`/products/{id}`	`products:write`	Удалить товар
PATCH	`/stock`	`products:write`	Остатки и цены пачкой
GET	`/categories`	`products:read`	Список разделов
POST	`/categories`	`products:write`	Создать раздел
GET	`/categories/{id}`	`products:read`	Раздел
PATCH	`/categories/{id}`	`products:write`	Изменить раздел
GET	`/brands`	`products:read`	Список брендов
POST	`/brands`	`products:write`	Создать бренд
GET	`/brands/{id}`	`products:read`	Бренд
PATCH	`/brands/{id}`	`products:write`	Изменить бренд
GET	`/orders`	`orders:read`	Список заказов
POST	`/orders`	`orders:write`	Создать заказ
GET	`/orders/{id}`	`orders:read`	Заказ
PATCH	`/orders/{id}`	`orders:write`	Изменить заказ
GET	`/checkout`	`orders:read`	Способы доставки и оплаты
GET	`/customers`	`customers:read`	Список покупателей
GET	`/customers/{id}`	`customers:read`	Покупатель

JSON в UTF-8, поля в snake_case.
Деньги — строкой с двумя знаками: "1290.00", валюта RUB.
Даты — ISO 8601 с поясом: 2026-10-30T09:00:00+03:00.
Списки — {"data": […], "next_cursor": "…"}. limit — от 1 до 250, по умолчанию 50. Следующая страница — cursor из next_cursor; null — страниц больше нет.
Ошибки — {"error": {"code": "…", "message": "…"}}. Программе нужен code, все коды — в разделе «Ошибки и лимиты».

Полное описание методов, объектов и событий. Импортируйте его в Postman, Insomnia или Swagger UI либо сгенерируйте клиент для своего языка.