Sipariş Listeleme Servisi

Bu servis kullanıcıya ait siparişleri yada ID'si verilen siparişin detaylarını listeler

Siparişleri Listeleme

get

/api/shop/orders

Bu servise istek gönderirken kullanıcı doğrulaması yapılması zorunludur. Login servisinden alınan token bilgisi header içerisinde Bearer Token olarak gönderilmelidir.

Parametre Tanımlamaları

startDate ve endDate parametreleri sipariş tarihlerini filtrelemek için kullanılır. Sadece startDate gönderilirse "şu tarihten sonra", sadece endDate gönderilirse "şu tarihten önce", iki tarih te gönderilirse "bu iki tarih arasında" filtrelemesi yapılır.

Değerler	Zorunluluk	Ön Tanımlı	Açıklama
lang	hayır	tr	Servisten beklenen dil bilgisidir. Merchant'a tanımlı dil bilgileri ile istek yapılabilir.
page	evet	1	Sayfalama işlemi için gönderilmesi gereken sayfa bilgisidir.
limit	hayır	20	Bir sayfa içerisine en fazla kaç adet siparişin listeleneceğini ifade eder.
sortBy	hayır	createdAt	Sıralama yöntemi
startDate	hayır		Başlangıç tarihi
endDate	hayır		Bitiş tarihi

Örnek İstek

axios.get('{baseUrl}/api/shop/orders', {
    params : {
        startDate : '2022-07-01',
        page : 1,
        limit : 50,
    }
})

Servis Cevabı ve Alan Açıklamaları

Alan adı	Açıklama
results	Sipariş veri listesi
results->orderId	Sipariş numarası
results->customerName	Müşteri adı
results->orderStatus	Sipariş durumu
results->orderDate	Sipariş tarihi
results->totalProducts	Sipariş içerisindeki ürün sayısı
results->totalDelivery	Teslim edilen ürün sayısı
results->totalPrice	Toplam sipariş tutarı
results->invoiceNumber	Fatura numarası
results->isCancelable	Sipariş iptal edilebilir mi?
results->isRefundable	Sipariş iade edilebilir mi?
results->products	Sipariş içerisindeki ürün bilgileri
limit	Sayfa başına listelenen sipariş sayısı
currentPage	Mevcut sayfa
totalOrders	Toplam sipariş adedi
totalPage	Toplam sayfa
head	Frontend ve SEO için gerekli olan bilgileri içerir
head->title	SEO başlık bilgisi
head->description	SEO açıklaması
head->htmlContent	Varsa sayfaya özel HTML içeriği
head->canonicalUrl	SEO canonical URL bilgisi
head->breadcrumbList	Sayfa breadcrumb bilgisi

{
  "results": [
    {
      "orderId": 66137,
      "customerName": "Görkem Yıldırım",
      "orderDate": "08/07/2022 19:54",
      "orderStatus" : "İptal Edildi",
      "totalProducts": 1,
      "totalDelivery": 0,
      "totalPrice": 199,
      "invoiceNumber": null,
      "isCancelable": false,
      "isRefundable": false,
      "products": [
        {
          "deliveryStatus": "CANCELLED",
          "deliveryStatusText": "Onay Bekliyor",
          "deliveryTime": "",
          "quantity": 1,
          "cancelledQuantity": 0,
          "totalPrice": 199,
          "productId": 63606,
          "modelSku": "730852147706",
          "productType": "commercial",
          "productTitle": "Shiseido Hacim ve Uzatma Etkili - SMK Imperiallash Mascaraink 01 730852147706 IMPRLSHMSCR",
          "productSubTitle": "null",
          "brandName": "ExampleBrand",
          "thumbnail": "https://static-labs.s3.eu-central-1.amazonaws.com/products/10011/730852147706/medium/730852147706_1.jpeg"
        }
      ]
    },
    {
      "orderId": 66136,
      "customerName": "Görkem Yıldırım",
      "orderDate": "08/07/2022 00:29",
      "orderStatus" : "Oluşturuldu", 
      "totalProducts": 1,
      "totalDelivery": 0,
      "totalPrice": 199,
      "isCancelable": false,
      "isRefundable": false,
      "invoiceNumber": null,
      "products": [
        {
          "deliveryStatus": "COMPLETED",
          "deliveryStatusText": "Oluşturuldu",
          "deliveryTime": "",
          "quantity": 1,
          "cancelledQuantity": 0,
          "totalPrice": 199,
          "productId": 63606,
          "modelSku": "730852147706",
          "productType": "commercial",
          "productTitle": "Shiseido Hacim ve Uzatma Etkili - SMK Imperiallash Mascaraink 01 730852147706 IMPRLSHMSCR",
          "productSubTitle": "null",
          "brandName": "ExampleBrand",
          "manufacturedCountry": "",
          "thumbnail": "https://static-labs.s3.eu-central-1.amazonaws.com/products/10011/730852147706/medium/730852147706_1.jpeg"
        }
      ]
    }
  ],
  "limit": 5,
  "currentPage": 1,
  "totalOrders": 12,
  "totalPage": 3,
  "head": {
    "title": "Siparişlerim",
    "description": "",
    "htmlContent": "",
    "canonicalUrl": "",
    "breadcrumbList": []
  }
}

