Get all menus

GET 
/api/v2/catalog/menus

Retrieve all the menus for a given business

Request

Query Parameters

business_id stringrequired
Limit results to a specific business
Example: cd9feea7-99f4-4e90-897f-8b4f7cac8c59
available boolean
Filter menus on whether they are available
Example: true

Responses

200

application/json

Schema

Schema

• Array [

id stringrequired

Possible values: >= 12 characters and <= 12 characters, Value must match regular expression ^[0-9a-z]+$

Unique ID of the menu

name stringrequired

Possible values: non-empty

Name of the menu

slug stringrequired

Possible values: non-empty

Slug of the menu

description stringrequired

Description of the menu

photo_url urinullable

The photo URL of the menu

announcement stringnullable

Text to display in the announcement bar, implicitly enables the announcement bar.

heading stringnullable

Heading of the menu

colors

object

required

primary color-hex

Primary color of the menu

layout integerrequired

Possible values: <= 2

Default value: 0

Layout of the menu

available boolean

Default value: true

Mark the product as not available

order integerrequired

Default value: 0

Used to order the item, order defaults to ascending.

created_at date-timerequired
updated_at date-timerequired

• ]

Example (from schema)

[
  {
    "id": "4lj8y3ygw1w0",
    "name": "Lunch",
    "slug": "lunch",
    "description": "Great lunch options",
    "photo_url": "https://example.com/photo.jpg",
    "announcement": "Free delivery on orders over $50",
    "heading": "Our lunch menu",
    "colors": {
      "primary": "#ff0000"
    },
    "layout": 0,
    "available": true,
    "order": 1,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
  }
]

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...