Ana içeriğe atla
PATCH
Adresi kısmi güncelle
Gövdede yalnızca değiştirmek istediğiniz alanları gönderirsiniz; gönderilmeyen alanlar mevcut değerleriyle kalır. Kural ve örnekler: kısmi güncelleme.
  • Gönderilmeyen alan değişmez, null gönderilen alan temizlenir.
  • Doğrulama birleştirilmiş kaydın tamamı üzerinde çalışır; zorunlu bir alanı null yaparsanız istek reddedilir.
  • IsInvoiceAddress alanı false yapılamaz; önce başka bir adresi fatura adresi yapın.

Hata kodları

Bu endpoint’in dönebileceği kodlar. Her endpoint için geçerli olan genel hatalar (kimlik doğrulama, yetki, istek header’ları, istek limitleri) burada tekrarlanmaz.

Yetkilendirmeler

Authorization
string
header
gerekli

Access token obtained from the Noyax auth service with your API key.

Başlıklar

X-UserID
integer<int32>
gerekli

İsteğin adına yapıldığı Noyax kullanıcısının ID'si. Oluşturulan, güncellenen ve silinen kayıtların denetim alanlarına yazılır.

Gerekli aralık: x >= 1
X-CompanyID
integer<int32>
gerekli

Şirketin ID'si. Kullanıcı bu şirkete tanımlı olmalıdır. Bütün okuma ve yazma işlemleri bu şirketle sınırlıdır.

Gerekli aralık: x >= 1
X-PeriodID
integer<int32>

Muhasebe döneminin ID'si. İsteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.

Gerekli aralık: x >= 1

Yol Parametreleri

customerId
string<uuid>
gerekli

Cari ID'si.

addressId
string<uuid>
gerekli

Adres ID'si.

Gövde

District
null | string

Zorunlu. GET /api/v1/definitions/districts'ten ilçe adı. İlçe adları il içinde benzersizdir.

Örnek:

"Kadıköy"

City
null | string

İlçenin il adı. Yalnızca aynı ilçe adı birden fazla ilde varsa gereklidir.

Örnek:

"İstanbul"

Country
null | string

İlin ülke adı. Yalnızca aynı il adı birden fazla ülkede varsa gereklidir.

Örnek:

"Türkiye"

Address
null | string

Zorunlu. Açık adres.

Örnek:

"Caferağa Mah. Moda Cad. No: 10"

PostalCode
null | string

Posta kodu.

Örnek:

"34710"

IsInvoiceAddress
boolean

Fatura adresi olup olmadığı. Her carinin tam olarak bir fatura adresi vardır.

Örnek:

true

CoordinateX
null | number<double>

Konum koordinatı X.

Örnek:

40.9877

CoordinateY
null | number<double>

Konum koordinatı Y.

Örnek:

29.0254

Yanıt

OK

Success
boolean
gerekli

İşlemin başarılı olup olmadığı.

Örnek:

true

ResultCode
string
gerekli

Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir.

Örnek:

"0000"

Data
object
gerekli
Message
null | string

Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir.