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.
codeveyaerpCodeparametresi 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ı | Zorunlu | Açıklama |
|---|---|---|
| Authorization | Evet | Bearer {AccessToken} formatında geçerli token |
| Content-Type | Evet | application/json |
Route Parametreleri - Tek Kayıt Getirme
| Parametre | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| code | string | İkisinden biri zorunlu | Bayi kullanıcı kodu |
| erpCode | string | İkisinden biri zorunlu | Bayi ERP kodu |
code veya erpCode parametrelerinden yalnızca biri kullanılmalıdır.
Query Parametreleri – Sayfalandırma (Listeleme)
| Parametre | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| page | integer | Hayır | Getirilecek sayfa numarası (varsayılan: 1) |
| pageSize | integer | Hayır | Sayfa başına kayıt sayısı (varsayılan: 10, maksimum: 100) |
Response Body – Vendor (Bayi) Alanları
| Alan Adı | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| code | string | Evet | Bayi kullanıcı kodu (benzersiz) |
| name | string | Evet | Bayi adı (bireysel veya kurumsal) |
| address | string | Hayır | Bayi adres bilgisi |
| cityCode | string | Hayır | Şehir kodu |
| districtCode | string | Hayır | İlçe kodu |
| countryCode | string | Evet | Ülke kodu (örn. "TR") |
| erpCode | string | Evet | ERP kodu (benzersiz) |
| taxNumber | string | Şarta bağlı | Vergi numarası (isCompany = true ise zorunlu) |
| taxOffice | string | Şarta bağlı | Vergi dairesi (isCompany = true ise zorunlu) |
| isCompany | boolean | Evet | Kurumsal ise true, bireysel ise false |
| isIndividual | boolean | Evet | Bireysel müşteri ise true |
| isForeignNational | boolean | Hayır | Yabancı uyruklu mu |
| phone | string | Hayır | Telefon numarası |
| paymentSetDefinitionId | string | Hayır | Ödeme seti tanımı ID |
| usablePaymentSetDefinitionIds | array | Hayır | Kullanılabilir ödeme seti tanımları |
| paymentExCurrencyType | string | Hayır | Ödeme döviz tipi |
| parentTenantId | string | Hayır | Üst bayi/müşteri ID |
| customerRepresentativeIds | array | Hayır | Müşteri temsilcisi ID listesi |
| isActive | boolean | Hayır | Aktif/pasif durumu |
| users | array | Hayır | Bayi kullanıcı listesi |
Response Body – User (Bayi Kullanıcı) Alanları
| Alan Adı | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| userCode | string | Evet | Kullanıcı kodu |
| name | string | Evet | Kullanıcı adı |
| surname | string | Evet | Kullanıcı soyadı |
| string | Evet | Kullanıcı e-posta adresi | |
| gsm | string | Evet | Cep telefonu |
| title | string | Hayır | Ünvan |
| description | string | Hayır | Açıklama |
| erpCode | string | Hayır | ERP kodu |
| isActive | boolean | Hayır | Aktif/pasif durumu |
| isIndividual | boolean | Evet | Bireysel kullanıcı mı |
| isForeignNational | boolean | Hayır | Yabancı uyruklu mu |
| paymentExCurrencyType | string | Hayır | Ödeme döviz tipi |
| roles | array | Hayır | Rol listesi |
| sendRegisterMail | boolean | Hayır | Kayıt maili gönderilsin mi |
| taxNumber | string | Şarta bağlı | Vergi numarası (isCompany = true ise zorunlu) |
| taxOffice | string | Şarta bağlı | Vergi dairesi (isCompany = true ise zorunlu) |
| userType | string | Hayır | Kullanıcı tipi |
| canUseMobile | boolean | Hayır | Mobil kullanım izni |
- Örnek Yanıt (Tekli)
- Örnek cURL (Tekli)
{
"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": []
}
}
curl --location 'https://pgw.netahsilatdemo.com/vendor/dealer/601' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJwd3N2MS5hcGkiLCJlcnB2MS5hcGkiLCJjYXR2MS5hcGkiLCJ2ZW5kb3J2MS5hcGkiXSwiYWN0b3J0Ijoic2VydmljZSIsInJvbGUiOiJzZXJ2aWNlIiwiVW5pcXVlIjoiYTI3NmYyOGEtOWMwYS00NGYxLWIxNjgtMTJiMGY3NTEwMWYzIiwiVGVuYW50SWQiOiI2NzA2ODNjMS0yZmUwLTQ4NDYtODdiMi02Y2JhOWI3OTNhYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL2V4cGlyYXRpb24iOiI2Mzg5NjE5NDQzNzQ5NjM1ODYiLCJuYmYiOjE3NjA0MjQ4MzcsImV4cCI6MTc2MDU5NzYzNywiaWF0IjoxNzYwNDI0ODM3LCJpc3MiOiJzc28uYXBpIiwiYXVkIjoiZWNvenVtLnNzbyJ9.G0FFvRyNF_qCYQvUjvDWzGuf05JpJujSgC5ZMV9_BIQ'
- Örnek Yanıt (Çoklu)
- Örnek cURL (Çoklu)
{
"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"
}
]
}
]
}
curl --location 'https://pgw.netahsilatdemo.com/vendor/dealer?page=1&pageSize=10' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJwd3N2MS5hcGkiLCJlcnB2MS5hcGkiLCJjYXR2MS5hcGkiLCJ2ZW5kb3J2MS5hcGkiXSwiYWN0b3J0Ijoic2VydmljZSIsInJvbGUiOiJzZXJ2aWNlIiwiVW5pcXVlIjoiYTI3NmYyOGEtOWMwYS00NGYxLWIxNjgtMTJiMGY3NTEwMWYzIiwiVGVuYW50SWQiOiI2NzA2ODNjMS0yZmUwLTQ4NDYtODdiMi02Y2JhOWI3OTNhYjIiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL2V4cGlyYXRpb24iOiI2Mzg5NjE5NDQzNzQ5NjM1ODYiLCJuYmYiOjE3NjA0MjQ4MzcsImV4cCI6MTc2MDU5NzYzNywiaWF0IjoxNzYwNDI0ODM3LCJpc3MiOiJzc28uYXBpIiwiYXVkIjoiZWNvenVtLnNzbyJ9.G0FFvRyNF_qCYQvUjvDWzGuf05JpJujSgC5ZMV9_BIQ'
Notlar
-
Eğer
pageveyapageSizeparametreleri verilmezse varsayılan olarakpage=1,pageSize=10değerleri kullanılır. -
codeveyaerpCodekullanılarak sorgulama yapılırsa yalnızca tek kayıt döner. -
isCompanyalanıtrueolan bayilerdetaxNumbervetaxOfficezorunludur. -
usersdizisi, bayiye ait kullanıcıları içerir ve boş olabilir. -
usablePaymentSetDefinitionIdsparametresi birden fazla ödeme seti tanımı destekler.