Ek Hizmet

Ek Hizmet

Gönderiler için talep edilebilecek ek hizmetleri tanımlamak için kullanılan bir özelliktir.

Kullanım Alanları

Bu ek hizmetler şu işlemlerde/süreçlerde kullanılabilir:

  • Gönderi Oluşturma (Yurtiçi / Yurtdışı)

Kullanılabilir Değerler API

Her provider için kullanılabilir değerler farklıdır, bu nedenle aşağıdaki API ile sorgulama yapılması gerekmektedir.

Endpoint Bilgileri

  • URL: {{APP_URL}}/api/v1/providers/{provider_id}/feature/special-services
  • HTTP Metodu: GET
  • İçerik Türü: application/json
  • Kimlik Doğrulama Tipi: APIKEY

URL Query Parametreleri

Parametre Adı Parametre Tipi Zorunluluk Açıklama
provider_id Integer Zorunlu Kargo Sağlayıcı id

Örnek API İsteği

GET {{APP_URL}}/api/v1/providers/1/feature/special-services
Content-Type: application/json
APIKEY: {{APIKEY}}

API Yanıtı

{
    "status": true,
    "message": "Provider special services retrieved successfully",
    "data": [
        "CASH_ON_DELIVERY",
        "SHIPPING_FEE_ON_DELIVERY",
        "HOLD_AT_DEPARTMENT",
        "VALUED_SHIPMENT",
        "CONTROLLED_DELIVERY"
    ]
}

Gönderi Oluşturma (Yurtiçi / Yurtdışı) Kullanımı

Gönderi oluşturma içeriğinde special_services alanına, API üzerinden alınan desteklenen service_type değerleri eklenebilir.

Her bir ek hizmet için aşağıdaki alanlar tanımlanmalıdır:

  • service_type: Her servis tipinin dokümantasyon sayfasında belirtilen değer kullanılmalıdır

  • details: Seçilen servis tipine özel parametre yapısına uygun olarak doldurulmalıdır

  • Bir gönderiye birden fazla ek hizmet eklenebilir

    Yapı

{
    "special_services": [
        {
            "service_type": "STRING",
            "details": {
                // Servis tipine göre değişken içerik
            }
        }
    ]
}