API dokumentace

Všechny endpointy vyžadují hlavičku X-Api-Key.

POST/api/v1/shipments

Registrace zásilky

Request body:

{
  "tracking_number": "RR123456789CZ",
  "recipient_name": "Jan Novák",
  "recipient_city": "Praha",
  "recipient_zip": "11000",
  "recipient_address": "Vodičkova 12",
  "external_order_id": "ORD-2026-001"
}

GET/api/v1/shipments/:id

Detail zásilky + verifikace

GET/api/v1/shipments

Seznam zásilek

Query: ?status=delivered&carrier=ceska_posta&search=RR123&page=1&limit=20

POST/api/v1/webhooks

Registrace webhook URL

Request body:

{
  "webhook_url": "https://vas-eshop.cz/api/shieldtrack"
}

GET/api/v1/stats

Statistiky shopu

Příklad volání (cURL)

curl -X POST https://your-domain.com/api/v1/shipments   -H "Content-Type: application/json"   -H "X-Api-Key: your_api_key"   -d '{
    "tracking_number": "RR123456789CZ",
    "recipient_name": "Jan Novák",
    "recipient_city": "Praha",
    "recipient_zip": "11000",
    "recipient_address": "Vodičkova 12"
  }'

Cron endpoint: /api/cron/track (každých 15 minut)

← Zpět do dashboardu