1. Simphony Transaction Services Gen2 API Guide
  2. Tasks
  3. Organization API

Get search for revenue centers within a location

get

{basePath}/search/revenueCenters

{basePath}/search/revenueCenters?orgShortName=tfoinc&locRef=fdmnh144&latitude=40.763188&longitude=-73.914835&radius=5000&count=2

{basePath}/search/revenueCenters?orgShortName=tfoinc&locRef=fdmnh144&floor=3

The API returns a list of revenue centers within a location based on distance from the point defined in the request and/or the floors provided in the "floor" query parameter.

Supported only for STS Gen2 cloud integrations.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : distanceRevenueCenter
Type: object
Read Only: true
A search results of revenue centers.
Show Source
Nested Schema : revenueCenter
Type: array
Array of revenueCenter objects.
Show Source
Nested Schema : Revenue Center
Type: object
Title: Revenue Center
A revenue center represents the organizational entity that produces and sells items and services.
Show Source
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
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
Nested Schema : orderChannels
Type: array
Array of order channels that are available at this revenue center.
Show Source
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
  • 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 : OrderChannel
Type: object
The order channels for this revenue center.
Show Source
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** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
Example:
{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "ar-AR":"????????"
}
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
Example:
{
    "orderTypeRef":1,
    "name":"Eat In"
}
Nested Schema : suggestedTips
Type: array
Show Source
  • 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
  • A boolean flag indicating if it is the default one when part of a list.
  • Minimum Value: 0
    Minimum Value: > true
    The value of the suggested tip in percents.
Example:
{
    "isDefault":true,
    "percentage":10
}

400 Response

400 Bad Request
Body ()
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
  • A human-readable explanation specific to this occurrence of the problem.
  • A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
  • A short, human-readable summary of the problem type.
  • 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
Back to Top