curl --request PATCH \
--url https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Code": "5469",
"Description": "Istanbul road shipments",
"TransportMode": 1,
"TransportInfo1": "34ABC123",
"TransportInfo2": "<string>",
"CarrierName": "Example Logistics Ltd.",
"CarrierTaxNumber": "1234567890",
"CarrierCity": "ISTANBUL",
"CarrierDistrict": "KADIKÖY",
"CarrierCountry": "TÜRKİYE",
"Driver1FirstName": "Ahmet",
"Driver1LastName": "Kaya",
"Driver1IdentityNumber": "12345678901",
"Driver2FirstName": "<string>",
"Driver2LastName": "<string>",
"Driver2IdentityNumber": "<string>",
"TrailerPlate1": "34ABC123",
"TrailerPlate2": "<string>"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"Code\": \"5469\",\n \"Description\": \"Istanbul road shipments\",\n \"TransportMode\": 1,\n \"TransportInfo1\": \"34ABC123\",\n \"TransportInfo2\": \"<string>\",\n \"CarrierName\": \"Example Logistics Ltd.\",\n \"CarrierTaxNumber\": \"1234567890\",\n \"CarrierCity\": \"ISTANBUL\",\n \"CarrierDistrict\": \"KADIKÖY\",\n \"CarrierCountry\": \"TÜRKİYE\",\n \"Driver1FirstName\": \"Ahmet\",\n \"Driver1LastName\": \"Kaya\",\n \"Driver1IdentityNumber\": \"12345678901\",\n \"Driver2FirstName\": \"<string>\",\n \"Driver2LastName\": \"<string>\",\n \"Driver2IdentityNumber\": \"<string>\",\n \"TrailerPlate1\": \"34ABC123\",\n \"TrailerPlate2\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'PATCH',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
Code: '5469',
Description: 'Istanbul road shipments',
TransportMode: 1,
TransportInfo1: '34ABC123',
TransportInfo2: '<string>',
CarrierName: 'Example Logistics Ltd.',
CarrierTaxNumber: '1234567890',
CarrierCity: 'ISTANBUL',
CarrierDistrict: 'KADIKÖY',
CarrierCountry: 'TÜRKİYE',
Driver1FirstName: 'Ahmet',
Driver1LastName: 'Kaya',
Driver1IdentityNumber: '12345678901',
Driver2FirstName: '<string>',
Driver2LastName: '<string>',
Driver2IdentityNumber: '<string>',
TrailerPlate1: '34ABC123',
TrailerPlate2: '<string>'
})
};
fetch('https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}"
payload = {
"Code": "5469",
"Description": "Istanbul road shipments",
"TransportMode": 1,
"TransportInfo1": "34ABC123",
"TransportInfo2": "<string>",
"CarrierName": "Example Logistics Ltd.",
"CarrierTaxNumber": "1234567890",
"CarrierCity": "ISTANBUL",
"CarrierDistrict": "KADIKÖY",
"CarrierCountry": "TÜRKİYE",
"Driver1FirstName": "Ahmet",
"Driver1LastName": "Kaya",
"Driver1IdentityNumber": "12345678901",
"Driver2FirstName": "<string>",
"Driver2LastName": "<string>",
"Driver2IdentityNumber": "<string>",
"TrailerPlate1": "34ABC123",
"TrailerPlate2": "<string>"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Code": "5469",
"Description": "Istanbul road shipments",
"TransportMode": 1,
"TransportInfo1": "34ABC123",
"TransportInfo2": "<string>",
"CarrierName": "Example Logistics Ltd.",
"CarrierTaxNumber": "1234567890",
"CarrierCity": "ISTANBUL",
"CarrierDistrict": "KADIKÖY",
"CarrierCountry": "TÜRKİYE",
"Driver1FirstName": "Ahmet",
"Driver1LastName": "Kaya",
"Driver1IdentityNumber": "12345678901",
"Driver2FirstName": "<string>",
"Driver2LastName": "<string>",
"Driver2IdentityNumber": "<string>",
"TrailerPlate1": "34ABC123",
"TrailerPlate2": "<string>"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0533",
"Message": "TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air).",
"Errors": [
{
"Code": "0533",
"Message": "TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air)."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "0530",
"Message": "Shipment definition not found.",
"Errors": [
{
"Code": "0530",
"Message": "Shipment definition not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Sevkiyat tanımı kısmi güncelle
Sevkiyat tanımı kaydının yalnızca gönderilen alanlarını değiştirir.
curl --request PATCH \
--url https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Code": "5469",
"Description": "Istanbul road shipments",
"TransportMode": 1,
"TransportInfo1": "34ABC123",
"TransportInfo2": "<string>",
"CarrierName": "Example Logistics Ltd.",
"CarrierTaxNumber": "1234567890",
"CarrierCity": "ISTANBUL",
"CarrierDistrict": "KADIKÖY",
"CarrierCountry": "TÜRKİYE",
"Driver1FirstName": "Ahmet",
"Driver1LastName": "Kaya",
"Driver1IdentityNumber": "12345678901",
"Driver2FirstName": "<string>",
"Driver2LastName": "<string>",
"Driver2IdentityNumber": "<string>",
"TrailerPlate1": "34ABC123",
"TrailerPlate2": "<string>"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"Code\": \"5469\",\n \"Description\": \"Istanbul road shipments\",\n \"TransportMode\": 1,\n \"TransportInfo1\": \"34ABC123\",\n \"TransportInfo2\": \"<string>\",\n \"CarrierName\": \"Example Logistics Ltd.\",\n \"CarrierTaxNumber\": \"1234567890\",\n \"CarrierCity\": \"ISTANBUL\",\n \"CarrierDistrict\": \"KADIKÖY\",\n \"CarrierCountry\": \"TÜRKİYE\",\n \"Driver1FirstName\": \"Ahmet\",\n \"Driver1LastName\": \"Kaya\",\n \"Driver1IdentityNumber\": \"12345678901\",\n \"Driver2FirstName\": \"<string>\",\n \"Driver2LastName\": \"<string>\",\n \"Driver2IdentityNumber\": \"<string>\",\n \"TrailerPlate1\": \"34ABC123\",\n \"TrailerPlate2\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'PATCH',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
Code: '5469',
Description: 'Istanbul road shipments',
TransportMode: 1,
TransportInfo1: '34ABC123',
TransportInfo2: '<string>',
CarrierName: 'Example Logistics Ltd.',
CarrierTaxNumber: '1234567890',
CarrierCity: 'ISTANBUL',
CarrierDistrict: 'KADIKÖY',
CarrierCountry: 'TÜRKİYE',
Driver1FirstName: 'Ahmet',
Driver1LastName: 'Kaya',
Driver1IdentityNumber: '12345678901',
Driver2FirstName: '<string>',
Driver2LastName: '<string>',
Driver2IdentityNumber: '<string>',
TrailerPlate1: '34ABC123',
TrailerPlate2: '<string>'
})
};
fetch('https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/definitions/shipment-definitions/{shipmentDefinitionId}"
payload = {
"Code": "5469",
"Description": "Istanbul road shipments",
"TransportMode": 1,
"TransportInfo1": "34ABC123",
"TransportInfo2": "<string>",
"CarrierName": "Example Logistics Ltd.",
"CarrierTaxNumber": "1234567890",
"CarrierCity": "ISTANBUL",
"CarrierDistrict": "KADIKÖY",
"CarrierCountry": "TÜRKİYE",
"Driver1FirstName": "Ahmet",
"Driver1LastName": "Kaya",
"Driver1IdentityNumber": "12345678901",
"Driver2FirstName": "<string>",
"Driver2LastName": "<string>",
"Driver2IdentityNumber": "<string>",
"TrailerPlate1": "34ABC123",
"TrailerPlate2": "<string>"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Code": "5469",
"Description": "Istanbul road shipments",
"TransportMode": 1,
"TransportInfo1": "34ABC123",
"TransportInfo2": "<string>",
"CarrierName": "Example Logistics Ltd.",
"CarrierTaxNumber": "1234567890",
"CarrierCity": "ISTANBUL",
"CarrierDistrict": "KADIKÖY",
"CarrierCountry": "TÜRKİYE",
"Driver1FirstName": "Ahmet",
"Driver1LastName": "Kaya",
"Driver1IdentityNumber": "12345678901",
"Driver2FirstName": "<string>",
"Driver2LastName": "<string>",
"Driver2IdentityNumber": "<string>",
"TrailerPlate1": "34ABC123",
"TrailerPlate2": "<string>"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0533",
"Message": "TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air).",
"Errors": [
{
"Code": "0533",
"Message": "TransportMode must be 1 (road), 2 (rail), 3 (maritime) or 4 (air)."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "0530",
"Message": "Shipment definition not found.",
"Errors": [
{
"Code": "0530",
"Message": "Shipment definition not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}- Gönderilmeyen alan değişmez,
nullgönderilen alan temizlenir. - Doğrulama birleştirilmiş kaydın tamamı üzerinde çalışır; zorunlu bir alanı
nullyaparsanız istek reddedilir. - Taşıyıcı firma ve sürücü kuralları birleştirilmiş kayıt üzerinde kontrol edilir: taşıyıcı firma alanlarından yalnızca birini
nullyaparsanız istek reddedilir.
Yetkilendirmeler
Access token obtained from the Noyax auth service with your API key.
Başlıklar
İ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.
x >= 1Ş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.
x >= 1Muhasebe döneminin ID'si. Cari endpoint'lerinde isteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.
x >= 1Yol Parametreleri
Sevkiyat tanımı ID'si.
Gövde
Zorunlu. Sevkiyat kodu, şirket içinde benzersiz olmalıdır. En fazla 50 karakter.
"5469"
Açıklama. En fazla 255 karakter.
"Istanbul road shipments"
Zorunlu. 1: Karayolu, 2: Demiryolu, 3: Denizyolu, 4: Havayolu. TransportInfo1 ve TransportInfo2 alanlarının anlamını belirler.
1
Zorunlu. Taşıma şekline göre araç bilgisi: 1 plaka, 2 tren numarası, 3 gemi adı, 4 uçak numarası. En fazla 50 karakter.
"34ABC123"
İ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.
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.
"Example Logistics Ltd."
Taşıyıcı firmanın vergi numarası. En fazla 50 karakter.
"1234567890"
Taşıyıcı firmanın ili. En fazla 50 karakter.
"ISTANBUL"
Taşıyıcı firmanın ilçesi. En fazla 50 karakter.
"KADIKÖY"
Taşıyıcı firmanın ülkesi. En fazla 50 karakter.
"TÜRKİYE"
- sürücünün adı. Taşıyıcı firma yoksa zorunludur. Taşıyıcı firma varsa kaydedilmez. En fazla 50 karakter.
"Ahmet"
- sürücünün soyadı. Taşıyıcı firma yoksa zorunludur. En fazla 20 karakter.
"Kaya"
- sürücünün T.C. kimlik numarası. Taşıyıcı firma yoksa zorunludur. En fazla 20 karakter.
"12345678901"
- sürücünün adı. En fazla 50 karakter.
- sürücünün soyadı. En fazla 20 karakter.
- sürücünün T.C. kimlik numarası. En fazla 20 karakter.
Dorse plakası 1. Yalnızca TransportMode 1 (karayolu) ve taşıyıcı firma yokken kaydedilir. En fazla 20 karakter.
"34ABC123"
Dorse plakası 2. Yalnızca TransportMode 1 (karayolu) ve taşıyıcı firma yokken kaydedilir. En fazla 20 karakter.
Yanıt
OK
İşlemin başarılı olup olmadığı.
true
Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir.
"0000"
Show child attributes
Show child attributes
Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir.