Orda TMS API
Orda TMS — система планирования и исполнения доставки. Через открытый API ваша учётная система (1С, SAP, собственная CRM или сайт) передаёт заказы, а обратно получает маршруты и статусы доставки — без ручного ввода и без выгрузок в Excel.
Что можно сделать через API
Заголовок раздела «Что можно сделать через API»| Задача | Как | Руководство |
|---|---|---|
| Загрузить заказы (по одному или до 1000 за запрос) | POST /orders, POST /orders/bulk |
Импорт заказов |
| Справочники: точки доставки, склады, машины, водители | /customers, /warehouses, /vehicles, /drivers |
Справочник API |
| Построить и утвердить маршруты на день | POST /plans, POST /plans/{id}/approve |
Получение маршрутов |
| Узнавать о доставке сразу, без опроса | вебхуки с подписью HMAC | Вебхуки |
| Безопасно повторять запросы при обрыве связи | заголовок Idempotency-Key |
Идемпотентность |
Принципы
Заголовок раздела «Принципы»- REST + JSON, адреса вида
https://<адрес API>/api/v1/.... Спецификация — OpenAPI 3 (openapi.json), её можно загрузить в Postman, Insomnia или сгенерировать клиент. - Доступ — API-ключ компании с ограниченными правами. Ключ видит данные только своей компании; изоляция компаний проверяется автотестами на каждое изменение.
- Обновление без дублей: у каждой записи есть
externalId— код документа в вашей системе. Повторная отправка того же заказа обновляет его, а не создаёт второй. - Стабильность версии: внутри
v1мы только добавляем поля и методы, ничего не удаляем и не переименовываем. Ваш код должен игнорировать незнакомые поля. - Даты —
YYYY-MM-DD, время в маршрутах —HH:MMв часовом поясе компании (Asia/Tashkent,Asia/Almaty…), отметки времени — ISO 8601 в UTC. Суммы — в основных единицах валюты компании (сум, тенге…), валюта — в полеcurrency.
С чего начать
Заголовок раздела «С чего начать»- Прочитайте Быстрый старт — первый заказ за 10 минут.
- Попросите менеджера Orda песочницу — тестовую компанию с ключом (Песочница и запуск).
- Нет программиста? Заказы можно загружать файлом Excel/CSV из 1С — см. Без программиста.