Viewing delivery ratings via the API
Note
Running the API is only available to RouteQ users with the Administrator role.
Viewing delivery ratings
To view delivery ratings, use the delivery-ratings method.
GET https://courier.yandex.ru/api/v1/companies/<your-company-id>/orders/delivery-ratings
It returns the delivery_rating (the actual rating) and delivery_comment (user comments) fields:
[
{
"type": "order",
"courier_name": "Citroen Jumper",
"courier_number": "0",
"order_id": 123456,
...
"delivery_rating": 5,
"delivery_comment": "OK"
},
...
]
Order details
To view order ratings for a specific route, use the order-details method.
GET https://courier.yandex.ru/api/v1/companies/<your-company-id>/order-details?route_id=<route-id>
It returns the delivery_rating (the actual rating) and delivery_comment (user comments) fields:
[
{
"courier_id": 333,
"courier_name": "Citroen Jamper",
"order_id": 123456,
...
"delivery_rating": 5,
"delivery_comment": "OK"
},
...
]
Delivery quality report
To view a delivery quality report, use the courier-quality method.
GET https://courier.yandex.ru/api/v1/companies/<your-company-id>/courier-quality?types=order&route_id=<route-id>
It returns the delivery_rating (the actual rating) and delivery_comment (user comments) fields:
[
{
"type": "order",
"courier_name": "Citroen Jamper",
"courier_number": "0",
"order_number": "2024-01-15",
...
"delivery_rating": 5,
"delivery_comment": "OK"
},
...
]