# 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.

Source: https://tamr.link/docs/api/submit-reviews

`POST https://tamr.link/api/v1/reviews`

The stars, by the `dishId`s 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`](https://tamr.link/docs/webhooks/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](https://tamr.link/docs/api/start-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

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `x-tamr-device` | string | No | Guest sessions only: the device id the session was exchanged with. Matches `^[A-Za-z0-9_-]{8,128}$`. |
| `x-tamr-app` | string | No | Native 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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `orderId` | string | Yes | 1 to 200 characters. |
| `ratings` | array of object | Yes | 1 to 30 items. |
| `ratings[].dishId` | string | Yes | 1 to 200 characters. |
| `ratings[].rating` | integer | Yes | 1 to 5. |

## Response

| Field | Type | Description |
| --- | --- | --- |
| `reviews` | array of object | 1 to 30 items. |
| `reviews[].reviewId` | string | 1 to 200 characters. |
| `reviews[].dishId` | string | 1 to 200 characters. |
| `reviews[].externalId` | string or null | 1 to 200 characters. |
| `reviews[].rating` | integer | 1 to 5. |

## Example

curl:

```bash
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
    }
  ]
}'
```

Node:

```js
import { createClient } from "@tamr/api";

const tamr = createClient({ appKey: process.env.TAMR_APP_KEY });
// Sign the diner in first, with a token your backend signed (or a launch code).
await tamr.startSession({ token: dinerToken });

const result = await tamr.reviewsSubmit({
  orderId: "A-99812",
  ratings: [
    { dishId: "dish_kafta", rating: 5 },
    { dishId: "dish_fattoush", rating: 3 },
  ],
});
console.log(result);
```

Python:

```python
import os

import requests

API = "https://tamr.link/api/v1"
headers = {
    "x-tamr-key": os.environ["TAMR_APP_KEY"],
    "x-tamr-session": os.environ["TAMR_SESSION"],  # from POST /api/v1/sdk/session
}

response = requests.post(
    f"{API}/reviews",
    headers=headers,
    json={
        "orderId": "A-99812",
        "ratings": [
            {"dishId": "dish_kafta", "rating": 5},
            {"dishId": "dish_fattoush", "rating": 3},
        ],
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())
```

## Example response

```json
{
  "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](https://tamr.link/docs/errors).

| `data.code` | Status | What to do |
| --- | --- | --- |
| `app_key_invalid` | 401 | The key is wrong, revoked or of another kind. Check it in the dashboard. |
| `sdk_disabled` | 403 | The SDK isn't switched on for this restaurant. Ask Tamr. |
| `origin_not_allowed` | 403 | A browser called from an origin the key doesn't list. Add the origin to the key. |
| `session_expired` | 401 | Start a new session with a fresh token or code, then send the call again once. |
| `invalid_request` | 400 | A field doesn't match the spec. The message says which. |
| `rate_limited` | 429 | Wait `retryAfter` seconds (also in the `Retry-After` header), then try again. |
| `review_refused` | 409 | An order's dishes can't be rated. `reviewRefusal` says why: `order_not_found`, `order_closed`, `too_old` or `nothing_to_review`. |
| `guest_not_allowed` | 401 | The key has no guest mode: sign the diner in with a token or a code. |
