Alt Müşteri Listeleme ve Getirme
Endpoint’ler
| Amaç | Endpoint | Açıklama |
|---|---|---|
| Tüm alt müşterileri listeleme | GET /vendor/subcustomers | Tüm alt müşteri kayıtlarını sayfalandırmalı olarak listeler. |
| Tek alt müşteri (code) | GET /vendor/subcustomers/{code} | Alt müşteriyi kendi koduna göre getirir. |
| Tek alt müşteri (erpCode) | GET /vendor/subcustomers/{erpCode} | ERP koduna göre alt müşteri detayını döner. |
| Ana bayi altındaki alt müşteriler (parentCode) | GET /vendor/subcustomers/{parentCode} | Belirtilen ana bayiye bağlı tüm alt müşterileri listeler. |
HTTP Bilgileri
- HTTP Method:
GET - Request Content-Type:
application/json(opsiyonel) - 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 alt müşteri (subcustomer) kayıtları listelenebilir veya tek bir alt müşteri detayı getirilebilir.
code,erpCodeveyaparentCodeparametrelerinden yalnızca biri belirtilmelidir.- Parametre belirtilmezse, sistem tüm alt müşterileri sayfalandırmalı olarak döndürür.
- Aynı anda birden fazla parametre verilirse istek reddedilir.
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 | Üçünden biri zorunlu | Alt müşterinin kullanıcı kodu |
erpCode | string | Üçünden biri zorunlu | Alt müşterinin ERP kodu |
ParentCode | string | Üçünden biri zorunlu | Ana bayi kodu (ilgili bayi altındaki müşterileri getirir) |
Not
- Sadece bir parametre kullanılmalıdır.
- Hiçbiri gönderilmezse sistem tüm alt müşteri kayıtlarını döndürü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) |
- Örnek Response (Tek Kayıt)
- Örnek Response – Listeleme (Sayfalandırma)
{
"status": "success",
"customer": {
"code": "21",
"companyName": null,
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"mobile": "5003998990",
"phone": null,
"countryCode": null,
"cityCode": "10",
"currenyCode": "TRY",
"erpCode": "65130asxc",
"address": "test1",
"isActive": true,
"isCompany": false,
"tckn": null,
"taxNumber": null,
"taxOffice": null,
"paymentSetId": "15863986-6509-48c9-aaa7-419f90db879d"
}
}
{
"data": [
{
"code": "NT39102312",
"companyName": null,
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"mobile": "5000000000",
"phone": null,
"countryCode": null,
"cityCode": "06",
"currenyCode": "TRY",
"erpCode": "111",
"address": null,
"isActive": true,
"isCompany": false,
"tckn": null,
"taxNumber": null,
"taxOffice": null,
"paymentSetId": "bfcad216-f41c-4743-b570-7b49fb7c7e9c"
},
{
"code": "NT93598442",
"companyName": null,
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"mobile": "5000000000",
"phone": null,
"countryCode": null,
"cityCode": null,
"currenyCode": "TRY",
"erpCode": "",
"address": null,
"isActive": true,
"isCompany": false,
"tckn": null,
"taxNumber": null,
"taxOffice": null,
"paymentSetId": "00cfced3-c429-444e-8125-fff3a7fb553a"
}
]
}
Notlar ve En İyi Uygulamalar
- ParentCode kullanımı:
parentCodeparametresi gönderilirse sadece o ana bayiye bağlı alt müşteriler döner. - Sayfalama:
pagevepageSizebelirtilmezse varsayılan olarak ilk 10 kayıt döner. - Performans: Büyük veri kümelerinde
pageparametresiyle sayfalı istek yapmak önerilir. - Yetkilendirme: Bu endpoint sadece ilgili bayi veya alt bayi yetkisine sahip kullanıcılar tarafından çağrılabilir.
- Alan tutarlılığı: Bu endpoint,
POST /vendor/subcustomersvePUT /vendor/subcustomersservisleriyle aynı veri alanlarını döner.