Ana içeriğe geç

Bayi Listeleme & Detay Getirme

Endpointler​

  • Tüm bayileri listeleme: GET /vendor/dealer
  • Tek bayi detayı (code): GET /vendor/dealer/{code}
  • Tek bayi detayı (erpCode): GET /vendor/dealer/{erpCode}

HTTP Method: GET
Request Content-Type: application/json
Response Content-Type: application/json
Yetkilendirme: Geçerli AccessToken zorunludur.
(Bkz: 2. Kimlik Doğrulama – AccessToken Alınması)

Açıklama​

Bu servis aracılığıyla sistemdeki bayi kayıtları listelenebilir veya tek bir bayinin detay bilgisi görüntülenebilir.

  • code veya erpCode parametresi ile arama yapılırsa yalnızca tek bir bayi bilgisi döner.
  • Parametre verilmezse sistem, tüm bayileri sayfalandırmalı şekilde döndürür.
  • Aynı anda birden fazla parametre kullanılamaz.

Header Bilgileri​

Header AdıZorunluAçıklama
AuthorizationEvetBearer {AccessToken} formatında geçerli token
Content-TypeEvetapplication/json

Route Parametreleri - Tek Kayıt Getirme​

ParametreTipZorunluAçıklama
codestringİkisinden biri zorunluBayi kullanıcı kodu
erpCodestringİkisinden biri zorunluBayi ERP kodu

code veya erpCode parametrelerinden yalnızca biri kullanılmalıdır.

Query Parametreleri – Sayfalandırma (Listeleme)​

ParametreTipZorunluAçıklama
pageintegerHayırGetirilecek sayfa numarası (varsayılan: 1)
pageSizeintegerHayırSayfa başına kayıt sayısı (varsayılan: 10, maksimum: 100)

Response Body – Vendor (Bayi) Alanları​

Alan AdıTipZorunluAçıklama
codestringEvetBayi kullanıcı kodu (benzersiz)
namestringEvetBayi adı (bireysel veya kurumsal)
addressstringHayırBayi adres bilgisi
cityCodestringHayırŞehir kodu
districtCodestringHayırİlçe kodu
countryCodestringEvetÜlke kodu (örn. "TR")
erpCodestringEvetERP kodu (benzersiz)
taxNumberstringŞarta bağlıVergi numarası (isCompany = true ise zorunlu)
taxOfficestringŞarta bağlıVergi dairesi (isCompany = true ise zorunlu)
isCompanybooleanEvetKurumsal ise true, bireysel ise false
isIndividualbooleanEvetBireysel müşteri ise true
isForeignNationalbooleanHayırYabancı uyruklu mu
phonestringHayırTelefon numarası
paymentSetDefinitionIdstringHayırÖdeme seti tanımı ID
usablePaymentSetDefinitionIdsarrayHayırKullanılabilir ödeme seti tanımları
paymentExCurrencyTypestringHayırÖdeme döviz tipi
parentTenantIdstringHayırÜst bayi/müşteri ID
customerRepresentativeIdsarrayHayırMüşteri temsilcisi ID listesi
isActivebooleanHayırAktif/pasif durumu
usersarrayHayırBayi kullanıcı listesi

Response Body – User (Bayi Kullanıcı) Alanları​

Alan AdıTipZorunluAçıklama
userCodestringEvetKullanıcı kodu
namestringEvetKullanıcı adı
surnamestringEvetKullanıcı soyadı
emailstringEvetKullanıcı e-posta adresi
gsmstringEvetCep telefonu
titlestringHayırÜnvan
descriptionstringHayırAçıklama
erpCodestringHayırERP kodu
isActivebooleanHayırAktif/pasif durumu
isIndividualbooleanEvetBireysel kullanıcı mı
isForeignNationalbooleanHayırYabancı uyruklu mu
paymentExCurrencyTypestringHayırÖdeme döviz tipi
rolesarrayHayırRol listesi
sendRegisterMailbooleanHayırKayıt maili gönderilsin mi
taxNumberstringŞarta bağlıVergi numarası (isCompany = true ise zorunlu)
taxOfficestringŞarta bağlıVergi dairesi (isCompany = true ise zorunlu)
userTypestringHayırKullanıcı tipi
canUseMobilebooleanHayırMobil kullanım izni
{  
"status": "success",
"dealer": {
"code": "601",
"name": "test bayisi vendor01101",
"address": "test1111",
"cityCode": "10",
"districtCode": 494,
"countryCode": "TKM",
"erpCode": "601",
"taxNumber": "00000000000",
"taxOffice": null,
"isCompany": false,
"paymentSetId": null,
"usablePaymentSetDefinitionIds": [
"958949df-0d90-4851-bcb8-1acb62c4dc95",
"79ce2e5f-51cb-4d29-beca-955685e86c50"
],
"parentTenantId": "670683c1-2fe0-4846-87b2-6cba9b793ab2",
"customerRepresentativeIds": [
"c0dc9553-4bb7-4611-9e93-1d58c65a3fa6",
"4b80f492-ed80-445d-943f-2125125e3667"
],
"currenyCode": null,
"isActive": true,
"users": []
}
}
{  
"data": [
{
"code": "NT23421002",
"name": "Test Bayisi 0704",
"address": null,
"cityCode": null,
"districtCode": null,
"countryCode": null,
"erpCode": null,
"taxNumber": "00000000000",
"taxOffice": null,
"isCompany": false,
"paymentSetId": "504978bf-bebd-40c5-89aa-b76f3a20341c",
"usablePaymentSetDefinitionIds": [],
"parentTenantId": "670683c1-2fe0-4846-87b2-6cba9b793ab2",
"customerRepresentativeIds": [
"55f45998-2e72-47e6-97c6-2645e207fe3c"
],
"currenyCode": null,
"isActive": true,
"users": [
{
"userCode": "",
"name": "Test ",
"surname": "Bayisi",
"email": "[email protected]",
"gsm": "5000000000",
"title": null,
"description": "",
"erpCode": "",
"isActive": true,
"isCompany": false,
"phone": null,
"countryCode": null,
"cityCode": null,
"currenyCode": null,
"address": null,
"isForeignNational": false,
"tckn": "00000000000",
"paymentSetId": "504978bf-bebd-40c5-89aa-b76f3a20341c",
"roles": [
"A5A29750-5D00-43CF-BEB9-8A8B8EC2781E"
],
"canUseMobile": true,
"id": "aa167cfa-ca39-4d98-8930-aebb107d16c9"
}
]
}
]
}

Notlar​

  • Eğer page veya pageSize parametreleri verilmezse varsayılan olarak page=1, pageSize=10 değerleri kullanılır.

  • code veya erpCode kullanılarak sorgulama yapılırsa yalnızca tek kayıt döner.

  • isCompany alanı true olan bayilerde taxNumber ve taxOffice zorunludur.

  • users dizisi, bayiye ait kullanıcıları içerir ve boş olabilir.

  • usablePaymentSetDefinitionIds parametresi birden fazla ödeme seti tanımı destekler.