Skip to main content

Depo Oluşturma

Bu doküman Cockpit Panel üzerinde yapılan depo açma işlemi ile ilgili bilgiler içermektedir.

Yapılan geliştirmelerle beraber yeni tablo sayısında da artış olmaktadır. Bundan dolayı depo açılış işlemi zorlaşmış hem de hataya açık hale gelmiştir. İşlemin daha kolay hale gelmesi için aşağıda depo açılış sürecinde takip edilmesi gereken endpointler ve içerikleri yer almaktadır.

v2 Depo Oluşturma​

Öncelikli olarak v2 tarafında depo oluşturulmalıdır. Bunun için aşağıdaki endpointe istek atmak yeterli olacaktır. İstek sırasında zorunlu olan ve olmayan body içerikleri aşağıda belirtilmiştir.

İşlem sırasında kayıt atılan tabloda bir aktiflik bilgisi varsa, tabloya inaktif olarak kayıt atılır. İlerleyen adımlarda belirtilen depoyu aktif etme endpointi ile aktiflik sağlanacaktır.

Zorunlu olanlar:

  • name: Depo ismi
  • phoneNumber1: Depo Görevli Tel. Numarası
  • locations: Deponun lokasyon id'leri
  • email: Depoya ait mail
  • exampleDepotId: Örnek alınacak depoya ait id
  • organization: Deponun organizasyon bilgileri
  • organization.region: Deponun bulunduğu bölge (Anadolu, Avrupa değerlerini alabilir)
  • organization.regionSupervisorId: Depo bölge sorumlusu user id'si
  • organization.fieldManagerId: Depo alan yöneticisi user id'si

Zorunlu olmayanlar:

  • phoneNumber2: 2. Depo görevlisi Tel Numarası
  • provider: Depo Servisi (DELIVERY, SMS değerlerini alabilir. Default değeri DELIVERY)
  • serviceAmount: Depoya ait servis ücreti (default değeri 15.99)
  • packageAmount: Depoya ait paket ücreti (default değeri 2.00)
  • minBasketAmount: Depoya ait en düşük sepet ücreti (default değeri 80.00)
  • freeServiceCharge: Depoya ait ücretsiz servis miktarı (default değeri 250.00)

POST /v2/cockpit-panel/depots

curl --location 'https://bisu.com.tr/api/v2/cockpit-panel/depots' \
--header 'Authorization: cockpitUserToken' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Test Deposu",
    "phoneNumber1": "5318638333",
    "locations": [5105011, 341701],
    "email": "ozans@bisu.com.tr",
    "exampleDepotId": 6,
    "organization": {
        "region": "Anadolu",
        "regionSupervisorId": 106908,
        "fieldManagerId": 106909
    }
    
    // not required
    // "phoneNumber2": "5318638333"
    // "provider": "DELIVERY" // default DELIVERY
    // "serviceAmount": 15.99 // default 15.99
    // "packageAmount": 2.00 // default 2.00
    // "minBasketAmount": 80.00 // default 80.00
    // "freeServiceCharge": 250.00 // default 250.00
}'

Delivery Depo Oluşturma​

v2 deposu oluşturulduktan sonra operasyon tarafı için gerekli olan depo oluşturma işlemleri aşağıdaki endpoint ile sağlanmaktadır. İstek sırasında zorunlu olan ve olmayan body içerikleri aşağıda belirtilmiştir.

Zorunlu olanlar:

  • name: Depo ismi
  • phoneNumber1: Depo Görevli Tel. Numarası
  • email: Depoya ait mail
  • coordinates: Deponun bulunacağı konum([enlem, boylam] şeklinde olmalıdır.)
  • depotId: Depoya ait id
  • depotOwner: Depo görevlisine ait bilgiler
  • depotOwner.firstName: Depo görevlisinin adı
  • depotOwner.lastName: Depo görevlisinin soyadı
  • depotOwner.identityNumber: Depo görevlisinin kimlik numarası

Zorunlu olmayanlar:

  • phoneNumber2: 2. Depo görevlisi Tel Numarası
  • geofenceDistance: Sipariş tamamlama mesafesi (default değeri 500)
  • autoAssignCourier: Otomatik kurye atama (default değeri false)
  • taskHistoryDayRange: Task geçmişinin görülebilecek max gün sayısı (default değeri 7)

