Rate an order's dishes

Send the diner's 1 to 5 star ratings of an order's dishes, one review per dish per order.

POST/api/v1/reviewsClient API

The stars, by the dishIds the match returned. One review per dish per order: sending again changes a rating, and the same rating again changes nothing. Each rating written is also sent to your backend as the review.submitted webhook.

Authentication

Client API. Send your publishable key in x-tamr-key and the diner's session in x-tamr-session, from Start a session. For a guest's session, also send its device id in x-tamr-device. A browser may call it only from an origin listed on the key.

Headers

NameTypeRequiredDescription
x-tamr-devicestringNoGuest sessions only: the device id the session was exchanged with. Matches ^[A-Za-z0-9_-]{8,128}$.
x-tamr-appstringNoNative apps only: the app's iOS bundle id or Android package name. A key used from an app it doesn't list is logged, never refused. Matches ^[A-Za-z][A-Za-z0-9_-]*(\.[A-Za-z0-9_-]+)+$.

Request body

FieldTypeRequiredDescription
orderIdstringYes1 to 200 characters.
ratingsarray of objectYes1 to 30 items.
ratings[].dishIdstringYes1 to 200 characters.
ratings[].ratingintegerYes1 to 5.

Response

FieldTypeDescription
reviewsarray of object1 to 30 items.
reviews[].reviewIdstring1 to 200 characters.
reviews[].dishIdstring1 to 200 characters.
reviews[].externalIdstring or null1 to 200 characters.
reviews[].ratinginteger1 to 5.

Example

curl https://tamr.link/api/v1/reviews \
  -H "x-tamr-key: $TAMR_APP_KEY" \
  -H "x-tamr-session: $TAMR_SESSION" \
  -H "content-type: application/json" \
  -d '{
  "orderId": "A-99812",
  "ratings": [
    {
      "dishId": "dish_kafta",
      "rating": 5
    },
    {
      "dishId": "dish_fattoush",
      "rating": 3
    }
  ]
}'

Example response

{
  "reviews": [
    {
      "reviewId": "rev_0001",
      "dishId": "dish_kafta",
      "externalId": "SKU-1042",
      "rating": 5
    },
    {
      "reviewId": "rev_0002",
      "dishId": "dish_fattoush",
      "externalId": null,
      "rating": 3
    }
  ]
}

Errors

Every error has the same body; switch on data.code. See Errors and rate limits.

data.codeStatusWhat to do
app_key_invalid401The key is wrong, revoked or of another kind. Check it in the dashboard.
sdk_disabled403The SDK isn't switched on for this restaurant. Ask Tamr.
origin_not_allowed403A browser called from an origin the key doesn't list. Add the origin to the key.
session_expired401Start a new session with a fresh token or code, then send the call again once.
invalid_request400A field doesn't match the spec. The message says which.
rate_limited429Wait retryAfter seconds (also in the Retry-After header), then try again.
review_refused409An order's dishes can't be rated. reviewRefusal says why: order_not_found, order_closed, too_old or nothing_to_review.
guest_not_allowed401The key has no guest mode: sign the diner in with a token or a code.