Ana içeriğe atla
PUT
İrsaliye güncelle
İrsaliye için yalnızca açıklayıcı alanlar güncellenebilir: Description, DocumentNumber, ActualDispatchDate, ShipmentDefinitionCode ve SharingCode. Güncelleme bu alanların tam değiştirmesidir: göndermediğiniz alanlar temizlenir. Yalnızca bazılarını değiştirmek için kısmi güncelleme kullanın: PATCH yalnızca gönderdiğiniz alanları değiştirir. Satırlar, cari, tarih ve saat, irsaliye numarası, irsaliye tipi, vade ve tutarlar güncellenemez: istek gövdesinde bunlardan biri varsa istek reddedilir (0002). Bunları düzeltmek için irsaliye silinip yeniden oluşturulur. E-irsaliye olarak gönderilmiş irsaliye silinemez (7019), ama açıklayıcı alanları yine de güncellenebilir.
PUT /api/v1/despatches/{despatchId}

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

despatchId
string<uuid>
gerekli

İrsaliye ID'si.

Gövde

Description
null | string

Açıklama. En fazla 1000 karakter.

DocumentNumber
null | string

Belge numarası (serbest metin). En fazla 100 karakter.

Örnek:

"2026-15"

ActualDispatchDate
null | string<date>

Fiili sevk tarihi. Yalnızca tarih (yyyy-MM-dd), saat içermez.

Örnek:

"2026-10-15"

ShipmentDefinitionCode
null | string

GET /api/v1/definitions/shipment-definitions'tan sevkiyat tanımı kodu.

SharingCode
null | string

İrsaliyeyi kimlerin görebileceğini sınırlayan paylaşım kodu. Boşsa herkes görür; doluysa kullanıcının paylaşım kodlarından biri olmalıdır.

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

Response data. Null when Success is false.

Message
null | string

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