POST /v2/cockpit-panel/depots/create-delivery-depot

curl --location 'https://bisu.com.tr/api/v2/cockpit-panel/depots/create-delivery-depot' \
--header 'Authorization: cockpitUserToken' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Test Deposu",
    "phoneNumber1": "5318638333",
    "email": "ozans@bisu.com.tr",
    "coordinates": [40.8804685, 29.0876083],
    "depotId": 64,
    "depotOwner": {
        "firstName": "ozan",
        "lastName": "ŞIK",
        "identityNumber": "42154876529"
    }
    
    // not required
    // "phoneNumber2": "5318638333"
    // "geofenceDistance": 500 // default 500
    // "autoAssignCourier": false // default false
    // "taskHistoryDayRange": 7 // default 7
}'

Bu işlem sonunda depo giriş bilgileri iletiliyor olacaktır. Gelen bilgiler ile partner panele giriş yapılabilir.

Depoyu Aktif Etme​

Depo oluşturma aşamasında, depoya ait aktiflik içeren bütün tabloları aktif etmek ve depoyu canlıya almak için istek atılması gereken endpoint'dir. Yeni açılan depoya ait id ile beraber aktif etme işlemi sağlanmaktadır.

Bu işlemden sonra deponun istemediği ürünler de aktif olabilir. Depo bu ürünleri partner panel üzerinden inaktif etmelidir.

GET /v2/cockpit-panel/depots/activate/:depotId

curl --location 'https://bisu.com.tr/api/v2/cockpit-panel/depots/activate/183' \
--header 'Authorization: cockpitUserToken'

Entegrasyon Store Oluşturma​

Depo aktif olduktan sonra entegrasyon tarafı için tanımlama yapılması gerekiyor. Entegrasyonlardan tarafımıza gelen storeId bilgisi ile beraber aşağıdaki endpoint ile depo oluşturulabilmektedir.

İşlem sırasında kayıt atılan tabloda bir aktiflik bilgisi varsa, tabloya inaktif olarak kayıt atılır. İlerleyen adımlarda belirtilen entegrasyon store aktif etme endpointi ile aktiflik sağlanacaktır.

body içerikleri:

  • storeId: Yeni store id
  • biriDistributorId: Yeni store'a ait depo id
  • exampleStoreId: Örnek alınacak olan store id
  • exampleBiriDistributorId: Örnek alınacak olan depo id
  • vendorId: Store vendor id
  • service: Yemeksepeti servisi (Eğer açılacak store yemeksepetine aitse bulunması yeterlidir. Diğer store'lar için gerekli değildir. WATER, MARKET değerilerini alabilir)

Yukarıda örnek depo için verilen bilgilerle birlikte bir kontrol sağlanmaktadır. Bu yüzden verilen bilgiler içerisinde exampleStoreId, exampleBiriDistributorId ve vendorId bilgileri ile daha önce açılmış bir store olmalıdır.

POST /v2/cockpit-panel/integrations/create-store

curl --location 'https://bisu.com.tr/api/v2/cockpit-panel/integrations/create-store' \
--header 'Authorization: cockpitUserToken' \
--header 'Content-Type: application/json' \
--data '{
    "storeId": "newa",
    "biriDistributorId": 64,
    "exampleStoreId": "abcd",
    "exampleBiriDistributorId": 1,
    "service": "MARKET", 
    "vendorId": 6
}'

Entegrasyon Store Aktif Etme​

Store oluşturma aşamasında, store'a ait aktiflik içeren bütün tabloları aktif etmek ve store'u canlıya almak için istek atılması gereken endpoint'dir. Yeni açılan store'a ait id ile beraber aktif etme işlemi sağlanmaktadır.

GET /v2/cockpit-panel/integrations/activate-store/:storeId

curl --location 'https://bisu.com.tr/api/v2/cockpit-panel/integrations/activate-store/newa' \
--header 'Authorization: cockpitUserToken'
Ek BilgilerAçıklama
İlgili JIRA kart(lar)ıCORE-2347