Return to documentation index

menu_sections

The menu_sections API retrieves a list of menu sections for an account.

Parameters

  • api_key (string) Required - The API key for the account
  • last_updated_at (datetime) Optional - If this parameter is supplied, only the items whose last edited date is after the supplied date and time will be returned. The parameter should be formatted as "YYYY-MM-DD HH:MM:SS" and will be interpreted as a UTC date and time value.

Response

The menu_sections API returns a JSON array of menu section objects. Each member of the array includes these attributes:

  • id (integer) - Unique identifier.
  • menu_id (integer) - The unique identifier of a menu that includes this menu section.
  • updated_at (string) - The date that this menu was last edited.
  • created_at (string) - The initial date that this menu was created.
  • title (string) - The name of the menu section.
  • subtitle (string) - Second line of menu section name.
  • ordinal (integer) - The placement (zero-based) of the menu section on the menu.
  • status (integer) - The current status of the section. A value of 0 indicates an active section. A value of 1 indicates a deleted section.

Sample Request

https://dashboard.onpremisewine.com/menu_sections.json?api_key=ABCDEF123456

Sample Response

{
  "menu_sections": [
    {
      "id": 189,
      "menu_id": 48,
      "updated_at": "2012-11-19T11:34:17-08:00",
      "created_at": "2012-11-19T11:34:17-08:00",
      "title": "Appetizer",
      "subtitle": null,
      "ordinal": 0,
      "status": 0
    },
    {
      "id": 191,
      "menu_id": 48,
      "updated_at": "2012-11-19T11:34:17-08:00",
      "created_at": "2012-11-19T11:34:17-08:00",
      "title": "Salad",
      "subtitle": null,
      "ordinal": 1,
      "status": 0
    },
    {
      "id": 190,
      "menu_id": 48,
      "updated_at": "2012-11-19T11:34:17-08:00",
      "created_at": "2012-11-19T11:34:17-08:00",
      "title": "Entrée",
      "subtitle": null,
      "ordinal": 2,
      "status": 0
    },
    {
      "id": 192,
      "menu_id": 48,
      "updated_at": "2012-11-19T11:34:17-08:00",
      "created_at": "2012-11-19T11:34:17-08:00",
      "title": "Dessert",
      "subtitle": null,
      "ordinal": 3,
      "status": 0
    }
  ]
}