GET Venue

Fetch Venue by Id

Endpoint should return specific Venue response for given Venue UUID.

Path Parameters

venue_id
Type: string
required

Query Parameters

include
Type: string
required

Include query param for Venue

Headers

Accept
Type: string
required

Type of content accepted by the API (application/json in most cases)
Application
Type: string
required

Application key for specific client app
API-VERSION
Type: string
required

Version of the API to be used
Content-Language
Type: string
required

Local language code (in format xx-XX, or simpler xx) for translation purposes
X-QL-Enabled
enum
const:
true
required

Enables the query builder, which is what makes the include, sort[…] and filter[…] query parameters take effect. Send true.

This applies to the two legacy operations that carry a required include parameter and to nothing else. Without the header the request is served by the non-query-builder controller, which ignores those parameters and returns the endpoint's default payload. Do not send it on any other operation, and do not use it on Menu v2, which does not support the query builder at all.
X-Request-ID
Type: string
required

Unique request identifier

Responses

application/json
403

Forbidden
404

Not Found
500

Internal Server Error

get/venues/{venue_id}

curl 'https://api-public-demo.menu.app/api/venues/{venue_id}?include=name%2Cdescription%2Ctranslations%2Chas_discounts%2Chas_loyalty%2Chas_promotions%2Cstate%2Ctimezone%2Caddress%2Ccity%2Czip%2Clatitude%2Clongitude%2Ccode%2Ctax_number%2Careas%2Corder_types%2Ccurrency%2Ccountry%2Callow_item_comments%2Cmenu_languages%2Cserving_times%7Ctype_id%3Bdate%3Bdate_to%3Bworking%3Bdays%3Btime_from%3Btime_to%2Cpickup_time%2Cintegration%7Cmax_comment_limit%2Cavailable_payment_methods%2Cmenu_id%2Cimage%7Cfullsize%3Bthumbnail_medium%2Cprice_configuration%2Cused_price_configurations' \
  --header 'Accept: application/json' \
  --header 'Application: application-key' \
  --header 'API-VERSION: ' \
  --header 'Content-Language: en' \
  --header 'X-QL-Enabled: true' \
  --header 'X-Request-ID: c10b4a70-6274-490d-80a0-03e7bb826937'

Show Schema

{
  "status": "OK",
  "code": 200,
  "method": "GET",
  "data": {
    "venue": {
      "id": "31f3769a-33ce-40d9-8f22-8d910db4fd11",
      "name": "Kauwela Austin 1 Brink",
      "description": "",
      "state": 1,
      "address": "2111 Chicon St",
      "city": "Austin",
      "zip": "78722",
      "latitude": 30.2825159,
      "longitude": -97.7242909,
      "code": "3181",
      "tax_number": "",
      "currency": {
        "id": "dbf418a1-3ee5-4bad-b6a0-ff49f8db77e3",
        "code": "USD",
        "code_numeric": "840",
        "symbol": "$",
        "rounding_unit": 0.01,
        "rounding_unit_tip": 0.01
      },
      "allow_item_comments": false,
      "pickup_time": 5,
      "translations": {
        "description": "",
        "kiosk_receipt_footer": "",
        "welcome_message": ""
      },
      "has_discounts": true,
      "has_loyalty": true,
      "has_promotions": true,
      "timezone": {
        "name": "America/Indiana/Indianapolis",
        "offset": "-04:00"
      },
      "order_types": [
        {
          "id": "12c6d528-b066-4e86-9d54-a0b6e0f053ba",
          "type_id": 6,
          "reference_type": "OrderTypeTakeOut",
          "state": 1,
          "is_table_supported": false,
          "external_channel_only": false,
          "tip_default": 2,
          "tip_max": 15
        }
      ],
      "menu_languages": [
        {
          "name": "English",
          "code": "en",
          "is_default": true,
          "state": 1
        }
      ],
      "available_payment_methods": [
        {
          "payment_method_id": "e3423d4d-7200-4c16-a154-a51fb2695838",
          "payment_method_type_id": 1,
          "payment_method_brand": "Visa",
          "payment_processor_type_id": 32,
          "payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
          "properties": null,
          "fraud_detection_processor_id": null,
          "visibility_scopes": null
        }
      ],
      "menu_id": "a2603062-69cd-4abe-bba1-dbd40a0f5686",
      "price_configuration": {
        "order_types": [
          {
            "type_id": 1,
            "price_configuration": null
          }
        ],
        "external_channels": []
      },
      "used_price_configurations": [
        3
      ],
      "areas": [
        {
          "id": "05a2cea1-9c2a-4c43-adc2-5de0b8f1eb4a",
          "type_id": 4,
          "reference_type": "AreaTakeOut",
          "menu_id": "c7b8a218-1b0c-4fcd-9aa3-0c99da73fd5f",
          "singular_point_id": "542e9f4c-17f2-4602-a258-428c9a7695d8",
          "pos_id": null,
          "name": "takeout",
          "use_tablet": true,
          "state": 1,
          "is_table_supported": 0,
          "properties": {
            "location_type": "table"
          },
          "order_types": [
            {
              "id": "12c6d528-b066-4e86-9d54-a0b6e0f053ba",
              "type_id": 6,
              "reference_type": "OrderTypeTakeOut",
              "state": 1,
              "is_table_supported": null,
              "external_channel_only": false,
              "tip_default": 2,
              "tip_max": 15
            }
          ],
          "table_pos_id": null,
          "tablet": {
            "id": "37f8523d-330a-42a9-9319-edb17aff980f",
            "name": "Austin 1",
            "use_notifications": 0,
            "show_kiosk_orders": false,
            "kiosk_notification_type": 0,
            "middleware_endpoint": null,
            "pls_name": null,
            "state": 3,
            "is_online": false,
            "last_request_at": null,
            "failure_reported": false,
            "is_critical": false,
            "area_ids": [
              "05a2cea1-9c2a-4c43-adc2-5de0b8f1eb4a",
              "4ee99447-9515-41ae-82c3-41058c1c6487",
              "dea0bbe0-c5d6-403e-a097-6cc230b5d890"
            ],
            "allow_disable_product": false
          }
        }
      ],
      "country": {
        "id": "2a93d3c4-3c91-4b42-8373-ebb9f8da00d8",
        "currency_id": "dbf418a1-3ee5-4bad-b6a0-ff49f8db77e3",
        "name": "United States",
        "code": "US",
        "code_alpha3": "USA",
        "code_numeric": "840",
        "calling_code": "+1",
        "distance_unit": "mile",
        "is_address_number_first": false,
        "currency_settings": {
          "currency_space": false,
          "decimal_separator": ".",
          "thousands_separator": ",",
          "symbol_position": "left"
        },
        "supported_travel_modes": [
          "driving",
          "bicycling"
        ],
        "available_payment_methods": []
      },
      "serving_times": [
        {
          "id": "7d9ef4be-9130-49e6-8371-c45b0232a04b",
          "type_id": 2,
          "date": "2022-12-12",
          "date_to": "2022-12-12",
          "working": "2022-12-12",
          "days": [
            1
          ],
          "time_from": "08:49:00",
          "time_to": "13:50:00"
        }
      ],
      "integration": {
        "id": "8f2ca602-2d78-4a85-929a-fa9e416b0b1d",
        "max_comment_limit": 0
      },
      "image": {}
    }
  }
}