Get a revenue center by the specified identifier for a location
get
{basePath}/organizations/{orgShortName}/locations/{locRef}/revenueCenters/{rvcRef}
{basePath}/organizations/tfoinc/locations/fdmnh144/revenueCenters/42
The API returns details about a specific revenue center in a location.Request
Supported Media Types
- application/json
Path Parameters
-
locRef(required): string
Location Identifier
-
orgShortName(required): string
Organization Identifier
-
rvcRef(required): integer
Revenue Center Identifier
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Revenue Center
Type:
object
Title:
Revenue Center
A revenue center represents the organizational entity that produces and sells items and services.
Show Source
-
address:
object PostalAddress
Represents a postal address
-
consumerName:
string
consumer facing name
-
extensions:
object ExtensionData
Additional Properties Allowed: additionalPropertiesContainer for extension data
-
geoLocation:
object GeoLocation
Coordinate of a location
-
locRef(required):
string
The location identifier.
-
name(required):
string
Revenue Center NameExample:
Bar
-
orderChannels:
array orderChannels
Array of order channels that are available at this revenue center.
-
orderTypes:
array orderTypes
Array of order types that are available at this revenue center.
-
orgShortName(required):
string
The organization identifier.
-
phoneNumber:
string
Associated phone numberExample:
027410-22583
-
rvcRef(required):
integer
Revenue Center IdentifierExample:
5234
-
tables:
array tables
Array of restaurant table identifiers.
Example:
{
"orgShortName":"tfoinc",
"locRef":"fdmnh144",
"rvcRef":"5234",
"name":"Bar",
"orderTypes":[
{
"orderTypeRef":"1",
"name":"Eat In",
"serviceLevelTime":"0",
"suggestedTips":[
]
},
{
"orderTypeRef":"2",
"name":"Take Out",
"suggestedTips":[
{
"isDefault":true,
"percentage":"18"
},
{
"isDefault":false,
"percentage":"20"
},
{
"isDefault":false,
"percentage":"25"
}
]
}
],
"orderChannels":[
{
"orderChannelId":"1",
"name":{
"en-US":"Default-Default"
},
"isDefault":true,
"serviceLevelTime":"0"
},
{
"orderChannelId":"2",
"name":{
"en-US":"Special Delivery",
"de-DE":"Sonderlieferung",
"es-ES":"Entrega especial",
"sk-SK":"??peci??lna z??sielka"
},
"isDefault":false,
"serviceLevelTime":"15"
}
],
"tables":[
"1",
"2",
"3",
"4",
"5"
],
"address":{
"addressLine1":"144 W 94th St",
"addressLine2":"Suite 11F",
"floor":"42A",
"locality":"New York",
"region":"NY",
"postalCode":"10019",
"country":"USA",
"notes":"West Entrance"
},
"phoneNumber":"2741022334",
"geoLocation":{
"latitude":"40.763188",
"longitude":"-73.914835"
}
}
Nested Schema : PostalAddress
Type:
object
Represents a postal address
Show Source
-
addressLine1:
string
First line of an address
-
addressLine2:
string
Second line of an address
-
addressLine3:
string
Third line of an address
-
country:
string
name of country, or country code
-
floor:
string
The floor in a building.
-
locality:
string
city/town/village
-
notes:
string
Additional address details
-
postalcode:
string
postal code, e.g. ZIP in the US
-
region:
string
state/county/province
Nested Schema : ExtensionData
Type:
object
Additional Properties Allowed
Show Source
Container for extension data
Nested Schema : GeoLocation
Type:
object
Coordinate of a location
Show Source
-
latitude:
number
Minimum Value:
-90
Maximum Value:90
WGS84 latitude, in degrees -
longitude:
number
Minimum Value:
-180
Maximum Value:180
WGS84 Longitude, in degrees
Nested Schema : orderChannels
Type:
array
Array of order channels that are available at this revenue center.
Show Source
-
Array of:
object OrderChannel
The order channels for this revenue center.
Example:
[
{
"orderChannelId":"1",
"name":{
"en-US":"Default"
},
"isDefault":true,
"serviceLevelTime":"0"
},
{
"orderChannelId":"2",
"name":{
"en-US":"Special Delivery",
"de-DE":"Sonderlieferung"
},
"isDefault":false,
"serviceLevelTime":"15"
}
]
Nested Schema : orderTypes
Type:
array
Array of order types that are available at this revenue center.
Show Source
-
Array of:
object OrderType
Defines an order type. The Order Type is used by the POS to define the workflow of an order, e.g., Dine-In vs Take-Out.
Example:
[
{
"orderTypeRef":"1",
"name":"Eat In",
"serviceLevelTime":"0",
"suggestedTips":[
]
},
{
"orderTypeRef":"2",
"name":"Take Out",
"suggestedTips":[
{
"isDefault":true,
"percentage":"18"
},
{
"isDefault":false,
"percentage":"20"
},
{
"isDefault":false,
"percentage":"25"
}
]
}
]
Nested Schema : tables
Type:
array
Array of restaurant table identifiers.
Show Source
Example:
[
"1",
"2",
"3",
"4",
"5"
]
Nested Schema : additionalProperties
Type:
object
Nested Schema : OrderChannel
Type:
object
The order channels for this revenue center.
Show Source
-
isDefault(required):
boolean
Whether this order channel is the default order channel
-
name(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
-
orderChannelId(required):
number
Minimum Value:
1
The identifier of the order channel -
serviceLevelTime:
number
Minimum Value:
0
Maximum Value:32767
The service level time for the order channel
Example:
{
"orderChannelId":"2",
"name":{
"en-US":"Special Delivery",
"de-DE":"Sonderlieferung"
},
"isDefault":false,
"serviceLevelTime":"15"
}
Nested Schema : TranslatedString
Type:
object
Additional Properties Allowed
Show Source
A string that contains translations into multiple languages
Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee"
}
Nested Schema : OrderType
Type:
object
Defines an order type. The Order Type is used by the POS to define the workflow of
an order, e.g., Dine-In vs Take-Out.
Show Source
-
name:
string
The name of the order type.
-
orderTypeRef:
number
Minimum Value:
1
Order Type Identifier -
serviceLevelTime:
integer
The required time for the given order type to be prepared.
-
suggestedTips:
array suggestedTips
Example:
{
"orderTypeRef":"1",
"name":"Eat In"
}
Nested Schema : suggestedTips
Type:
Show Source
array
-
Array of:
object SuggestedTip
Defines a suggested tip type. The Suggested Tip is representing a predefined percentage that can be used as a tip and may be marked as a default one when used in a list.
Nested Schema : SuggestedTip
Type:
object
Defines a suggested tip type. The Suggested Tip is representing a predefined percentage that can be used as a tip and may be marked as a default one when used in a list.
Show Source
-
isDefault:
boolean
A boolean flag indicating if it is the default one when part of a list.
-
percentage:
integer
Minimum Value:
0
Minimum Value:> true
The value of the suggested tip in percents.
Example:
{
"isDefault":true,
"percentage":"10"
}
400 Response
400 Bad Request
Root Schema : OrganizationApiProblemDetails
Type:
object
Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).
Show Source
-
details:
string
A human-readable explanation specific to this occurrence of the problem.
-
instance:
string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
-
title:
string
A short, human-readable summary of the problem type.
-
type:
string
A URI reference [RFC3986](https://tools.ietf.org/html/rfc3986) that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".
Example:
{
"type":"error:validation",
"title":"Required value not specified.",
"details":"The OrgShortName value is required.",
"instance":"required_value_missing"
}
401 Response
401 Unauthorized
403 Response
403 Forbidden
404 Response
404 Requested resource not found
Examples
Example Request Body
Not applicable for this endpoint.
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"orgShortName": "tfoinc",
"locRef": "fdmnh144",
"rvcRef": 5234,
"name": "Bar",
"orderTypes": [
{
"orderTypeRef": 1,
"name": "Eat In",
"serviceLevelTime": 20,
"suggestedTips": [
{
"isDefault": false,
"percentage": 10
},
{
"isDefault": true,
"percentage": 20
},
{
"isDefault": false,
"percentage": 25
}
]
},
{
"orderTypeRef": 2,
"name": "Take Out",
"serviceLevelTime": 30,
"suggestedTips": [
{
"isDefault": true,
"percentage": 18
},
{
"isDefault": false,
"percentage": 20
},
{
"isDefault": false,
"percentage": 25
}
]
}
],
"orderChannels": [
{
"orderChannelId": 1,
"name": {
"en-US": "Default-Default"
},
"isDefault": false,
"serviceLevelTime": 0
},
{
"orderChannelId": 2,
"name": {
"en-US": "Special Delivery",
"de-DE": "Sonderlieferung",
"es-ES": "Entrega especial",
"sk-SK": "Špeciálna zásielka"
},
"isDefault": false,
"serviceLevelTime": 0
},
{
"orderChannelId": 3,
"name": {
"en-US": "Mobile Integrator 2"
},
"isDefault": false,
"serviceLevelTime": 5
},
{
"orderChannelId": 4,
"name": {
"en-US": "Mobile Integrator 3",
"de-DE": "Mobile Integrator 3"
},
"isDefault": false,
"serviceLevelTime": 0
},
{
"orderChannelId": 5,
"name": {
"en-US": "Mobile Integrator 4"
},
"isDefault": false,
"serviceLevelTime": 0
},
{
"orderChannelId": 6,
"name": {
"en-US": "Mobile app"
},
"isDefault": true,
"serviceLevelTime": 15
}
],
"tables": [
"1",
"2",
"3",
"4",
"5"
],
"address": {
"addressLine1": "144 W 54th St",
"addressLine2": "Suite 11B",
"floor": "42A",
"locality": "New York",
"region": "NY",
"postalCode": "10019",
"country": "USA",
"notes": "West Entrance"
},
"phoneNumber": "2741022334",
"geoLocation": {
"latitude": 40.763188,
"longitude": -73.914835
}
}