Quick start

1. Get a key

Your company administrator creates an API key in Orda (or your Orda manager issues one for the sandbox). It looks like orda_sk_AbC123xYz789_… and is shown only once — keep it in a password manager or your system’s secret store. See Authentication and keys.

export ORDA_API=https://api.ordatms.kz/api/v1   # example; your country's API host is given when you connect
export ORDA_KEY=orda_sk_...

2. Check access

curl -s "$ORDA_API/health"
curl -s -H "X-Api-Key: $ORDA_KEY" "$ORDA_API/orders?date=2026-11-20"

[] means the key works. 401 — wrong or revoked key, 403 — the key lacks orders.view.

3. Create a delivery point (optional)

curl -s -X POST "$ORDA_API/customers" \
  -H "X-Api-Key: $ORDA_KEY" -H "Content-Type: application/json" \
  -d '{ "name": "Arman store", "address": "Almaty, Satpayev St 30",
        "location": { "lat": 43.2365, "lon": 76.9286 },
        "windowFrom": "09:00", "windowTo": "18:00", "externalId": "K-001" }'

4. Send orders

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": "SO-00001", "number": "SO-00001", "deliveryDate": "2026-11-20",
        "customerExternalId": "K-001", "weightKg": 120, "volumeM3": 0.8,
        "amount": 15000, "paymentType": "cash" } ] }'

The response has a result for every row:

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

Send it again — you get "updated", never a duplicate.

5. Receive statuses

curl -s -X POST "$ORDA_API/webhooks" \
  -H "X-Api-Key: $ORDA_KEY" -H "Content-Type: application/json" \
  -d '{ "url": "https://erp.example.com/orda/webhook",
        "events": ["order.status_changed", "order.delivered", "order.failed", "plan.approved"] }'

Next: Importing orders · Getting routes · JS and Python examples.