Alt Bayi Listeleme & Detay Getirme
Endpointler
- Tüm alt bayileri listeleme:
GET /vendor/subdealer - Tek alt bayi detayı (code):
GET /vendor/subdealer/{code} - Tek alt bayi detayı (erpCode):
GET /vendor/subdealer/{erpCode}
HTTP Method: GET
Response Content-Type: application/json
Yetkilendirme: Geçerli AccessToken zorunludur.
(Bkz: 2. Kimlik Doğrulama – AccessToken Alınması)
Açıklama
Bu servis ile alt bayi kayıtları listelenebilir veya belirli bir alt bayinin detayları görüntülenebilir.
codeveyaerpCodeverilirse tek kayıt döner.- Parametre verilmezse tüm kayıtlar sayfalandırmalı olarak döner.
- Ana bayi bazlı filtreleme için parentTenantId sorgu parametresi kullanılabilir.
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 | Alt bayi üye kodu |
| erpCode | string | İkisinden biri | Alt bayi ERP kodu |
code veya erpCode’dan yalnızca biri kullanılmalıdır. Hiçbiri verilmezse listeleme çalışır.
Query Parametreleri – Sayfalandırma / Filtreleme
| Parametre | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| page | integer | Hayır | Sayfa numarası (varsayılan: 1) |
| pageSize | integer | Hayır | Sayfa başına kayıt (varsayılan: 10, max: 100) |
| parentCode | string | Hayır | Ana bayi kodu ile filtreleme |
Response Body – Vendor (Alt Bayi) Alanları
| Alan Adı | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| code | string | Evet | Alt bayi üye kodu (benzersiz) |
| companyName | string | Evet (isCompany=true) | Kurumsal bayi adı |
| firstName | string | Evet (isCompany=false) | Bireysel bayi adı |
| lastName | string | Evet (isCompany=false) | Bireysel bayi soyadı |
| string | Evet | Bayi e-posta adresi | |
| mobile | string | Evet | Cep telefonu |
| phone | string | Hayır | Sabit telefon |
| countryCodeISO | string | Evet | Ülke kodu (örn. "TR") |
| cityCode | string | Hayır | Şehir kodu |
| currencyTypeId | integer | Evet | Para birimi ID |
| erpCode | string | Evet | ERP kodu (benzersiz) |
| isActive | boolean | Hayır | Aktif/pasif durumu |
| isCompany | boolean | Evet | Kurumsal ise true, bireysel ise false |
| address | string | Hayır | Adres |
| tckn | string | Evet (isCompany=false) | Bireysel TCKN |
| taxNumber | string | Evet (isCompany=true) | Vergi numarası |
| taxOffice | string | Evet (isCompany=true) | Vergi dairesi |
| sendMail | boolean | Hayır | Kayıt e-postası gönderilsin mi |
| addDefaultCurrentAccount | boolean | Hayır | Cari hesap otomatik açılsın mı |
| paymentSetId | string | Hayır | Ödeme seti ERP kodu |
| users | array | Hayır | Alt bayiye bağlı kullanıcı listesi |
Response Body – User (Alt Bayi Kullanıcı) Alanları
| Alan Adı | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| code | string | Evet | Kullanıcı kodu |
| firstName | string | Evet | Kullanıcı adı |
| lastName | string | Evet | Kullanıcı soyadı |
| string | Evet | Kullanıcı e-posta adresi | |
| mobile | string | Evet | Cep telefonu |
| isActive | boolean | Hayır | Aktif/pasif durumu |
| sendMail | boolean | Hayır | E-posta gönderilsin mi |
| tckn | string | Hayır | Bireysel kullanıcı TCKN |
| isAdmin | boolean | Hayır | Yönetici yetkisi |
| isMobileActive | boolean | Hayır | Mobil erişim aktif mi |
| ruleName | string[] | Hayır | Yetki seti isimleri |
- Örnek Response (Tek Kayıt)
- Örnek Response – Listeleme (Sayfalandırma)
{
"code": "NT10096053",
"name": "test",
"address": null,
"cityCode": null,
"districtCode": null,
"countryCode": null,
"erpCode": null,
"taxNumber": "00000000000",
"taxOffice": null,
"isCompany": false,
"paymentSetId": "00cfced3-c429-444e-8125-fff3a7fb553a",
"usablePaymentSetDefinitionIds": [],
"parentTenantId": "7c394922-d312-4f91-8a9a-31e349d94380",
"customerRepresentativeIds": [
"b7ec27b3-2594-4f75-8b8e-9c8b8dd6dfec"
],
"currenyCode": null,
"isActive": true,
"users": [
{
"userCode": null,
"name": "test",
"surname": "Müşteri",
"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": "00cfced3-c429-444e-8125-fff3a7fb553a",
"roles": [
"BACD5D2B-2021-4FAD-AD93-D38BEE2877C6"
],
"canUseMobile": true,
"id": "b9b7ec52-a5eb-4d13-885b-3157b8174d92"
}
]
}
{
"data": [
{
"code": "NT10096053",
"name": "test",
"address": null,
"cityCode": null,
"districtCode": null,
"countryCode": null,
"erpCode": null,
"taxNumber": "00000000000",
"taxOffice": null,
"isCompany": false,
"paymentSetId": "00cfced3-c429-444e-8125-fff3a7fb553a",
"usablePaymentSetDefinitionIds": [],
"parentTenantId": "7c394922-d312-4f91-8a9a-31e349d94380",
"customerRepresentativeIds": [
"b7ec27b3-2594-4f75-8b8e-9c8b8dd6dfec"
],
"currenyCode": null,
"isActive": true,
"users": [
{
"userCode": null,
"name": "test",
"surname": "Müşteri",
"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": "00cfced3-c429-444e-8125-fff3a7fb553a",
"roles": [
"BACD5D2B-2021-4FAD-AD93-D38BEE2877C6"
],
"canUseMobile": true,
"id": "b9b7ec52-a5eb-4d13-885b-3157b8174d92"
}
]
}
]
}
Not: Listeleme yanıtında alan seti örnek amaçlı sadeleştirilmiştir; kurulumunuza göre geniş alan dönebilir.
### Notlar & En İyi Uygulamalar {#notes-and-best-practices}
- mainDealerCode alanı zorunludur. Alt bayi mutlaka bir ana bayiye bağlı olmalıdır.
- isCompany = true (kurumsal) olduğunda
taxNumbervetaxOfficezorunludur. - usablePaymentSetDefinitionIds bir liste olarak birden fazla ödeme seti tanımını destekler.
- sendMail = true ise, oluşturulan kullanıcı(lar)a sistem e-postası gönderilir.
- Token süresi dolduğunda istek
401 Unauthorizeddöner; yeni token alınarak istek tekrarlanmalıdır. code,erpCodevemainDealerCodealanlarının benzersiz olması önerilir.