List pickup orders
List the diner's pickup orders, newest first, with their status and collection code.
GET
/api/v1/pickup/ordersClient APIThe session's pickups, newest first. Reading it expires a pickup that was never paid ahead by its paymentDueAt, as the QR menu does.
Reading this expires a pickup that was never paid ahead by its paymentDueAt (as the QR menu does), so it can answer expired for an order that was awaiting_payment before.
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
| 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_-]+)+$. |
Response
| Field | Type | Description |
|---|---|---|
orders | array of object | At most 20 items. |
orders[].orderId | string | 1 to 200 characters. |
orders[].number | integer | The short number staff call out, per branch and service day. -9,007,199,254,740,991 to 9,007,199,254,740,991. |
orders[].status | string | One of awaiting_payment, sent, accepted, served, declined, cancelled, expired, unknown. An open list: read a value you don't know as unknown. |
orders[].branch | string | An address: lower-case letters, digits and dashes. |
orders[].table | string or null | 1 to 40 characters. |
orders[].currency | string | A three-letter currency code (ISO 4217). |
orders[].subtotal | string | An amount in minor units, as a string. |
orders[].lines | array of object | 1 to 100 items. |
orders[].lines[].dishId | string or null | 1 to 200 characters. |
orders[].lines[].externalId | string or null | 1 to 200 characters. |
orders[].lines[].title | string | 1 to 200 characters. |
orders[].lines[].variantLabel | string or null | 1 to 80 characters. |
orders[].lines[].quantity | integer | -9,007,199,254,740,991 to 9,007,199,254,740,991. |
orders[].lines[].unitPrice | string | An amount in minor units, as a string. |
orders[].fulfilment | string | May be absent. One of dine_in, pickup, unknown. An open list: read a value you don't know as unknown. |
orders[].pickupAt | string (date-time) or null | May be absent. |
orders[].pickupCode | string or null | May be absent. 1 to 12 characters. |
orders[].test | boolean | May be absent. |
orders[].paymentDueAt | string (date-time) or null | |
orders[].paid | boolean |
Example
curl https://tamr.link/api/v1/pickup/orders \
-H "x-tamr-key: $TAMR_APP_KEY" \
-H "x-tamr-session: $TAMR_SESSION"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.pickupOrdersList();
console.log(result);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.get(
f"{API}/pickup/orders",
headers=headers,
timeout=30,
)
response.raise_for_status()
print(response.json())Example response
{
"orders": [
{
"orderId": "ord_0600",
"number": 23,
"status": "sent",
"branch": "achrafieh",
"table": null,
"currency": "LBP",
"subtotal": "290000",
"lines": [
{
"dishId": "dish_kafta",
"externalId": "SKU-1042",
"title": "Kafta plate",
"variantLabel": null,
"quantity": 2,
"unitPrice": "145000"
}
],
"fulfilment": "pickup",
"pickupAt": "2026-11-09T07:00:00.000Z",
"pickupCode": "5310",
"paymentDueAt": null,
"paid": true
},
{
"orderId": "ord_0599",
"number": 23,
"status": "expired",
"branch": "hamra",
"table": null,
"currency": "LBP",
"subtotal": "290000",
"lines": [
{
"dishId": "dish_kafta",
"externalId": "SKU-1042",
"title": "Kafta plate",
"variantLabel": null,
"quantity": 2,
"unitPrice": "145000"
}
],
"fulfilment": "pickup",
"pickupAt": null,
"pickupCode": "4821",
"paymentDueAt": null,
"paid": false
}
]
}Errors
Every error has the same body; switch on data.code. See Errors and rate limits.
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. |