Carileri listele
curl --request GET \
--url https://api.noyax.com/api/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers");
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>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'GET',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.noyax.com/api/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers"
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Page": 1,
"PageSize": 50,
"TotalCount": 128,
"Items": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ShipmentDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerCode": "0000382026",
"Name": "Örnek Ticaret A.Ş.",
"TaxNumber": "1234567890",
"TaxOffice": "Kadıköy",
"InvoiceTitle": "Örnek Ticaret Anonim Şirketi",
"Note": "Deliveries on weekdays only.",
"DueDays": 30,
"DiscountRate": 5,
"Blacklisted": false,
"MovementType": 2,
"RiskLimit": 250000,
"RiskControl": 1,
"RiskAction": 1,
"EInvoiceUser": true,
"EInvoiceScenario": 1,
"ShipmentDefinitionCode": "KARAYOLU-1",
"SharingCode": "<string>",
"ShowNoteOnQuote": false,
"ShowNoteOnOrder": false,
"ShowNoteOnDespatch": true,
"ShowNoteOnInvoice": false,
"IdentitySchemes": [
{
"Value": "0123456789000015",
"SchemeID": "MERSISNO"
}
],
"CreateDate": "2023-11-07T05:31:56Z",
"ModifyDate": "2023-11-07T05:31:56Z",
"Emails": [
"[email protected]"
],
"Telephones": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Number": "02165550000",
"NumberType": 1,
"Extension": "101",
"Description": "Accounting"
}
],
"GroupMembers": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupDetail": "Marmara",
"GroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Group": "Region"
}
]
}
]
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0201",
"Message": "X-UserID header is required.",
"Errors": [
{
"Code": "0201",
"Message": "X-UserID header is required."
}
]
}{
"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."
}
]
}Cari işlemleri
Cari listesi
Carileri sayfa sayfa listeler.
GET
/
api
/
v1
/
customers
Carileri listele
curl --request GET \
--url https://api.noyax.com/api/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers");
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>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'GET',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.noyax.com/api/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers"
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Page": 1,
"PageSize": 50,
"TotalCount": 128,
"Items": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ShipmentDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerCode": "0000382026",
"Name": "Örnek Ticaret A.Ş.",
"TaxNumber": "1234567890",
"TaxOffice": "Kadıköy",
"InvoiceTitle": "Örnek Ticaret Anonim Şirketi",
"Note": "Deliveries on weekdays only.",
"DueDays": 30,
"DiscountRate": 5,
"Blacklisted": false,
"MovementType": 2,
"RiskLimit": 250000,
"RiskControl": 1,
"RiskAction": 1,
"EInvoiceUser": true,
"EInvoiceScenario": 1,
"ShipmentDefinitionCode": "KARAYOLU-1",
"SharingCode": "<string>",
"ShowNoteOnQuote": false,
"ShowNoteOnOrder": false,
"ShowNoteOnDespatch": true,
"ShowNoteOnInvoice": false,
"IdentitySchemes": [
{
"Value": "0123456789000015",
"SchemeID": "MERSISNO"
}
],
"CreateDate": "2023-11-07T05:31:56Z",
"ModifyDate": "2023-11-07T05:31:56Z",
"Emails": [
"[email protected]"
],
"Telephones": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Number": "02165550000",
"NumberType": 1,
"Extension": "101",
"Description": "Accounting"
}
],
"GroupMembers": [
{
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupDetailId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"GroupDetail": "Marmara",
"GroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Group": "Region"
}
]
}
]
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "0201",
"Message": "X-UserID header is required.",
"Errors": [
{
"Code": "0201",
"Message": "X-UserID header is required."
}
]
}{
"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."
}
]
}Sonuçlar
Data.Items içinde döner. pageSize en fazla 50 olabilir; daha büyük bir değer gönderilirse 50 kullanılır. search adında metni içeren ya da cari kodu, vergi numarası veya e-posta adreslerinden biri (e-posta tipindeki linkler) metnin tam kendisi olan carileri bulur. Ayrıntılar için Sayfalama ve arama.
Her cari, e-posta adresleri (Emails, e-posta tipindeki linkler), telefon numaraları (Telephones) ve grup üyelikleriyle (GroupMembers) birlikte döner. Diğer alt kayıtlar (adres, yetkili, banka hesabı, …) liste yanıtında yer almaz; bunlar için cari detayı kullanılır.
Hata kodları
Bu endpoint’e özel bir hata kodu yoktur. Her endpoint için geçerli olan genel hatalar (kimlik doğrulama, yetki, istek header’ları, istek limitleri) yine geçerlidir.Yetkilendirmeler
Başlıklar
Sorgu Parametreleri
Yanıt
OK