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.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
#
The id of the order whose store is reviewed.
The comment of the customer who is reviewing the store.
The customer's rating in form of 5-star scale.
shipping_company_id
number
requiredThe id of the shipping company to be reviewed.
Response#
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