Venue API

Connect suppliers, inventory systems and custom tools to a venue on Yusker: read venue data and incoming orders, update menu prices and 86 items, and receive order webhooks. Live today — keys are self-serve for venue owners.

Base URL

https://api.yusker.com/partner/v1

Authentication

Every request carries an API key as a bearer token. Keys look like yk_live_… (or yk_test_…), are scoped to one business account and a set of permissions, and are shown once at creation — only a hash is stored.

curl https://api.yusker.com/partner/v1/me \
  -H "Authorization: Bearer $YUSKER_PARTNER_KEY"
# -> { "business_account_id": 42, "mode": "live",
#      "scopes": ["venue:read","menu:read","orders:read"],
#      "venue_ids": [601] }

Scopes

• venue:read — venue profile data.
• menu:read — menu sections and items.
• menu:write — update item price, availability (86), description, dietary tags.
• orders:read — takeout & delivery orders.

A key without the required scope receives 403. Venues are checked on every call — a key can only ever see the venues its business account has claimed; anything else returns 404.

Identify the account

Rate limits & errors

• 120 requests per minute per key — beyond that, 429. Back off and retry.
• 401 — missing, invalid or revoked key.
• 403 — the key lacks the required scope.
• 404 — resource doesn’t exist or belongs to another account.
• 400 — invalid request; the JSON body carries a detail message.