Ana içeriğe geç

Alt Bayi Oluşturma

Endpoint’ler

  • Tüm bayileri listeleme: GET /vendor/dealer
  • Tek bayi detayı (code): GET /vendor/dealer/{code}
  • Tek bayi detayı (erpCode): GET /vendor/dealer/{erpCode}

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, bayi kayıtlarını listelemek veya tek bir bayinin detayını görüntülemek için kullanılır.

  • code veya erpCode route parametresi verilirse yalnızca tek kayıt döner.
  • Parametre verilmezse sayfalandırmalı liste döner.
  • Aynı anda birden fazla route parametresi kullanılamaz.

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 biriBayi kullanıcı kodu
erpCodestringİkisinden biriBayi ERP kodu

Not: code veya erpCode kullanılmalıdır; ikisi birlikte gönderilemez.

Query Parametreleri – Sayfalandırma (Listeleme)

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

Request Body

Vendor (Alt Bayi) Alanları

Alan AdıTipZorunluAçıklama
codestringEvetBayi kodu (benzersiz)
namestringEvetBayi adı
addressstringHayırAdres
cityCodestringHayırŞehir kodu
districtCodestringHayırİlçe kodu
countryCodestringEvetÜlke kodu (örn. "TR")
erpCodestringEvetERP kodu (benzersiz)
taxNumberstringŞarta bağlıisCompany = true ise zorunlu
taxOfficestringŞarta bağlıisCompany = true ise zorunlu
isCompanybooleanEvetKurumsal ise true, bireysel ise false
isForeignNationalbooleanHayırYabancı uyruklu mu
phonestringHayırTelefon
paymentSetIdstringHayırVarsayılan ödeme seti ID
usablePaymentSetDefinitionIdsarrayHayırKullanılabilir ödeme seti ID listesi
paymentExCurrencyTypestringHayırÖdeme döviz tipi
currencyCodestringHayırPara birimi kodu (örn. "TRY")
parentTenantIdstringHayırÜst tenant ID
customerRepresentativeIdsarrayHayırTemsilci ID listesi
isActivebooleanHayırAktif/pasif
usersarray<User>HayırBayiye bağlı kullanıcı listesi

Users (Alt Bayi Kullanıcı) Alanları

Alan AdıTipZorunluAçıklama
userCodestringEvetKullanıcı kodu
namestringEvetAd
surnamestringEvetSoyad
emailstringEvetE-posta
gsmstringEvetCep telefonu
titlestringHayırÜnvan
descriptionstringHayırAçıklama
erpCodestringHayırERP kodı
isActivebooleanHayırAktif/pasif
isCompanybooleanHayırKurumsal mı
isForeignNationalbooleanHayırYabancı uyruklu mu
tcknstringHayırTCKN (bireysel ise)
paymentSetIdstringHayırÖdeme seti
rolesarrayHayırRol listesi
canUseMobilebooleanHayırMobil kullanım izni
userTypestringHayırKullanıcı tipi
countryCode, cityCode, address, currencyCodeçeşitliHayırOrtamdan dönebilir; opsiyoneldir

Not: Yanıt şemasında kullanıcı tarafında userCode alanı döner; oluşturma/güncelleme endpoint’lerinde istek gövdesinde çoğunlukla code kullanılır. (Okuma–yazma alan adı farkına dikkat.)

{  
"code": "742",
"phone": "5000000000",
"countryCode": "TR",
"cityCode": "10",
"districtCode": 494,
"currencyCode": "TRY",
"erpCode": "742",
"address": "TEST ADRESİ",
"taxNumber": "00000000000",
"paymentSetId": "315ef729-bf70-ff12-5e3f-ca7a7ff6867d",
"customerRepresentativeIds": [
"8fc535a7-3a0c-4994-b19b-0f3c4da748a5"
],
"isForeignNational": false,
"isCompany": false,
"name": "TEST VENDOR ALT BAYİSİ",
"parentTenantId": "958949df-0d90-4851-bcb8-1acb62c4dc95",

"users": [
{
"canUseMobile": false,
"description": "test",
"email": "[email protected]",
"code": "722",
"gsm": "5000000000",
"isActive": true,
"name": "test",
"surname": "kullanıcısı",
"roles": [
"2d37006c-6000-4315-90fe-2dc2fe1fb184"
],
"sendMail": false,
"userType": 8248
//"tckn": "string"
}
],
"mainDealerCode": "NT65126658"
}

Not: Önceki örnekte mesajda “Müşteri” ve alan adı “customerId” geçiyordu; alt bayi kaydı için anlamlı olacak şekilde düzelttik: subDealerId.

Notlar & En İyi Uygulamalar

  • 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.