Kargo şablonu oluşturma

Şablon oluşturma #

Tek bir çağrıyla hem sistemde gönderi oluşturacak hem de o gönderiye teklifleri alabilirsiniz. Bunun için /shipments endpoint’ine POST isteği göndermelisiniz.

İstek #


curl --request POST \
  --url http://api.geliver.io/api/v1/parceltemplates \
  --header 'Authorization: Bearer cb611162-541f-4fb3-a353-586e2013fb31' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "test sablon",
    "length": 20,
    "height": 20,
    "width": 20,
    "weight": 0,
    "distanceUnit": "cm",
    "massUnit": "kg"
}'
Parametreler Açıklama
name Şablona vereceğiniz isim.
length Kargo gönderisi uzunluğu. Varsayılan olarak cm cinsinden. Uzunluk ölçüsünü distanceUnit alanıyla değiştirebilirsiniz. Detaylar için lütfen API Referans Dökümanını inceleyin
height Kargo gönderisi yüksekliği. Varsayılan olarak cm cinsinden. Uzunluk ölçüsünü distanceUnit alanıyla değiştirebilirsiniz. Detaylar için lütfen API Referans Dökümanını inceleyin
width Kargo gönderisi genişliği. Varsayılan olarak cm cinsinden. Uzunluk ölçüsünü distanceUnit alanıyla değiştirebilirsiniz. Detaylar için lütfen API Referans Dökümanını inceleyin
distanceUnit Kargo gönderisi uzunluk cinsi. Varsayılan olarak “cm” değerindedir. Detaylar için lütfen API referans dökümanını inceleyin
weight Kargo gönderisi ağırlığı (Opsiyonel). Varsayılan olarak kg cinsinden. Uzunluk ölçüsünü massUnit alanıyla değiştirebilirsiniz. Detaylar için lütfen API Referans Dökümanını inceleyin
massUnit Kargo gönderisi ağırlık cinsi. Varsayılan olarak “kg” değerindedir. Detaylar için lütfen API Referans Dökümanını inceleyin

Cevap #

Gönderi oluşturma isteğine cevap aşağıdaki gibidir. Cevaptaki offers alanından teklifleri alabilirsiniz.


{
    "result": true,
    "data": {
        "id": "3f4724f7-2e7a-441a-9682-df489a0f1e45",
        "createdAt": "2021-12-20T09:51:07.590256+03:00",
        "updatedAt": "2021-12-20T09:51:07.590256+03:00",
        "length": 2,
        "width": 2,
        "height": 2,
        "distanceUnit": "cm",
        "weight": 0,
        "massUnit": "kg",
        "isActive": true,
        "name": "test sablon",
        "LanguageCode": "en-US"
    }
}

Parametreler Açıklama
result Başarılı olup olmadığı. true ise başarılıdır.
data Oluşturulan kargo şablonu kaydı (id’siyle birlikte).
code Eğer istek başarısız ise burada hata kodu bulunur
message Eğer istek başarısız ise burada hata mesajı bulunur
additionalMessage Sadece test ortamı için geçerli olan detaylı hata mesajı