Bayi Sorgulama ve Listeleme

Bu metot, hizmet sağlayıcı markasının altındaki bayileri sorgulamayı/listelemeyi sağlar.

• Tasarlanan sorgulama/listeme metotlarında gönderilen isteklerin cevapları, bayi bilgilerinin istenme yoluna göre değişiklik gösterir.

• Aşağıdaki cevap örneklerindeki farklılıklar:

  • İstek yolunda {retailerCode} verildiğinde, sadece İYS Numarası verilen bayinin bilgilerini getirir.
  • İstek yolunda {retailerCode} verilmediği takdirde marka altında yer alan tüm bayilerin bilgilerini getirir.
  • İstek yolunda offset=<int>&limit=<limit> verildiğinde sayfalama yapısı içerisinde tüm bayilerin bilgilerini getirir.

• İstek Örnekleri

  1. GET /sps/{iysCode}/brands/{brandCode}/retailers    (=> Tüm bayiler detaylı bilgi)
  2. GET /sps/{iysCode}/brands/{brandCode}/retailers?offset=<int>&limit=<limit>
  3. GET /sps/{iysCode}/brands/{brandCode}/retailers/{retailerCode}
  

• İstek Cevap Şablonu 1-2:

  {
    pagination: {
      offset:      <int>,  # pagination istekte verilmezse 0 
      pageSize:    <int>,  # pagination istekte verilmezse sunucu default 100 almalı ve daha yüksek olmamalı
      totalCount:  <int>,  # tüm sayfalardaki toplam kayıt sayısı    
    },
  
    list: [{
      title : <str>,
      mersis : <str>,
      alias : <str>,     #Bayi Tanımı (Şişli Mağaza)
      name : <str>,      #Bayi Yetkilisi Adı-Soyadı (Ad-Soyad)
      tckn : <str>,      #Bayi Yetkilisi TCKN (11 hane TC Kimlik No)
      mobile : <str>,
      city : {name:<cityName>, code: <cityCode:str>},
      town : {name:<townName>, code: <townCode:str>},
      retailerAccessCount : <int>,
      status : <active | passive | pending >
    },
    {
      ...
    }]
  }
  

• İstek Cevabı: 200

  {
      "pagination": {
          "offset": 0,
          "totalCount": 2,
          "pageSize": 2
      },
      "list": [
          {
              "canBeDeleted": "true",
              "tckn": "42790072898",
              "mersis": "0015001526400496",
              "mobile": "+905357990000",
              "title": "ADIM SOYADIM TİCARET",
              "name": "Adım Soyadım",
              "alias": "ŞİŞLİ MAĞAZASI",
              "retailerCode": 66438915,
              "status": "active",
              "city": {
                  "code": "34",
                  "name": "İstanbul"
              },
              "town": {
                  "code": "05",
                  "name": "Şişli"
              },
              "retailerAccessCount": 0
          },
          {
              "canBeDeleted": "false",
              "tckn": "42790000000",
              "mersis": "0015001526400497",
              "mobile": "+905357990000",
              "title": "ABC TİCARET",
              "name": "Adım Soyadım",
              "alias": "MECİDİYEKÖY MAĞAZASI",
              "retailerCode": 71007289,
              "status": "active",
              "city": {
                  "code": "34",
                  "name": "İstanbul"
              },
              "town": {
                  "code": "05",
                  "name": "Şişli"
              },
              "retailerAccessCount": 50
          }
      ]
  }
  

  İstek Cevap Şablonu 3:

  {
    title : <str>,
    mersis : <str>,
    alias : <str>,     #Bayi Tanımı (Şişli Mağaza)
    ownerName : <str>, #Bayi Yetkilisi Adı-Soyadı (Ad-Soyad)
    ownerTCKN : <str>, #Bayi Yetkilisi TCKN (11 hane TC Kimlik No)
    mobile : <str>,
    city : {name:<cityName>, code: <cityCode:str>},
    town : {name:<townName>, code: <townCode:str>},
    retailerAccessCount : <int>,
    status : <active | passive | pending >
  }
  

• İstek Cevabı:

  {
      "canBeDeleted": "true",
      "tckn": "42790000000",
      "mersis": "0015001526400496",
      "mobile": "+905357990000",
      "title": "ADIM SOYADIM TİCARET",
      "name": "Adım Soyadım",
      "alias": "ŞİŞLİ MAĞAZASI",
      "status": "active",
      "city": {
          "code": "34",
          "name": "İstanbul"
      },
      "town": {
          "code": "05",
          "name": "Şişli"
      },
      "retailerAccessCount": 0
  }