Fiest Developers

Set the POS menu

Makes a reviewed menu active for POS. Expected menu counts and the current active-menu ID prevent publishing stale state.

PUT
/v1/restaurants/{restaurantId}/menus/pos

Makes a reviewed menu active for POS. Expected menu counts and the current active-menu ID prevent publishing stale state. Organization-boundary tokens also require fiest.organization.read; when a token covers several organizations, organization_id must identify an exact organization returned by listOrganizations.

Quick request

Example Request
curl -X PUT 'https://api-sandbox.fiest.io/v1/restaurants/11111111-1111-4111-8111-111111111111/menus/pos?organization_id=33333333-3333-4333-8333-333333333333' \  -H 'Authorization: Bearer $FIEST_ACCESS_TOKEN' \  -H 'Content-Type: application/json' \  -d '{  "menuId": "43f64da8-4ec2-4900-b137-1c0927c975d2",  "expectedCategoryCount": 2,  "expectedItemCount": 8,  "expectedCurrentPosMenuId": null,  "idempotencyKey": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb",  "confirmed": true}'
Example Response
{  "data": {    "actionId": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",    "restaurantId": "11111111-1111-4111-8111-111111111111",    "menu": {      "menuId": "43f64da8-4ec2-4900-b137-1c0927c975d2",      "name": "Lunch menu",      "isPosMenu": true,      "isOnlineMenu": false,      "categoryCount": 2,      "itemCount": 8    },    "previousPosMenuId": null,    "replayed": false  }}

Authorization

fiestOAuth fiest.restaurant.read, fiest.menu.read, fiest.menu.publish.write
headerAuthorizationBearer <token>

OAuth 2.1 authorization code with PKCE. Partner clients and redirect URIs must be approved by Fiest before use.

Scope: fiest.restaurant.read, fiest.menu.read, fiest.menu.publish.write

Path Parameters

restaurantId*string

A restaurant identifier returned by the authorized restaurant list.

Formatuuid

Query Parameters

organization_id?string

An organizationId returned by GET /v1/organizations. Required for restaurant-scoped calls when a Management portfolio authorization covers more than one organization; omitted for a single-restaurant authorization and optional for a one-organization grant.

Formatuuid

Request Body

application/json
  1. body
menuId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
expectedCategoryCount*integer
Range0 <= value <= 9007199254740991
expectedItemCount*integer
Range0 <= value <= 9007199254740991
idempotencyKey*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
confirmed*boolean
expectedCurrentPosMenuId*|null

Response Body

The menu now active for POS.

application/json
  1. response
data*