Ana içeriğe geç

Alt Müşteri Listeleme ve Getirme

Endpoint’ler

AmaçEndpointAçıklama
Tüm alt müşterileri listelemeGET /vendor/subcustomersTü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, erpCode veya parentCode parametrelerinden 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ıZorunluAçıklama
AuthorizationEvetBearer {AccessToken} formatında geçerli token
Content-TypeEvetapplication/json

Route Parametreleri - Tek Kayıt Getirme

ParametreTipZorunluAçıklama
codestringÜçünden biri zorunluAlt müşterinin kullanıcı kodu
erpCodestringÜçünden biri zorunluAlt müşterinin ERP kodu
ParentCodestringÜçünden biri zorunluAna 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)

ParametreTipZorunluAçıklama
pageintegerHayırGetirilecek sayfa numarası (varsayılan: 1)
pageSizeintegerHayırSayfa başına kayıt sayısı (varsayılan: 10, maksimum: 100)
{  
"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"
}
}

Notlar ve En İyi Uygulamalar

  • ParentCode kullanımı: parentCode parametresi gönderilirse sadece o ana bayiye bağlı alt müşteriler döner.
  • Sayfalama: page ve pageSize belirtilmezse varsayılan olarak ilk 10 kayıt döner.
  • Performans: Büyük veri kümelerinde page parametresiyle 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/subcustomers ve PUT /vendor/subcustomers servisleriyle aynı veri alanlarını döner.