Sevkiyat tanımı oluştur
curl --request POST \
--url https://api.noyax.com/api/v1/definitions/shipment-definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Code": "5469",
"TransportMode": 1,
"TransportInfo1": "34ABC123"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/shipment-definitions");
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 \"TransportMode\": 1,\n \"TransportInfo1\": \"34ABC123\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({Code: '5469', TransportMode: 1, TransportInfo1: '34ABC123'})
};
fetch('https://api.noyax.com/api/v1/definitions/shipment-definitions', 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"
payload = {
"Code": "5469",
"TransportMode": 1,
"TransportInfo1": "34ABC123"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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": "0537",
"Message": "Driver1FirstName, Driver1LastName and Driver1IdentityNumber are required when no carrier company is used.",
"Errors": [
{
"Code": "0537",
"Message": "Driver1FirstName, Driver1LastName and Driver1IdentityNumber are required when no carrier company is used."
}
]
}{
"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": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Sevkiyat tanımları
Sevkiyat tanımı oluştur
Yeni sevkiyat tanımı ekler.
POST
/
api
/
v1
/
definitions
/
shipment-definitions
Sevkiyat tanımı oluştur
curl --request POST \
--url https://api.noyax.com/api/v1/definitions/shipment-definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Code": "5469",
"TransportMode": 1,
"TransportInfo1": "34ABC123"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/definitions/shipment-definitions");
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 \"TransportMode\": 1,\n \"TransportInfo1\": \"34ABC123\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({Code: '5469', TransportMode: 1, TransportInfo1: '34ABC123'})
};
fetch('https://api.noyax.com/api/v1/definitions/shipment-definitions', 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"
payload = {
"Code": "5469",
"TransportMode": 1,
"TransportInfo1": "34ABC123"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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": "0537",
"Message": "Driver1FirstName, Driver1LastName and Driver1IdentityNumber are required when no carrier company is used.",
"Errors": [
{
"Code": "0537",
"Message": "Driver1FirstName, Driver1LastName and Driver1IdentityNumber are required when no carrier company is used."
}
]
}{
"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": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Codezorunludur ve şirket içinde benzersiz olmalıdır.TransportModezorunludur ve aşağıdaki değerlerden biri olmalıdır.TransportInfo1zorunludur; anlamı taşıma şekline göre değişir (aşağıda).- Sevkiyat ya taşıyıcı firmayla ya da kendi aracınızla yapılır; kurallar aşağıda.
TransportInfo1zorunludur; anlamı taşıma şekline göre değişir (aşağıda).- Sevkiyat ya taşıyıcı firmayla ya da kendi aracınızla yapılır; kurallar aşağıda.
- Diğer alanlar isteğe bağlı serbest metindir; her alanın azami uzunluğu alan açıklamasında yazar. Aşan değerler
0003ile reddedilir.
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.
TransportMode | Taşıma şekli | TransportInfo1 (zorunlu) | TransportInfo2 |
|---|---|---|---|
1 | Karayolu | Plaka | — |
2 | Demiryolu | Tren numarası | Vagon numarası |
3 | Denizyolu | Gemi adı | IMO numarası |
4 | Havayolu | Uçak numarası | — |
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:- Kendi aracı
- Taşıyıcı firma
Taşıyıcı firma alanlarının (
CarrierName, CarrierTaxNumber, CarrierCity, CarrierDistrict, CarrierCountry) hepsi boş bırakılır.Driver1FirstName,Driver1LastNameveDriver1IdentityNumberzorunludur (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.
Taşıyıcı firma alanlarından biri doluysa beşi de zorunludur (
0536).- Sürücü bilgisi gerekmez; gönderilse bile kaydedilmez, yanıtta boş döner.
- Dorse plakaları kaydedilmez.
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.| Kod | HTTP | Anlamı |
|---|---|---|
0002 | 400 | İstek gövdesi okunamadı (bozuk JSON, alan tipi uyumsuz) ya da endpoint’te olmayan bir alan içeriyor |
0003 | 400 | Alan azami uzunluğu aşıyor (mesajda alan adı ve sınır yazar) |
0531 | 400 | Sevkiyat tanımı Code zorunlu |
0532 | 400 | Sevkiyat kodu şirkette başka bir tanımda kullanılıyor; yanıtta var olan kaydın ID’si ExistingId olarak döner |
0533 | 400 | TransportMode 1 (karayolu), 2 (demiryolu), 3 (denizyolu) ya da 4 (havayolu) olmalı |
0535 | 400 | TransportInfo1 zorunlu (plaka, tren, gemi ya da uçak bilgisi) |
0536 | 400 | Taşıyıcı firma alanlarından biri doluysa beşi de zorunlu |
0537 | 400 | Taşıyıcı firma yoksa sürücü 1 bilgileri (ad, soyad, TCKN) zorunlu |
Yetkilendirmeler
Başlıklar
Gövde
application/jsontext/jsonapplication/*+json
Yanıt
Created