Public API v1 sözleşmesi Gönderiler PA-55
Taşıyıcıdan canlı süreç görünümü
GET/api/v1/shipments/{id}/carrier-process
> Künye: TASK-414; REQ-023 AC-5, DEC-375 (c)/(d), DEC-363 (e).
Amaç
Gönderinin taşıyıcı tarafındaki o anki halini tek çağrıda göstermek: teslim ayrıntısı, teslimat problemleri ve taşıyıcının kestiği belgeler. Yan etkisiz okumadır, hiçbir şey değiştirmez.
BU UÇ İLE `meta.carrier_info` AYNI ŞEY DEĞİLDİR ve ayrım KAYNAĞA göredir, alana göre değil
PA-02 ve PA-31 detayının meta.carrier_info alanı depodan servis edilir: taşıyıcıya çağrı yapılmaz, dolayısıyla bir taşıyıcı arızası Sevkora'nın okuma ucunu yavaşlatmaz. Bu uç ise canlıdır ve yalnız kullanıcının açık isteği üzerine taşıyıcıya gider. Oynak alanlar (tahmini teslim tarihi) ve büyük kümeler (teslimat problemleri, belgeler) burada durur, çünkü donmuş bir kopya onları yanlış gösterirdi.
TESLİM ALAN GÖSTERİLİR, SAKLANMAZ
delivered_to yalnız bu yanıtta görünür; hiçbir kolona, hiçbir loga ve hiçbir önbelleğe yazılmaz. Gerekçe: gönderiyi fiilen teslim alan kişi çoğu zaman alıcının kendisi değildir (komşu, kapıcı) ve saklanması KVKK envanterine yeni bir üçüncü taraf veri sınıfı eklerdi. Yokluk bir niyet değil, ölçülen bir özelliktir.
YALNIZ KENDİ TAŞIYICI HESABINIZLA ÇIKAN GÖNDERİDE AÇILIR
Sevkora bayi hesabından çıkan gönderide 422 döner. Gerekçe bir sızıntıdır: bayi yolunda taşıyıcı ilişkisi Sevkora'nındır ve dönen tutarlar Sevkora'nın alış tarifesidir.
Yetki
Authorization: Bearer.
TUTARLAR SALT OKUNURDUR
Belge satırlarındaki tutarlar taşıyıcı tarafından faturalanmıştır; Sevkora onları tahsil etmez, hiçbir defter satırı üretmez ve Sevkora faturasıyla (PA-20) bağ kurmaz.
Başarı 200
data.status, data.status_explanation, data.status_at, data.is_delivered, data.delivered_at, data.delivered_to, data.estimated_delivery_at, data.delivery_problems[] ve data.documents[]. Bilinmeyen alan null döner, uydurulmaz.
Alan kümesi kapalıdır
taşıyıcının döndüğü alıcı adı, ili, ilçesi ve telefonları, teslimat problemine yanıt veren kişinin adı ve IP adresi Sevkora'ya hiç girmez. Bu bir süzgeç değil, taşınan tipin kendi özelliğidir.
Hatalar
422 (bayi yolundaki gönderi, taşıyıcı hesabı çözülemedi, taşıyıcı bu yeteneği sunmuyor), 404 (başka tenant'ın gönderisi), 502 (taşıyıcı yanıt veremedi); ayrıca 401, 403, 429.
Idempotency-Key
sözleşmesi yoktur; tekrarlanan okuma zaten güvenlidir.
curl "{{base_url}}/shipments/01K1GNDR000000000000000001/carrier-process" \
-H "Accept: application/json" \
-H "Authorization: Bearer SEVKORA_API_ANAHTARINIZ"