The STS Gen2 Checks API is used to create and manage the checks within a revenue center (use the Organization Service to locate a revenue center). Configuration content (for example, menu items or discounts) from the Configuration API is used to populate a check.

Paths

Resource	Base path
Checks API	https://host/api/v1

The Checks API provides access to the get and modify checks in a revenue center. The context of the operation is defined by the {orgShortName}, {locRef}, and {rvcRef} parameters. In many cases the operations are executed by routing request to on-premises services. This has an increased latency over requests that are processed by cloud-base services.

Check operations that include a check in the request, get the value of the {orgShortName}, {locRef}, and {rvcRef} from the request body via the check header. Check operations that do not include check in the requests, specify these values in the header.

The STS Gen2 Connection Status API is used to retrieve the connection status for a specified revenue center.

Paths

Resource	Base path
Connection Status API	https://host/api/v1

API to indicate status of check processing for a revenue center.

This request checks to see if STS has a connection for this property. The value of the connection status now does not represent a guarantee that the connection status will be the same at any point in the future.

The STS Gen2 Configuration Service is used to interact with POS system configuration. Items are configured for each revenue center under property and organization. Available revenue centers can be obtained from the Organization Service.

Paths

Resource	Base path
Configuration API	https://host/api/v1

The Configuration API provides access to the Tables, Menu (menu items, condiments, condiment rules, pricing...), Discounts, Service Charges, Tenders, Taxes, Menu Item Availability, Menu Items Barcode resources configured for a revenue center.

Because each revenue center is uniquely identified by a combination of the {orgShortName}, {locRef}, and {rvcRef} then the path to each of the resources includes these values.

The following is not supported for STS Gen2 on-premises integrations:

Request
/barcodes/collection

The STS Gen2 Configuration Service is used to interact with POS system configuration. Items are configured for each revenue center under property and organization. Available revenue centers can be obtained from the Organization Service.

Paths

Resource	Base path
Configuration API	https://host/api/v2

The V2 Configuration API provides access to the Menu (menu items, condiments, condiment rules, pricing, combo meals v2...) resources configured for a revenue center.

Because each revenue center is uniquely identified by a combination of the {orgShortName}, {locRef}, and {rvcRef} then the path to each of the resources includes these values.

First available version: STS Gen2 1.6.1

Unavailable V2 Configuration Requests

API v2 requests are not available for the Discounts, Service Charges, Tender Media, Taxes, Menu Item Availability, and Menu Items Barcode resources. All GET requests to the following resources under /api/v2 return a 404 Not Found response.

Method	Request
GET	/barcodes/collection
GET	/discounts/collection
GET	/serviceCharges/collection
GET	/tenders/collection
GET	/taxes
GET	/menus/items/unavailable

The STS Gen2 Employees API is used to interact with an employee within a property (use the Organization Service to locate a property).

Paths

Resource	Base path
Employees API	https://host/api/v1/

The Employees API provides access to the get an employee in a property. The context of the operation is defined by the {orgShortName} and {locRef} parameters.

The STS Gen2 Notifications Service is used to manage call back POST notifications messages that are sent to the integrator when they register to receive organization, configuration, check, and employee events.

Integrators must expose a service endpoint which accepts HTTP POST requests (webhook) to receive notifications from the STS Gen2 Notifications Service. The endpoint must implement TLS 1.2 and listen on port 443.The following top-level domains .com, .net, .org, .edu, .ca, .io, .site, .se, .sa are supported.

Paths

Resource	Base path
Notifications API	https://host/api/v1/

Supported notifications

Integration type	Notifications
STS Gen2 cloud integrations	Organizations Notification Configuration Notification Check Notification Employees Notification
STS Gen2 on-premises integrations	Check Notification

Example notification message

{
        "messages": [
            {
                "id": "8253c2a5-5b3c-497d-a87f-f8bb2e250ba7",
                "creationDate": "2021-08-13T15:40:43.511Z",
                "messageType": {
                    "id": "CheckNotification"
                },
                "resource": {
                    "orgShortName": "tfoinc",
                    "locRef": "fdmnh144",
                    "rvcRef": "42",
                    "checkRef": "929aacee2c6d42c78ae877e824c28eed00000431"
                },
                "data": {
                    "status": "Submitted",
                    "timeStampUtc": "2021-08-13T15:40:44.501Z"
                }
            }
        ]
    }
 

Retry logic

At present retries are not supported. A notification will be sent only once.

STS Gen2 includes resource level notifications that it facilitates via webhooks.

Integrators must expose a service endpoint which accepts HTTP POST requests (webhook) to receive notifications from the STS Gen2 Notifications Service. The endpoint must implement TLS 1.2 and listen on port 443. The following top-level domains .com, .net, .org, .edu, .ca, .io, .site, .se, .sa are supported. Timeout for HTTP requests to subscribers is 15 seconds with no retry

The following notifications are supported for STS Gen2 cloud integrations:
- Organizations Notification
- Configuration Notification
- Check Notification
- Employees Notification

The following notifications are supported for STS Gen2 on-premises integrations:
- Check Notification

The STS Gen2 Organization API is used to interact with organizations, locations, and revenue centers within the organization. It also provides a search capability to support the ability to find locations in an organization or revenue centers within a single location based on geographic location.

Paths

Resource	Base path
Organization API	https://host/api/v1/

The Organization API provides access to organizations, locations, and revenue center resources.

An organization has one or more locations, and each location has one more revenue centers. The identifier for an organization in the API is orgShortName, the identifier for a location in the API is locRef, and the identifier for a revenue center in the API is rvcRef. The identifiers for locations are not unique across all organizations and similarly the identifiers for revenue centers are not unique across all locations within an organization. Since there is no uniqueness the path to access each of the resources must include its parent resource. For this reason, we end up with the following paths to GET each resource.