OR51 - Get the evaluation of an order

Request

Call Frequency

Recommended usage: On each evaluation page view

Maximum usage: On each evaluation page view

Localization

This resource supports locale parameter (see documentation)

Localized output fields will be highlighted with an icon:

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_EVALUATION_READ)

Path

order_idstringrequired

Query

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/orders/{order_id}/evaluation?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

assessmentsArray of objectsrequired

List of assessments

commentstring

Evaluation comment

customer_idstringrequired

Identifier of the customer who posted the evaluation

datestring, (date-time)required

Evaluation creation date

firstnamestringrequired

First name of the customer who posted the evaluation

gradeinteger, (int32)required

Evaluation grade

last_updated_datestring, (date-time)required

Evaluation last updated date

lastnamestringrequired

Last name of the customer who posted the evaluation

replyobject

Reply of a shop or operator on an evaluation

visiblebooleanrequired

Whether the evaluation is visible or not

Response

{
  "assessments": [
    { … },
    { … },
    { … },
    { … }
  ],
  "comment": "Great seller, I recommend!",
  "customer_id": "Customer-001",
  "date": "2019-04-03T09:46:17Z",
  "firstname": "Taylor",
  "grade": 4,
  "last_updated_date": "2019-04-03T09:46:17Z",
  "lastname": "Smith",
  "reply": {
    "comment": "Owww thks",
    "date": "2019-06-25T16:00:00Z",
    "type": "SHOP"
  },
  "visible": true
}