Menus and tables
A menu code links to your menu. Give it tables, and each table gets its own printed code that opens the same menu, so you can see where people scan.
1. Create a menu
A menu is a code with qr_type: "menu" and a destination_url: a web page, a PDF or an ordering page. It works on its own, with or without tables.
curl https://pikaqr.com/api/v1/qr \
-H "Authorization: Bearer $PIKAQR_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Dinner menu",
"qr_type": "menu",
"destination_url": "https://example.com/menu"
}'2. Add tables
Send a name with from and to to add a numbered run, or just a name for one table. Each table gets its own short link, which is what goes in its printed code. Up to 100 tables can be added at a time.
# Table 1 to Table 12
curl https://pikaqr.com/api/v1/qr/$MENU_ID/tables \
-H "Authorization: Bearer $PIKAQR_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Table", "from": 1, "to": 12 }'
# One table by name
curl https://pikaqr.com/api/v1/qr/$MENU_ID/tables \
-H "Authorization: Bearer $PIKAQR_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Patio" }'GET /qr/:id/tables lists a menu’s tables in the order they were added.
3. Print them
Fetch a table’s code from GET /qr/:id/tables/:tableId/image, as a PNG or an SVG, in the menu’s colors. From the dashboard, a menu’s Tables tab can also print every table’s code on one page, each labelled with its name.
How a table behaves
The menu’s. Change the menu once and every table follows.
The menu’s. A table of a protected menu asks for the menu’s password.
Stops the menu and all of its tables.
PATCH is_active: falseStops one table. Its code shows a not-found page until it’s turned back on.
PATCH nameRenames a table. Its printed code doesn’t change.
DELETEIts code stops working for good, and its scans are deleted. Pause it instead to keep them.
Scans
A table’s scan is recorded against its menu, with the table attached. The menu’s total_scans, analytics, scans and webhooks all include its tables, and each one says which table it came from.
GET /qr/:id/scansEach scan has a table with its id and name, or null for the menu’s own code. Add ?table_id= for one table.
GET /qr/:id/analyticsby_table counts scans per table. A table_id of null is the menu’s own code.
scan.createddata.scan.table says which table was scanned. A webhook for the menu gets its tables’ scans too.
{
"type": "scan.created",
"data": {
"code": { "short_code": "3X80d4yx", "title": "Dinner menu", "type": "menu" },
"scan": {
"table": { "id": "7d2e…", "name": "Table 12" },
"destination": "https://example.com/menu",
"device": "mobile"
}
}
}Limits
Up to 5 tables on each menu. Each table counts as one of your 25 codes, so a menu with 5 tables uses 6.
Up to 500 tables on each menu, with no limit on codes.
Up to 60 characters.
When the plan has no room, adding tables returns 403 with the code plan_limit and a message that says how many are left.