Get a revenue center by the specified identifier for a location
/api/v1/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
- application/json
-
locRef(required): string
Location Identifier
-
orgShortName(required): string
Organization Identifier
-
rvcRef(required): integer
Revenue Center Identifier
Response
- application/json
200 Response
objectRevenue Center-
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
-
images:
array images
Array of images configured for this revenue center.
-
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.
{
"orgShortName":"tfoinc",
"locRef":"fdmnh144",
"rvcRef":5234,
"name":"Bar",
"images":[
{
"index":"1",
"url":"https://oracleObjectStore.com/images/rvc-web-ordering-banner.jpg",
"altText":"Restaurant web ordering banner",
"comments":"Web Ordering Banner/Header",
"isCloudImage":true,
"size":"1440x400"
}
],
"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
}
}object-
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
objectobject-
latitude:
number
Minimum Value:
-90Maximum Value:90WGS84 latitude, in degrees -
longitude:
number
Minimum Value:
-180Maximum Value:180WGS84 Longitude, in degrees
array-
Array of:
object ImageLink
Represents a link to an image
array-
Array of:
object OrderChannel
The order channels for this revenue center.
[
{
"orderChannelId":1,
"name":{
"en-US":"Default"
},
"isDefault":true,
"serviceLevelTime":0
},
{
"orderChannelId":2,
"name":{
"en-US":"Special Delivery",
"de-DE":"Sonderlieferung"
},
"isDefault":false,
"serviceLevelTime":15
}
]array-
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.
[
{
"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
}
]
}
]array[
"1",
"2",
"3",
"4",
"5"
]objectobject-
altText:
string
Alt text for the imageExample:
Close-up of a cup of coffee with a saucer, showing a dark brown liquid with a frothy top. -
comments:
string
Comments for the image
-
index:
string
Unique identifier for the image
-
isCloudImage:
boolean
-
size:
string
Image size
-
url(required):
string
URL for the image.Example:
https://oracleObjectStore.com/images/coffee822815.jpg
object-
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.
-
orderChannelId(required):
number
Minimum Value:
1The identifier of the order channel -
serviceLevelTime:
number
Minimum Value:
0Maximum Value:32767The service level time for the order channel
{
"orderChannelId":2,
"name":{
"en-GB":"Special Delivery",
"de-DE":"Sonderlieferung",
"es-ES":"Entrega especial",
"sk-SK":"Špeciálna zásielka"
},
"isDefault":false,
"serviceLevelTime":15
}object{
"en-GB":"Special Delivery",
"de-DE":"Sonderlieferung",
"es-ES":"Entrega especial",
"sk-SK":"Špeciálna zásielka"
}object-
name:
string
The name of the order type.
-
orderTypeRef:
number
Minimum Value:
1Order Type Identifier -
serviceLevelTime:
integer
The required time for the given order type to be prepared.
-
suggestedTips:
array suggestedTips
{
"orderTypeRef":1,
"name":"Eat In"
}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.
object-
isDefault:
boolean
A boolean flag indicating if it is the default one when part of a list.
-
percentage:
integer
Minimum Value:
0Minimum Value:> trueThe value of the suggested tip in percents.
{
"isDefault":true,
"percentage":10
}400 Response
object-
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".
{
"type":"error:validation",
"title":"Required value not specified.",
"details":"The OrgShortName value is required.",
"instance":"required_value_missing"
}401 Response
-
WWW-Authenticate: string
Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.
The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.
No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: BearerExpired token: The access token has expired. The timestamp in this example is illustrative.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"Invalid signature: The token signature is invalid. For example, the token may have been modified.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.
The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.
403 Response
404 Response
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
}
}