CommonVenue

address
Type: string

Street name (incl. street number) configured for the Venue in the CMS / Management Center
city
Type: string

City name configured for the Venue in the CMS / Management Center
description
Type: string

Description that has been configured in CMS / Management Center (in brand default language)
id
Type: stringFormat: uuid

UUID of Venue
latitude
Type: numberFormat: float

Latitude configured for the Venue in the CMS / Management Center
longitude
Type: numberFormat: float

Longitude configured for the Venue in the CMS / Management Center
name
Type: string

Name of Venue (to be presented to customer)
order_types
Type: 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
serving_times
Type: object · CommonServingTime

See Serving Times reference
- time_from
  Type: stringFormat: date-time
  
  Starting time of Serving Time
- time_to
  Type: stringFormat: date-time
  
  Ending time of Serving Time
- type_id
  Type: integer · CommonServing_type_idenum
  
  Serving type id - 1 - special date, 2 - weekday
  
  values
  1
  2
- weekdays
  Type: array integer[] …2enum
  
  Array of serving weekdays - from 0 - Sunday to 6 - Monday
  
  values
  0
  1
  2
  3
  4
  5
  6
state
Type: integer

Current status of Venue - refer to States reference. Can be used to determine how Venue should be presented to the customer.
timezone
Type: object · Timezone
- name
  Type: string
  
  Timezone Name - please refer to PHP Timezones for full list of supported timezones.
- offset
  Type: string
  
  Timezone offset of UTC
translations
Type: object · Translation
- name
  Type: string
  
  Key "name" is just an example. Can be any of the values in parent object.
zip
Type: string

ZIP code configured for the Venue in the CMS / Management Center

Examples

{
  "id": 1698,
  "name": "Dragan Markovic Test",
  "state": 1,
  "timezone": {
    "name": "Europe/Belgrade",
    "offset": "+02:00"
  },
  "description": "",
  "address": "",
  "city": "",
  "zip": "",
  "latitude": 44.805932,
  "longitude": 20.47436,
  "serving_times": [
    {
      "type_id": 1,
      "time_trom": "2020-05-06",
      "time_to": "2020-05-06",
      "working": true,
      "days": [
        0
      ]
    }
  ],
  "translations": {
    "description": "",
    "kiosk_receipt_footer": null,
    "welcome_message": null
  },
  "order_types": [
    {
      "type_id": 1,
      "state": 1,
      "is_table_supported": true,
      "tip_default": 10,
      "tip_max": 20
    }
  ]
}