Get pickup options

Read where and when the diner can collect a pickup order: locations, times and how each takes payment.

GET/api/v1/pickup/optionsClient API

Where and when the diner can collect: each location that takes pickups, its times and whether it is paid at the counter or ahead with Tamr Pay.

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.

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
availableboolean
reasonstring or nullOne of ordering_off, no_branch, paused, closed, pickup_time, details, blocked, too_large, unavailable, catering_menu, test_key, other. An open list: read a value you don't know as other.
serverNowstring (date-time)
asapMinutesobject
asapMinutes.mininteger0 to 240.
asapMinutes.maxinteger0 to 240.
locationsarray of objectAt most 50 items.
locations[].branchstringAn address: lower-case letters, digits and dashes.
locations[].namestring1 to 200 characters.
locations[].addressstring or nullAt most 500 characters.
locations[].timezonestring1 to 64 characters.
locations[].openNowboolean
locations[].pausedUntilstring (date-time) or null
locations[].payFirstboolean
locations[].todayarray of string (date-time)At most 40 items.
locations[].tomorrowarray of string (date-time)At most 40 items.

Example

curl "https://tamr.link/api/v1/pickup/options?branch=achrafieh" \
  -H "x-tamr-key: $TAMR_APP_KEY" \
  -H "x-tamr-session: $TAMR_SESSION"

Example response

{
  "available": true,
  "reason": null,
  "serverNow": "2026-11-08T14:00:00.000Z",
  "asapMinutes": {
    "min": 15,
    "max": 20
  },
  "locations": [
    {
      "branch": "achrafieh",
      "name": "Achrafieh",
      "address": "Sursock Street, Beirut",
      "timezone": "Asia/Beirut",
      "openNow": true,
      "pausedUntil": null,
      "payFirst": true,
      "today": [
        "2026-11-08T14:30:00.000Z",
        "2026-11-08T14:45:00.000Z"
      ],
      "tomorrow": [
        "2026-11-09T09:00:00.000Z"
      ]
    },
    {
      "branch": "hamra",
      "name": "Hamra",
      "address": null,
      "timezone": "Asia/Beirut",
      "openNow": false,
      "pausedUntil": "2026-11-08T14:20:00.000Z",
      "payFirst": false,
      "today": [],
      "tomorrow": []
    }
  ]
}

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.