Get the diner's usual

Read the signed-in diner's usual order, or their last one, from the orders your backend sent.

GET/api/v1/usualClient API

The signed-in diner's usual, or their last completed order when there is no usual yet, from the orders your backend sent, on the menu the waiter serves there. Each item keeps your order's title, with today's dish (null once it's off the menu) and whether it's on sale now. usual is null for a guest and for a diner with no completed order. To reorder, send the diner's words to the chat ("Reorder my usual").

From the completed orders the host sent (POST /api/v1/sdk/orders) in the restaurant's window. usual is null for a guest's session and for a diner with no completed order. An item no longer on the menu has dish: null and onMenu: false; reorder through the chat (reorder), which proposes only what is on sale.

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.

Query parameters

NameTypeRequiredDescription
branchstringNoAn address: lower-case letters, digits and dashes.
modestringNoOne of dine_in, pickup, delivery.

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_-]+)+$.

Response

FieldTypeDescription
usualobject or null
usual.kindstringOne of usual, last, other. An open list: read a value you don't know as other.
usual.ordersinteger1 to 10.
usual.lastOrderedAtstring (date-time)
usual.itemsarray of object1 to 100 items.
usual.items[].titlestring1 to 200 characters.
usual.items[].quantityinteger1 to 99.
usual.items[].variantLabelstring or null1 to 80 characters.
usual.items[].dishDishSummary or null
usual.items[].onMenuboolean
usual.items[].availableboolean

Example

curl "https://tamr.link/api/v1/usual?branch=achrafieh&mode=delivery" \
  -H "x-tamr-key: $TAMR_APP_KEY" \
  -H "x-tamr-session: $TAMR_SESSION"

Example response

{
  "usual": {
    "kind": "usual",
    "orders": 8,
    "lastOrderedAt": "2026-11-04T19:30:00.000Z",
    "items": [
      {
        "title": "Kafta plate",
        "quantity": 2,
        "variantLabel": "Large",
        "dish": {
          "dishId": "cmdish0003",
          "name": "Kafta plate",
          "price": "1200",
          "currency": "USD",
          "imageUrl": null,
          "calories": null,
          "proteinGrams": null,
          "carbsGrams": null,
          "fatGrams": null,
          "allergens": [],
          "dietaryTags": [],
          "available": true,
          "externalId": "SKU-1042"
        },
        "onMenu": true,
        "available": true
      },
      {
        "title": "Mixed grill for two",
        "quantity": 1,
        "variantLabel": null,
        "dish": null,
        "onMenu": false,
        "available": false
      }
    ]
  }
}

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.
menu_unavailable404No published menu is served at that branch and service mode.