Alıcı adresi oluşturma

Alıcı adreslerini önceden oluşturursanız, tekrar girmenize gerek kalmaz ve belirli bir adrese yapılan gönderileri listeleyebilirsiniz. Aşağıda örnek alıcı adresi oluşturma isteği ve cevabını görebilirsiniz. Gönderici adresi arasındaki fark isRecipientAdress alanının doldurulması.

Örnek İstek #

curl --request POST \
  --url https://api.geliver.io/api/v1/addresses \
  --header 'Authorization: Bearer {{bearerToken}}' \
  --header 'Content-Type: application/json' \
  --data '{
		"name": "Mehmet Sezer",
		"email": "mehmetsezer@gmail.com",
		"phone": "+90505123456",
		"address1": "Address Test Json 2-1",
		"address2": "Address Test Json 2-2",
		"cityName": "Istanbul",
		"districtName": "Esenyurt",
		"countryCode": "TR",
		"state": "",
		"zip": "34020",
        "isRecipientAddress": true,
        "shortName": "mehmetsezer",
        "metadata": {
            "providerCustomerCodes":{
                "YURTICI": "Y12313435309",
                "SURAT": "S4910103"
            }
        }
}'
Parametreler Açıklama
name Gönderici adı / Şirket adı
email Gönderici eposta adresi
address1 Tam adresi içerir. Ülke/Şehir/İlçe içermez
cityCode Şehir kodu. Türkiye için plaka kodudur. /cities endpointinden herhangi bir ülke içerisindeki şehirlerin kodları alınabilir
districtID İlçe kodu. /districts endpointinden herhangi bir ülke ve şehrin ilçe kodları alınabilir
countryCode Ülke kodu
isRecipientAddress Alıcı adresi olduğu belirlenir.
zip Posta kodu
shortName Benzersiz adres adı. Hatırlamanız için kısa olabilir veya isterseniz sizin sisteminizdeki kodu yazabilirsiniz.
metadata Opsiyonel alan. Adresler için ekstra alanlar kaydetmek isterseniz kullanabilirsiniz. AddressMetadata formatındadır.

Cevap #

Adres oluşturmadan sonra gelen başarılı istek cevabı aşağıdaki gibidir.

{
    "result": true,
    "data": {
        "id": "76225e42-9436-4643-b691-25c4c9f61dae",
        "createdAt": "2021-12-20T09:18:59.925689+03:00",
        "updatedAt": "2021-12-20T09:18:59.925689+03:00",
        "name": "Mehmet Sezer",
		"email": "mehmetsezer@gmail.com",
		"phone": "+90505123456",
		"address1": "Address Test Json 2-1",
		"address2": "Address Test Json 2-2",
		"cityName": "Istanbul",
		"districtName": "Yunusemre",
		"countryCode": "TR",
		"state": "",
		"zip": "34020",
        "isRecipientAddress": true,
        "shortName": "mehmetsezer",
        "districtID": 12345,
        "districtName": "Esenyurt",
        "district": null,
        "streetID": null,
        "streetName": "",
        "countryCode": "TR",
        "countryName": "Turkey",
        "source": null,
        "isDefaultSenderAddress": false,
        "isDefaultReturnAddress": false,
        "isActive": true,
        "metadata": {"providerCustomerCodes":{
            "YURTICI": "Y12313435309",
            "SURAT": "S4910103"
        }
    }
}

Parametreler Açıklama
result Başarılı olup olmadığı. true ise başarılıdır.
data Oluşturulan adres kaydı.
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ı
Hata kodları Açıklama
E1129 Alıcı adresi boş
E1130 Alıcı şehri boş
E1131 Alıcı ülkesi boş
E1132 Alıcı ilçesi boş
E1133 Alıcı ismi boş
E1134 Alıcı telefon numarası boş
E1136 Alıcı e-posta adresi boş