# Get Restaurant v1.0
The Get Restaurant endpoint retrieves restaurant details for a specified restaurant. The request will return a single restaurant. Expands can be used to retrieve related data.
# Request
# Path Parameters
A list of the supported path parameters is described below.
Name | Required | Type | Description |
---|---|---|---|
key | true | int | The key for the restaurant. |
# Query Parameters
A list of the supported query parameters is described below.
Name | Required | Type | Description |
---|---|---|---|
expand | false | string[] | Provide a list of array properties that should be expanded in the response. See Expands below for more information. |
# Expands
The expand
parameter allows some arrays in the response object to be expanded in the response. We support this to allow you to control the amount of data you will get in the response. Pick only the data you need for the specific scenario and we'll send you less data, faster.
Valid values are: menus
or urls
or services
or tradingTimes
or any combination thereof.
WARNING
Expanding arrays increases the response time as more data needs to be fetched and processed.
# Response
# Response Body
The endpoint returns our ApiResponse envelope. The data
property of the response will contain a Restaurant resource.
# Sample
{
"message": "The operation succeeded!",
"notifications": [],
"data": {
"key": 1,
"accountKey": 411000001,
"name": "Acapulco Spur",
"displayName": "Acapulco Spur",
"brand": {
"key": "SPUR",
"name": "Spur",
"displayName": "Spur",
"enabled": true,
"createdOn": "2013-09-25T13:37:28.8966667",
"modifiedOn": "2021-02-03T09:55:06.4333333"
},
"outletType": "Restaurant",
"restaurantType": "Standard",
"restaurantStatus": "Open",
"tradingStatus": "Open",
"active": true,
"emailAddress": "acapulco@spursteakranch.co.za",
"alternateEmailAddress": null,
"telephoneNumber": "021-7156720",
"alternateTelephoneNumber": null,
"streetAddress": "Glen Alpine Centre, 31 Ladies Mile Rd",
"addressLine1": "Glen Alpine Centre",
"addressLine2": "31 Ladies Mile Rd",
"suburb": "Bergvliet",
"city": "Cape Town",
"province": "Western Cape",
"countryCode": "ZA",
"countryName": "South Africa",
"latitude": -34.048609,
"longitude": 18.451915,
"utcOffset": "+02:00",
"utcOffsetMinutes": 120,
"tradingTimes": [],
"playArea": true,
"caterForDisabled": true,
"smokingSection": true,
"wireless": true,
"halaal": false,
"liquorLicence": true,
"tradeOffPowerGrid": true,
"floorArea": 356,
"numberOfTables": 45,
"numberOfSeats": 248,
"greenEcoStatusRating": 0,
"orderingServices": [],
"urls": [],
"pointOfSale": "Pilot",
"posLinkCode": "4",
"menus": [],
"createdOn": "1972-01-01T00:00:00",
"modifiedOn": "2021-02-18T00:00:00"
}
}
# Errors
The standard error responses apply.