Skip to main content
PUT
Sevkiyat tanımını güncelle
Tek tek alan değiştirecekseniz kısmi güncellemeyi kullanın: PATCH yalnızca gönderdiğiniz alanları değiştirir. Güncelleme tam değiştirme şeklinde çalışır: gönderilmeyen alanlar temizlenir.
  • Code zorunludur ve şirket içinde benzersiz olmalıdır.
  • TransportMode ve TransportInfo1 zorunludur.
  • Taşıyıcı firma / kendi aracı kuralları oluşturmadaki gibidir (aşağıda).
TransportInfo1 ve TransportInfo2 alanlarının anlamı taşıma şekline göre değişir; Noyax ekranında da bu alanların etiketi buna göre değişir. Bu bilgiler e-irsaliyeye taşıma bilgisi olarak yazılır. İkinci alan yalnızca demiryolu ve denizyolunda vardır; karayolu ve havayolunda TransportInfo2 gönderilse bile kaydedilmez.

Taşıyıcı firma mı, kendi aracınız mı?

Bir sevkiyat ya taşıyıcı bir firmayla ya da şirketin kendi aracıyla yapılır. API bunu ayrı bir alanla değil, taşıyıcı firma alanlarının dolu olup olmamasıyla anlar:
Taşıyıcı firma alanlarının (CarrierName, CarrierTaxNumber, CarrierCity, CarrierDistrict, CarrierCountry) hepsi boş bırakılır.
  • Driver1FirstName, Driver1LastName ve Driver1IdentityNumber zorunludur (0537).
  • Driver2* alanları isteğe bağlıdır.
  • Dorse plakaları yalnızca karayolunda (TransportMode: 1) kaydedilir; diğer taşıma şekillerinde gönderilseler bile boş kalır.

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. Cari endpoint'lerinde isteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.

Gerekli aralık: x >= 1

Yol Parametreleri

shipmentDefinitionId
string<uuid>
gerekli

Sevkiyat tanımı ID'si.

Gövde

Code
null | string

Zorunlu. Sevkiyat kodu, şirket içinde benzersiz olmalıdır. En fazla 50 karakter.

Örnek:

"5469"

Description
null | string

Açıklama. En fazla 255 karakter.

Örnek:

"Istanbul road shipments"

TransportMode
integer<int32>

Zorunlu. 1: Karayolu, 2: Demiryolu, 3: Denizyolu, 4: Havayolu. TransportInfo1 ve TransportInfo2 alanlarının anlamını belirler.

Örnek:

1

TransportInfo1
null | string

Zorunlu. Taşıma şekline göre araç bilgisi: 1 plaka, 2 tren numarası, 3 gemi adı, 4 uçak numarası. En fazla 50 karakter.

Örnek:

"34ABC123"

TransportInfo2
null | string

İkinci taşıma bilgisi; yalnızca TransportMode 2 (vagon numarası) ya da 3 (IMO numarası) iken kullanılır. 1 (karayolu) ve 4 (havayolu) için kaydedilmez. En fazla 50 karakter.

CarrierName
null | string

Taşıyıcı firma adı. Sevkiyat taşıyıcı firmayla yapılıyorsa diğer Carrier* alanlarıyla birlikte zorunludur; kendi aracınız için hepsini boş bırakın. En fazla 75 karakter.

Örnek:

"Example Logistics Ltd."

CarrierTaxNumber
null | string

Taşıyıcı firmanın vergi numarası. En fazla 50 karakter.

Örnek:

"1234567890"

CarrierCity
null | string

Taşıyıcı firmanın ili. En fazla 50 karakter.

Örnek:

"ISTANBUL"

CarrierDistrict
null | string

Taşıyıcı firmanın ilçesi. En fazla 50 karakter.

Örnek:

"KADIKÖY"

CarrierCountry
null | string

Taşıyıcı firmanın ülkesi. En fazla 50 karakter.

Örnek:

"TÜRKİYE"

Driver1FirstName
null | string
  1. sürücünün adı. Taşıyıcı firma yoksa zorunludur. Taşıyıcı firma varsa kaydedilmez. En fazla 50 karakter.
Örnek:

"Ahmet"

Driver1LastName
null | string
  1. sürücünün soyadı. Taşıyıcı firma yoksa zorunludur. En fazla 20 karakter.
Örnek:

"Kaya"

Driver1IdentityNumber
null | string
  1. sürücünün T.C. kimlik numarası. Taşıyıcı firma yoksa zorunludur. En fazla 20 karakter.
Örnek:

"12345678901"

Driver2FirstName
null | string
  1. sürücünün adı. En fazla 50 karakter.
Driver2LastName
null | string
  1. sürücünün soyadı. En fazla 20 karakter.
Driver2IdentityNumber
null | string
  1. sürücünün T.C. kimlik numarası. En fazla 20 karakter.
TrailerPlate1
null | string

Dorse plakası 1. Yalnızca TransportMode 1 (karayolu) ve taşıyıcı firma yokken kaydedilir. En fazla 20 karakter.

Örnek:

"34ABC123"

TrailerPlate2
null | string

Dorse plakası 2. Yalnızca TransportMode 1 (karayolu) ve taşıyıcı firma yokken kaydedilir. En fazla 20 karakter.

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.