Ürünler
Ürün Değerlendirme Servisi
Bu servis, ürünü satın alan müşterilerin ürün hakkında puan ve yorum yapabildiği ve bu bilgileri listelediğimiz servistir.
Ürün Değerlendirmelerini Listeleme
get
/api/shop/reviews
Bu serviste ürün ile ilgili müşteriler tarafından yapılan değerlendirmeler listelenmektedir.
Parametre Tanımlamaları
Aşağıdaki parametreler ile ürün soru cevap servisine istek yapabilirsiniz.
| Değerler | Zorunluluk | Ön Tanımlı | Açıklama |
|---|---|---|---|
| productId | evet | Değerlendirme bilgileri listelenmek istenen ürüne ait productId bilgisidir. | |
| 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 ürünün listeleneceğini ifade eder. |
Örnek İstek
axios.get('{baseUrl}/api/shop/reviews?productId=82081&page=1&lang=tr')
Servis Cevabı ve Alan Açıklamaları
| Alan adı | Açıklama |
|---|---|
| results | İstek sonucu, değerlendirme listesi |
| limit | Sayfa başına listelenen değerlendirme sayısı |
| currentPage | Mevcut sayfa |
| totalReviews | Toplam değerlendirme sayısı |
| totalPage | Toplam sayfa |
| totalPoints | Ortalama ürün değerlendirme puanı |
{
"results": [
{
"name": "Görkem Efe Yıldırım",
"comment": "Güzeldi",
"rating": 5.00,
"date": "29/03/2022"
},
{
"name": "Fatih Karataş",
"comment": "Beğendim",
"rating": 3.00,
"date": "29/03/2022"
}
],
"limit": 5,
"currentPage": 1,
"totalReviews": 2,
"totalPage": 1,
"totalPoints" : 4.0
}
Ürüne Değerlendirme Ekleme
post
/api/shop/reviews
Bu servis sipariş verilen ve teslimat süreci tamamlanmış ürüne, müşteri değerlendirmesi eklemek için kullanılır.
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ı
Aşağıdaki parametreler ile ürün soru cevap servisine istek yapabilirsiniz.
| Değerler | Zorunluluk | Ön Tanımlı | Açıklama |
|---|---|---|---|
| productId | evet | Değerlendirme yapılacak ürüne ait productId bilgisidir. | |
| orderId | evet | Değerlendirme yapılacak siparişe ait sipariş numarası bilgisidir. | |
| rating | evet | Değerlendirme puanıdır. 0 ile 5 arası bir değer verilmesi gerekmektedir. | |
| comment | hayır | Sipariş yapılan değerlendirme yorumudur. Zorunlu değildir. | |
| censorCustomerName | hayır | false | Değerlendirme yayınlanırsa ad/soyad bilgisini gizle |
| lang | hayır | tr | Servisten beklenen dil bilgisidir. Merchant'a tanımlı dil bilgileri ile istek yapılabilir. |
Örnek İstek
axios.post('{baseUrl}/api/shop/reviews', {
productId : 80652,
orderId : 23655,
rating : 5.0,
comment : "Hızlı kargo için teşekkürler!",
censorCustomerName : true
})
Servis Cevabı ve Alan Açıklamaları
| Alan adı | Açıklama |
|---|---|
| status | İşlem sonucu (success, error) |
| message | İşlem sonucu açıklaması |
{
"status": "success",
"message": "Değerlendirme kaydedildi."
}