Ana içeriğe geç

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.

  • code veya erpCode verilirse 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ıZorunluAçıklama
AuthorizationEvetBearer {AccessToken} formatında geçerli token
Content-TypeEvetapplication/json

Route Parametreleri - Tek Kayıt Getirme

ParametreTipZorunluAçıklama
codestringİkisinden biriAlt bayi üye kodu
erpCodestringİkisinden biriAlt 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

ParametreTipZorunluAçıklama
pageintegerHayırSayfa numarası (varsayılan: 1)
pageSizeintegerHayırSayfa başına kayıt (varsayılan: 10, max: 100)
parentCodestringHayırAna bayi kodu ile filtreleme

Response Body – Vendor (Alt Bayi) Alanları

Alan AdıTipZorunluAçıklama
codestringEvetAlt bayi üye kodu (benzersiz)
companyNamestringEvet (isCompany=true)Kurumsal bayi adı
firstNamestringEvet (isCompany=false)Bireysel bayi adı
lastNamestringEvet (isCompany=false)Bireysel bayi soyadı
emailstringEvetBayi e-posta adresi
mobilestringEvetCep telefonu
phonestringHayırSabit telefon
countryCodeISOstringEvetÜlke kodu (örn. "TR")
cityCodestringHayırŞehir kodu
currencyTypeIdintegerEvetPara birimi ID
erpCodestringEvetERP kodu (benzersiz)
isActivebooleanHayırAktif/pasif durumu
isCompanybooleanEvetKurumsal ise true, bireysel ise false
addressstringHayırAdres
tcknstringEvet (isCompany=false)Bireysel TCKN
taxNumberstringEvet (isCompany=true)Vergi numarası
taxOfficestringEvet (isCompany=true)Vergi dairesi
sendMailbooleanHayırKayıt e-postası gönderilsin mi
addDefaultCurrentAccountbooleanHayırCari hesap otomatik açılsın mı
paymentSetIdstringHayırÖdeme seti ERP kodu
usersarrayHayırAlt bayiye bağlı kullanıcı listesi

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

Alan AdıTipZorunluAçıklama
codestringEvetKullanıcı kodu
firstNamestringEvetKullanıcı adı
lastNamestringEvetKullanıcı soyadı
emailstringEvetKullanıcı e-posta adresi
mobilestringEvetCep telefonu
isActivebooleanHayırAktif/pasif durumu
sendMailbooleanHayırE-posta gönderilsin mi
tcknstringHayırBireysel kullanıcı TCKN
isAdminbooleanHayırYönetici yetkisi
isMobileActivebooleanHayırMobil erişim aktif mi
ruleNamestring[]HayırYetki seti isimleri

{  
"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 taxNumber ve taxOffice zorunludur.
  • 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 Unauthorized döner; yeni token alınarak istek tekrarlanmalıdır.
  • code, erpCode ve mainDealerCode alanlarının benzersiz olması önerilir.