Sipariş Detay Bilgilerini Listeleme

get

/api/shop/orders/{orderId}

Bu servise istek gönderirken kullanıcı doğrulaması yapılması zorunlu değildir. Kullanıcı doğrulaması yapılmaz ise KVKK gereği fatura ve teslimat bilgileri servisten gönderilmez. Kullanıcı doğrulaması yapılırsa bilgiler görüntülenebilir.

Parametre Tanımlamaları

Değerler	Zorunluluk	Ön Tanımlı	Açıklama
lang	hayır	tr	Servisten beklenen dil bilgisidir. Merchant'a tanımlı dil bilgileri ile istek yapılabilir.

Örnek İstek

axios.get('{baseUrl}/api/shop/orders/66137')

Servis Cevabı ve Alan Açıklamaları

Alan adı	Açıklama
orderId	Sipariş numarası
customerName	Müşteri adı
orderStatus	Sipariş durumu
orderDate	Sipariş tarihi
totalProducts	Sipariş içerisindeki ürün sayısı
totalDelivery	Teslim edilen ürün sayısı
totalPrice	Toplam sipariş tutarı
invoiceNumber	Fatura numarası
isCancelable	Sipariş iptal edilebilir mi?
isRefundable	Sipariş iade edilebilir mi?
products->{}	Sipariş içerisindeki ürün bilgileri
shipmentAddress->{}	Teslimat adresi bilgileri
invoiceAddress->{}	Fatura adresi bilgileri

{
  "orderId": 66137,
  "customerName": "Görkem Yıldırım",
  "orderStatus": "Onay Bekliyor",
  "orderDate": "08/07/2022 19:54",
  "totalProducts": 1,
  "totalDelivery": 0,
  "totalPrice": 199,
  "invoiceNumber": null,
  "isCancelable": false,
  "isRefundable": false,
  "products": [
    {
      "deliveryStatus": "CANCELLED",
      "deliveryStatusText": "Onay Bekliyor",
      "deliveryTime": "",
      "quantity": 1,
      "cancelledQuantity": 0,
      "totalPrice": 199,
      "productId": 63606,
      "modelSku": "730852147706",
      "productType": "commercial",
      "productTitle": "Shiseido Hacim ve Uzatma Etkili - SMK Imperiallash Mascaraink 01 730852147706 IMPRLSHMSCR",
      "productSubTitle": "null",
      "brandName": "ExampleBrand",
      "thumbnail": "https://static-labs.s3.eu-central-1.amazonaws.com/products/10011/730852147706/medium/730852147706_1.jpeg",
      "attributes" : [
        {
          "attributeType" : "color",
          "attributeValue" : "Kırmızı"
        }
      ]
    }
  ],
  "shipmentAddress": {
    "city": "İstanbul",
    "town": null,
    "floor": null,
    "aptNo": null,
    "address": "test adresi",
    "doorNo": null,
    "district": "Sarıyer",
    "identity": "11111111111",
    "directions": null,
    "taxNumber": null,
    "taxOffice": null,
    "addressName": "Otomatik Oluşturulan",
    "companyName": null,
    "countryCode": "TR",
    "invoiceType": null,
    "phoneNumber": "",
    "customerName": "Görkem Yıldırım"
  },
  "invoiceAddress": {
    "city": "İstanbul",
    "town": null,
    "floor": null,
    "aptNo": null,
    "address": "test adresi",
    "doorNo": null,
    "district": "Sarıyer",
    "identity": "11111111111",
    "directions": null,
    "addressName": "Otomatik Oluşturulan",
    "countryCode": "TR",
    "phoneNumber": "",
    "customerName": "Görkem Yıldırım"
  }
}