CommonVenue

active_emergency_closure
Type: object | null

Set when the store has closed unexpectedly — equipment failure, weather, short staffing. null normally. When it is present the store takes no orders of any type, so surface customer_facing_message rather than letting the customer reach checkout and fail.

Properties: 4
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: OrderType

Order Types that are configured for the Venue

Properties: 5
serving_times
Type: CommonServingTime

See Serving Times reference

Properties: 4
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: Timezone
Properties: 2
translations
Type: Translation
Properties: 1
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
    }
  ]
}