Müşteri Listeleme ve Getirme
Endpoint
| Amaç | Endpoint | Açıklama |
|---|---|---|
| Tüm müşterileri listeleme | GET /vendor/customers | Sayfalama destekli müşteri listesi döner. |
| Tek müşteri detayı (code ile) | GET /vendor/customer/{code} | Belirtilen müşteri koduna ait detay. |
| Tek müşteri detayı (erpCode ile) | GET /vendor/customer/{erpCode} | ERP koduna göre müşteri bilgisi. |
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)
Açıklama
Bu servis, müşteri verilerini listelemek veya belirli bir müşteriyi detaylı görüntülemek için kullanılır.
codeveyaerpCodeparametresi verilirse yalnızca o müşteri döner.- Parametre verilmezse sayfalandırmalı tüm kayıtlar döner.
Header Bilgileri
| Header | Zorunlu | Açıklama |
|---|---|---|
| Authorization | Evet | Bearer {AccessToken} formatında token |
| Content-Type | Hayır | application/json |
Route Parametreleri (Tek Kayıt)
| Parametre | Tip | Zorunlu | Açıklama |
|---|---|---|---|
code | string | İkisinden biri zorunlu | Müşteri kullanıcı kodu |
erpCode | string | İkisinden biri zorunlu | Müşteri ERP kodu |
Yalnızca bir parametre kullanılmalıdır. Her ikisi de verilmezse sistem tüm kayıtları döndürür.
Query Parametreleri (Listeleme)
| Parametre | Tip | Zorunlu | Açıklama |
|---|---|---|---|
page | integer | Hayır | Getirilecek sayfa (varsayılan: 1) |
pageSize | integer | Hayır | Sayfa başına kayıt sayısı (varsayılan: 10, maksimum: 100) |
### Response Body {#response-body}
- Tek Müşteri (Single Record)
- Sayfalı Liste (Paginated List)
{
"status": "success",
"customer": {
"code": "NT55073821",
"companyName": null,
"firstName": "test",
"lastName": "1120",
"email": "[email protected]",
"mobile": "5000000000",
"phone": null,
"countryCode": null,
"cityCode": null,
"currenyCode": "TRY",
"erpCode": "",
"address": null,
"isActive": true,
"isCompany": false,
"tckn": "00000000000",
"taxNumber": null,
"taxOffice": null,
"paymentSetId": "504978bf-bebd-40c5-89aa-b76f3a20341c"
}
}
{
"data": [
{
"code": "NT55073821",
"companyName": null,
"firstName": "test",
"lastName": "1120",
"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": "504978bf-bebd-40c5-89aa-b76f3a20341c"
},
{
"code": "code",
"companyName": "",
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"mobile": "5000000000",
"phone": null,
"countryCode": null,
"cityCode": null,
"currenyCode": null,
"erpCode": null,
"address": "",
"isActive": false,
"isCompany": false,
"tckn": null,
"taxNumber": null,
"taxOffice": null,
"paymentSetId": null
}
]
}
Kullanım Notları
- Filtreleme: Eğer hem
codehemerpCodegönderilirse yalnızcacodedikkate alınır. - Sayfalama:
pagevepageSizebelirtilmezse varsayılan olarak ilk 10 kayıt döner. - Alan Uyumu: Alan adları
GET /vendor/customervePUT /vendor/customerservislerinde aynıdır. - Performans: Büyük veri kümelerinde performans için filtreleme yapılması önerilir.
- Yetkilendirme: Token geçerliliğini kaybetmişse 401 hatası döner; yeniden kimlik doğrulama yapılmalıdır.