REST API

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

Интегрируйте внешние бизнес-системы с Y3M через защищённые JSON API endpoints для маршрутов доставки и комплектации заказов.

Детали интеграции

Аутентификация
Каждый запрос требует API-ключ компании в заголовке Authorization по схеме Bearer.
Формат запроса
Отправляйте один JSON-объект с Content-Type: application/json на выбранный POST route.
Ограничения
Размер payload — до 1 МиБ. С одного IP-адреса можно отправить 30 запросов за 60 секунд.
Ошибки
Ошибки возвращаются как согласованный JSON-объект с HTTP status, машинным кодом, сообщением и деталями полей при ошибке валидации.

Доступные endpoints

Маршруты доставки

Отправка данных маршрутов доставки в формате JSON.

POST/api/v1/delivery/routes
Открыть документацию

Заказы Order Picking

Отправка данных заказов для сборки в формате JSON.

POST/api/v1/order-picking/orders
Открыть документацию