Dispatch Servisi API Dökümantasyonu (v3)

Sefer (dispatch) yönetimi bu servis üzerinden yapılır. Bir sefer, bir hat (line) üzerinde bir araca ve sürücüye atanan taşıma operasyonunu temsil eder. Her seferin birden fazla ayağı (leg) olabilir ve her ayakta yük yükleme/boşaltma işlemleri yapılır.

Base URL: /v3/clients/:client_id/dispatches

---

Enum Referansları

Dispatch Status (dispatch_status)

Değer	Açıklama
created	Oluşturuldu
completed	Tamamlandı

Leg Status (leg_status)

Değer	Açıklama
created	Oluşturuldu
started	Başladı
completed	Tamamlandı

Leg Action (action_type)

Değer	Açıklama
load-vehicle	Araca yük yükleme
unload-vehicle	Araçtan yük boşaltma
start-leg	Ayağı başlatma
stop-leg	Ayağı durdurma

Line Type (line_type)

Değer	Açıklama
main	Ana hat
center	Merkez hat
intermediate	Ara hat

---

1. Create Dispatch (Sefer Oluştur)

• URL: POST /
• Auth: ClientSecret + User
• Request Body:

  {
    "line_type": "main | center | intermediate (zorunlu)",
    "line_id": "uuid (zorunlu — hat ID)",
    "vehicle_id": "uuid (zorunlu — araç ID)",
    "user_id": "uuid (zorunlu — sürücü ID)"
  }

---

2. List Dispatches (Seferleri Listele)

• URL: GET /
• Auth: ClientSecret + User
• Query Params:
  • page[index], page[size]: Sayfalama
  • search: Arama
  • filter[status]: Sefer durumu
  • filter[plate]: Plaka filtresi
  • filter[transfer_center_id]: Transfer merkezi filtresi
  • filter[branch_id]: Şube filtresi
  • sort[id], sort[type]

---

3. Dispatch Details (Sefer Detayı)

• URL: GET /:client_dispatch_id
• Auth: ClientSecret + User

---

4. Update Dispatch (Sefer Güncelle)

• URL: PUT /:client_dispatch_id
• Auth: ClientSecret + User
• Request Body: (tüm alanlar opsiyonel)

  {
    "vehicle_id": "uuid",
    "user_id": "uuid",
    "dispatch_status": "created | completed"
  }

---

5. Delete Dispatch (Sefer Sil)

• URL: DELETE /:client_dispatch_id
• Auth: ClientSecret + User

---

6. Print Vehicle Barcode (Araç Barkodu Yazdır)

Sefere ait aracın barkod çıktısını döner. Auth gerektirmez.

• URL: GET /:client_dispatch_id/print-vehicle-barcode

---

---

Legs (Sefer Ayakları)

Bir seferin durak noktalarını (ayaklarını) yönetir. Her ayak bir şube veya transfer merkezini temsil eder.

Base URL: /v3/clients/:client_id/dispatches/:client_dispatch_id/legs

---

7. Create Leg (Ayak Oluştur)

• URL: POST /
• Auth: ClientSecret + User
• Request Body:

  {
    "branch_id": "uuid (default: null)",
    "transfer_center_id": "uuid (default: null)",
    "leg_status": "created | started | completed (default: created)",
    "index": 0
  }

  index zorunludur — ayağın sıra numarası.

---

8. List Legs (Ayakları Listele)

• URL: GET /
• Auth: ClientSecret + User
• Query Params:
  • page[index], page[size], search
  • filter[status]: Ayak durumu
  • filter[transfer_center_id], filter[branch_id]
  • sort[id], sort[type]

---

9. Leg Details (Ayak Detayı)

• URL: GET /:client_dispatch_leg_id
• Auth: ClientSecret + User

---

10. Update Leg (Ayak Güncelle)

• URL: PUT /:client_dispatch_leg_id
• Auth: ClientSecret + User
• Request Body: (tüm alanlar opsiyonel)

  {
    "branch_id": "uuid",
    "transfer_center_id": "uuid",
    "leg_status": "created | started | completed",
    "index": 1
  }

---

11. Delete Leg (Ayak Sil)

• URL: DELETE /:client_dispatch_leg_id
• Auth: ClientSecret + User

---

12. Export Leg (Ayak Dışa Aktar)

• URL: GET /:client_dispatch_leg_id/export
• Auth: ClientSecret + User
• Query Params:
  • page[index], page[size], search
  • filter[status]: Leg durumu filtresi (tekli veya dizi)
  • sort[id], sort[type]

---

13. Print Waybill (İrsaliye Yazdır)

Ayağa ait irsaliye çıktısını döner. Auth gerektirmez.

• URL: GET /:client_dispatch_leg_id/print-waybill

---

14. Transfer Loads (Yükleri Transfer Et)

Ayağa ait yükleri transfer noktasına aktarır.

• URL: GET /:client_dispatch_leg_id/transfer-loads
• Auth: ClientSecret + User

---

---

Leg Actions (Ayak Aksiyonları)

Ayaklar üzerinde yük yükleme, boşaltma, başlatma ve durdurma işlemleri.

Base URL: /v3/clients/:client_id/dispatches/:client_dispatch_id/legs/:client_dispatch_leg_id

---

15. Load Vehicle (Araca Yük Yükle)

Barkod numarası ile araca yük yükler.

• URL: POST /load-vehicle
• Auth: ClientSecret + User
• Idempotency: IdempotencyKey gerekli
• Request Body:

  {
    "load_no": "YUK-001 (zorunlu)"
  }

---

16. Unload Vehicle (Araçtan Yük Boşalt)

Barkod numarası ile araçtan yük boşaltır.

• URL: POST /unload-vehicle
• Auth: ClientSecret + User
• Idempotency: IdempotencyKey gerekli
• Request Body:

  {
    "load_no": "YUK-001 (zorunlu)"
  }

---

17. Start Leg (Ayağı Başlat)

Ayağın hareketini başlatır. Araç fotoğrafları (4 yön) gereklidir.

• URL: POST /start
• Auth: ClientSecret + User
• Request Body:

  {
    "signatures": {
      "left": "base64-image (zorunlu)",
      "right": "base64-image (zorunlu)",
      "front": "base64-image (zorunlu)",
      "back": "base64-image (zorunlu)"
    }
  }

---

18. Stop Leg (Ayağı Durdur)

Ayağın hareketini sonlandırır. Araç fotoğrafları opsiyoneldir.

• URL: POST /stop
• Auth: ClientSecret + User
• Request Body:

  {
    "signatures": {
      "left": "base64-image",
      "right": "base64-image",
      "front": "base64-image",
      "back": "base64-image"
    }
  }

  signatures objesi opsiyoneldir (default: null).

---

19. Get Loads (Ayaktaki Yükleri Listele)

Ayağa yüklenmiş/boşaltılmış yükleri listeler.

• URL: GET /loads
• Auth: ClientSecret + User
• Query Params:
  • page[index], page[size]
  • filter[action_type]: load-vehicle / unload-vehicle