Перейти к содержимому

Быстрый старт

Администратор вашей компании в Orda создаёт API-ключ (или его выдаёт менеджер Orda для песочницы). Ключ выглядит так: orda_sk_AbC123xYz789_… и показывается один раз — сохраните его в менеджере паролей или хранилище секретов вашей системы. Подробнее — Авторизация и ключи.

Для примеров ниже задайте переменные:

Окно терминала
export ORDA_API=https://api.ordatms.kz/api/v1 # пример; адрес API своей страны сообщит менеджер
export ORDA_KEY=orda_sk_... # ваш ключ
Окно терминала
curl -s "$ORDA_API/health"
curl -s -H "X-Api-Key: $ORDA_KEY" "$ORDA_API/orders?date=2026-11-20"

Ответ [] — ключ работает, заказов на эту дату пока нет. 401 — ключ неверный или отозван, 403 — у ключа нет права orders.view.

Если клиенты (магазины, точки) повторяются — заведите их один раз со своим кодом externalId, тогда в заказе достаточно указать этот код:

Окно терминала
curl -s -X POST "$ORDA_API/customers" \
-H "X-Api-Key: $ORDA_KEY" -H "Content-Type: application/json" \
-d '{
"name": "Магазин «Арман»",
"address": "Алматы, ул. Сатпаева, 30",
"location": { "lat": 43.2365, "lon": 76.9286 },
"windowFrom": "09:00", "windowTo": "18:00",
"externalId": "K-001"
}'
Окно терминала
curl -s -X POST "$ORDA_API/orders/bulk" \
-H "X-Api-Key: $ORDA_KEY" -H "Content-Type: application/json" \
-H "Idempotency-Key: export-2026-11-20-001" \
-d '{
"orders": [
{
"externalId": "РТ-00001",
"number": "РТ-00001",
"deliveryDate": "2026-11-20",
"customerExternalId": "K-001",
"weightKg": 120, "volumeM3": 0.8,
"amount": 15000, "paymentType": "cash"
}
]
}'

Ответ — результат по каждой строке:

{ "created": 1, "updated": 0, "failed": 0,
"results": [ { "index": 0, "externalId": "РТ-00001", "result": "created", "id": "4b0c…" } ] }

Отправьте тот же запрос ещё раз — получите "updated", дубля не будет.

Подключите вебхук — Orda сама сообщит, когда заказ доставлен или не доставлен (Вебхуки):

Окно терминала
curl -s -X POST "$ORDA_API/webhooks" \
-H "X-Api-Key: $ORDA_KEY" -H "Content-Type: application/json" \
-d '{ "url": "https://erp.example.kz/orda/webhook",
"events": ["order.status_changed", "order.delivered", "order.failed", "plan.approved"] }'

Дальше: Импорт заказов · Получение маршрутов · Примеры на JS и Python.