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
  • Languages
  • Notify
  • Event
  • Overview
  • 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

Order

This endpoint is used for the purpose of rating an order. It fetches the order's id, which will be rated.
TIP
The order rating endpoint has been implemented in the Rating Web Component, , and It's all setup to save developer's time and effort.

Payload authenticated#

OrderPayload
order_id
number 
required
Id of the order to be rated.

Response#

Success
Error
rating.order.success
success
boolean 
success
required
Response flag
status
enum<number> 
status
required
Allowed values:
200201202
data
object 
data
optional
Response data.
id
number 
required
Id of the order.
 store
object 
optional
Feedback comment on a store
shipping
object 
optional
products
array [object {2}] 
products
optional
List of the products' comments
testimonials_enabled
boolean 
testimonials_enabled
optional
Testimonials availability
shipping_enabled
boolean 
shipping_enabled
optional
Shipping availability
products_enabled
boolean 
products_enabled
optional
Product availability
thanks_message
string 
thanks_message
optional
Thanks message to be shown after sending comment

Usage#

To perform the action of rating an order, the method order() may be called as below, with the id of the order to be rated.

Events#

This endpoint may trigger two events, the onOrderFetched and onOrderNotFetched events.

onOrderFetched#

This event is triggered when fetching the id of the order to be rated is done without having any errors coming back from the backend.

onOrderNotFetched#

This event is triggered when fetching the id of the order to be rated is not completed and an error has occurred.
Modified at 2025-03-04 12:54:02
Previous
Rating
Next
Store