Beyan ettiğinizden fazlası tahsil edilirse farkı cüzdanınıza iade ediyoruz.0850 840 15 46
Geliştirici

API dokümanı

Kendi yazılımınızdan Shipzone'a bağlanın: fiyat sorun, gönderi oluşturun, adres defterinizi yönetin.

Adres

https://api.shipzone.app

Kimlik

Anahtarınızı panelden üretirsiniz ve değeri YALNIZ BİR KEZ gösterilir — saklamıyoruz, yalnız özetini tutuyoruz. Panel şifrenizi hiçbir betiğe yazmayın; anahtarın var oluş sebebi tam olarak budur.

Panel → API Anahtarlarım

İki başlık da kabul edilir:

X-API-Key: sz_live_a1b2c3d4_...
Authorization: Bearer sz_live_a1b2c3d4_...

Uçlar

GET/v1/api/account

Anahtarın hangi hesaba ait olduğu ve neye yetkili olduğu. Entegrasyonun ilk çağıracağı uç budur: anahtarınızın çalıştığını gerçek bir gönderi oluşturmadan doğrularsınız.

GET/v1/api/carriers

Sizin için fiyat üretebilen kargo firmaları. Kendi anlaşmanız varsa o da listede görünür.

POST/v1/api/quotes

Aynı gönderi için her firmanın fiyatı — ucuzdan pahalıya. Fiyat sormak onay gerektirmez ve para harcamaz.

Gövde
{
  "origin_city": "İstanbul",
  "dest_city": "Ankara",
  "packages": [
    { "weight_kg": "1.5", "length_cm": "30",
      "width_cm": "20", "height_cm": "15" }
  ]
}
GET/v1/api/addresses

Adres defteriniz. `?kind=sender` ya da `?kind=recipient` ile süzebilirsiniz.

POST/v1/api/addresses

Adres defterine kayıt ekler. Gönderi oluştururken adresleri kimlikleriyle veriyorsunuz, bu yüzden önce buraya yazılırlar.

Gövde
{
  "kind": "recipient",
  "title": "Müşteri deposu",
  "contact_name": "Ayşe Yılmaz",
  "phone": "05320000000",
  "city": "Ankara",
  "district": "Çankaya",
  "address_line": "Örnek Mah. 1. Cad. No 5"
}
POST/v1/api/shipments

Gönderiyi kaydeder ve fiyatını dondurur. ONAY GEREKTİRİR: başvurunuz onaylanmadan bu uç 403 döner. Ücret kayıt anında cüzdanınızdan düşer.

Gövde
{
  "carrier_slug": "aras_kargo",
  "sender_address_id": "<adres kimliği>",
  "recipient_address_id": "<adres kimliği>",
  "packages": [
    { "weight_kg": "1.5", "length_cm": "30",
      "width_cm": "20", "height_cm": "15" }
  ]
}

Hatalar

Hatalar HTTP koduyla birlikte `{ "detail": { "code", "message" } }` biçiminde döner. `code` KARARLIDIR ve koşul yazmak için odur; `message` insan içindir ve değişebilir.

401Geçersiz API anahtarıAnahtar yanlış, iptal edilmiş ya da hesap kapalı. Üçü de AYNI cevabı döner — hangisinin geçerli olduğu sızmasın diye.
403Başvuru onaylı değilGönderi oluşturmak onay ister. Fiyat sorma uçları etkilenmez.
402Bakiye yetersizÜcret gönderi kaydedilirken düşer; bakiye yetmezse gönderi OLUŞMAZ.
422Gövde geçersizEksik ya da hatalı alan. Mesaj hangi alan olduğunu söyler.

Olay bildirimi ister misiniz?

Gönderi durumu değiştiğinde sizin adresinize haber veririz; sürekli sormanız gerekmez.

Webhook rehberi