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

Shipping

This endpoint is used for the purpose of rating the shipping company responsible for delivering orders. The customer will be able to send a review of that shipping company.
TIP
The shipping rating endpoint has been implemented in the Rating Web Component, , and It's all setup to save developer's time and effort.

Payload authenticated#

ShippingPayload
order_id
string 
required
The id of the order whose store is reviewed.
comment
string 
required
The comment of the customer who is reviewing the store.
rating
object 
Rating
required
The customer's rating in form of 5-star scale.
Allowed values:
12345
shipping_company_id
number 
required
The id of the shipping company to be reviewed.

Response#

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

Usage#

The method shipping may be called for rating a shipping company responsible for delivering an order as follows.

Events#

This endpoint may trigger two events, the onShippingRated and onShippingFailed events.

onShippingRated#

This event is triggered when rating a shipping company responsible for delivering an order is done without having any errors coming back from the backend.

onShippingFailed#

This event is triggered when rating a shipping company responsible for delivering an order is not completed and an error has occurred.
Modified at 2025-03-04 12:54:02
Previous
Products
Next
Currency