Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Rating
  • Overview
  • Languages
  • Notify
  • Event
  • Storage
  • Configuration
  • Forms
  • Helpers
  • Auth
    • Login
    • Logout
    • Verify
    • Resend
    • Register
    • Refresh
  • Cart
    • Latest
    • Details
    • Quick Add
    • Add Item
    • Delete Item
    • Delete Image
    • Add Coupon
    • Remove Coupon
    • Get Upload Image
    • Get Quick Order Settings
    • Create Quick Order
    • Order Status
    • Get Current Cart Id
    • Price Quote
  • Wishlist
    • Add
    • Remove
    • Toggle
  • Loyalty
    • Get Program
    • Exchange
    • Reset
  • Comment
    • Add Comment
    • Fetch
    • Get Page Comments
    • Get Product Comments
  • Profile
    • Update profile
    • Update contact
  • Product
    • Get price
    • Product availability
    • Categories
    • Offer details
    • Search products
    • Get Gift Details
    • Add Gift To Cart
    • Upload Gift Image
    • Get Product Details
    • Fetch
    • Fetch Options
    • Size Guides
  • Order
    • Create cart from order
    • Cancel
    • Send invoice
    • Show order
  • Booking
    • Add
  • Rating
    • Order
    • Store
    • Products
    • Shipping
  • Currency
    • Change
    • List
  • Component
    • Reviews
    • Menus
  1. Rating

Products

The customer is able to rate each product purchased in a specific order. This endpoint is used to save the customer's review comments on the purchased products list.
TIP
The products rating endpoint has been implemented in the Rating Web Component, , and It's all setup to save developer's time and effort.

Payload authenticated#

ProductsPayload
order_id
number 
required
The order's id, which contains the list of products to be rated.
products
array [object {3}] 
optional
The array list of the purchased products.
product_id
string 
optional
Purchased product's id.
comment
string 
optional
The customer review comment on the purchased product.
rating
object 
Rating
optional
The customer's rating in form of 5-star scale.
Allowed values:
12345

Response#

Success
Error
rate.products.success
success
boolean 
success
required
Response flag
status
enum<number> 
status
required
Allowed values:
200201202

Usage#

To perform the process of rating the list of the purchased products, the developer may call the method products() along with the products' array and the order id as per the following example.

Events#

This endpoint may trigger two events, the onProductsRated and onProductsFailed events.

onProductsRated#

This event is triggered when the process of rating a list of the purchased products is done without having any errors coming back from the backend.

onProductsFailed#

This event is triggered when the process of rating a list of the purchased products is not completed and an error has occurred.
Previous
Store
Next
Shipping