Get menus

GET

/public/v1/menus

const url = 'https://example.kwickbooking.com/public/v1/menus';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.kwickbooking.com/public/v1/menus \
  --header 'Authorization: Bearer <token>'

Returns the venue’s food and drinks menus by section, with prices, as published in its knowledge base. A menu the venue hasn’t published is null.

Authorizations

IntegrationKey

Parameters

Query Parameters

venueId

string format: uuid

Responses

200

application/json

GET /public/v1/menus: food and drinks menus from the knowledge base.

object

venueId

required

string format: uuid

source

required

string

food

required

One of:

null
unknown

null

drinks

required

One of:

null
unknown

null

summary

required

string

Example

{
  "venueId": "01920000-0000-7000-8000-000000000001",
  "source": "knowledge-base",
  "food": {
    "foodMenu": {
      "Small plates": [
        {
          "id": 1,
          "name": "Padrón peppers",
          "description": "Sea salt",
          "price": "6.50"
        }
      ]
    }
  },
  "drinks": null,
  "summary": "Food: 1 section, 1 item."
}

400

Venue required (https://developers.kwickblocks.ai/problems/venue-required)

application/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

venue-required

Venue required

{
  "type": "https://developers.kwickblocks.ai/problems/venue-required",
  "title": "Venue required",
  "status": 400,
  "detail": "Please say which venue this is for."
}

401

Invalid or missing integration key (https://developers.kwickblocks.ai/problems/invalid-key)

application/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

invalid-key

Invalid or missing integration key

{
  "type": "https://developers.kwickblocks.ai/problems/invalid-key",
  "title": "Invalid or missing integration key",
  "status": 401,
  "detail": "This integration key isn't valid. Ask the venue's admin for a new one."
}

403

Capability not granted (https://developers.kwickblocks.ai/problems/capability-missing)

application/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

capability-missing

Capability not granted

{
  "type": "https://developers.kwickblocks.ai/problems/capability-missing",
  "title": "Capability not granted",
  "status": 403,
  "detail": "This integration key isn't allowed to do that. Ask the venue's admin to add the capability."
}

404

Venue not found (https://developers.kwickblocks.ai/problems/venue-not-found); Not published (https://developers.kwickblocks.ai/problems/knowledge-not-found)

application/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Venue not found

{
  "type": "https://developers.kwickblocks.ai/problems/venue-not-found",
  "title": "Venue not found",
  "status": 404,
  "detail": "I couldn't find that venue."
}

Not published

{
  "type": "https://developers.kwickblocks.ai/problems/knowledge-not-found",
  "title": "Not published",
  "status": 404,
  "detail": "The venue hasn't published that information yet."
}

429

Too many requests (https://developers.kwickblocks.ai/problems/rate-limited)

application/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

rate-limited

Too many requests

{
  "type": "https://developers.kwickblocks.ai/problems/rate-limited",
  "title": "Too many requests",
  "status": 429,
  "detail": "There have been too many requests. Please try again in a minute."
}

503

Temporarily unavailable (https://developers.kwickblocks.ai/problems/service-unavailable)

application/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

service-unavailable

Temporarily unavailable

{
  "type": "https://developers.kwickblocks.ai/problems/service-unavailable",
  "title": "Temporarily unavailable",
  "status": 503,
  "detail": "That information isn't available right now. Please try again shortly."
}