List pickup orders

List the diner's pickup orders, newest first, with their status and collection code.

GET/api/v1/pickup/ordersClient API

The 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

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
ordersarray of objectAt most 20 items.
orders[].orderIdstring1 to 200 characters.
orders[].numberintegerThe short number staff call out, per branch and service day. -9,007,199,254,740,991 to 9,007,199,254,740,991.
orders[].statusstringOne of awaiting_payment, sent, accepted, served, declined, cancelled, expired, unknown. An open list: read a value you don't know as unknown.
orders[].branchstringAn address: lower-case letters, digits and dashes.
orders[].tablestring or null1 to 40 characters.
orders[].currencystringA three-letter currency code (ISO 4217).
orders[].subtotalstringAn amount in minor units, as a string.
orders[].linesarray of object1 to 100 items.
orders[].lines[].dishIdstring or null1 to 200 characters.
orders[].lines[].externalIdstring or null1 to 200 characters.
orders[].lines[].titlestring1 to 200 characters.
orders[].lines[].variantLabelstring or null1 to 80 characters.
orders[].lines[].quantityinteger-9,007,199,254,740,991 to 9,007,199,254,740,991.
orders[].lines[].unitPricestringAn amount in minor units, as a string.
orders[].fulfilmentstringMay be absent. One of dine_in, pickup, unknown. An open list: read a value you don't know as unknown.
orders[].pickupAtstring (date-time) or nullMay be absent.
orders[].pickupCodestring or nullMay be absent. 1 to 12 characters.
orders[].testbooleanMay be absent.
orders[].paymentDueAtstring (date-time) or null
orders[].paidboolean

Example

curl https://tamr.link/api/v1/pickup/orders \
  -H "x-tamr-key: $TAMR_APP_KEY" \
  -H "x-tamr-session: $TAMR_SESSION"

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