Area

See Areas reference

  • menu_id
    Type: string

    Menu that will be presented for order type

  • order_types
    Type: array object[] · OrderType[]

    Order Types that are configured for the Venue

    • is_table_supported
      Type: boolean

      Is table service supported

    • state
      Type: integer · CommonStateenum

      Current status of Area - refer to States reference

      values
      • 1
      • 2
      • 3
    • tip_default
      Type: number

      Default tip percentage

    • tip_max
      Type: number

      Max tip percentage

    • type_id
      Type: integer · OrderTypeenum

      Type of Order Types - see Order Types reference

      values
      • 1
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
  • singular_point_id
    Type: string

    Singular point id of area

  • state
    Type: integer · CommonStateenum

    Current status of Area - refer to States reference

    values
    • 1
    • 2
    • 3
  • type_id
    Type: integer · CommonArea_type_idenum

    Type ID for the given Area Type. 1 - Dine-In (Full service), 2 - Pick pay, 3 - Quick Service, 4 - Takeout, 5 - Delivery, 6 - Curbside pickup, 7 - Foodspot

    values
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
Examples
{
  "type_id": 1,
  "menu_id": "dd02d6e3-3dca-4412-af87-bbb26d3e5c5a",
  "singular_point_id": "5e5d240f-170a-4cbd-ad94-92ff1a1b0922",
  "state": 1,
  "order_types": [
    {
      "type_id": 1,
      "state": 1,
      "is_table_supported": true,
      "tip_default": 20,
      "tip_max": 30
    }
  ]
}