Ana içeriğe geç

Müşteri Listeleme ve Getirme

Endpoint​

AmaçEndpointAçıklama
Tüm müşterileri listelemeGET /vendor/customersSayfalama 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.

  • code veya erpCode parametresi verilirse yalnızca o müşteri döner.
  • Parametre verilmezse sayfalandırmalı tüm kayıtlar döner.

Header Bilgileri​

HeaderZorunluAçıklama
AuthorizationEvetBearer {AccessToken} formatında token
Content-TypeHayırapplication/json

Route Parametreleri (Tek Kayıt)​

ParametreTipZorunluAçıklama
codestringİkisinden biri zorunluMüşteri kullanıcı kodu
erpCodestringİkisinden biri zorunluMüş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)​

ParametreTipZorunluAçıklama
pageintegerHayırGetirilecek sayfa (varsayılan: 1)
pageSizeintegerHayırSayfa başına kayıt sayısı (varsayılan: 10, maksimum: 100)

### Response Body {#response-body}

{  
"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"
}
}

Kullanım Notları​

  • Filtreleme: Eğer hem code hem erpCode gönderilirse yalnızca code dikkate alınır.
  • Sayfalama: page ve pageSize belirtilmezse varsayılan olarak ilk 10 kayıt döner.
  • Alan Uyumu: Alan adları GET /vendor/customer ve PUT /vendor/customer servislerinde 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.