1. Simphony Transaction Services Gen2 API Guide
  2. About

About the REST APIs

The Simphony Transaction Services Gen2 (STS Gen2) API is a cloud offering that is provisioned by Oracle and available for use with new deployments of the Simphony Cloud Service.

STS Gen2 provides a RESTful interface for transaction processing and complementary services that will be available both in the cloud as well as within the location. The exposed APIs are stateless and highly scalable, supporting large multi-tenanted Oracle Food and Beverage Cloud environments.

The Organizations API provides the ability to get information about the following subject areas:

  • Organizations (as well as search for locations within an organization)
  • Locations
  • Revenue Centers

The Configuration API provides the ability to get information about the following subject areas using the organizational related details acquired from the Organizations API:

  • Tables
  • Menu (menu items, condiments, condiment rules, pricing...)
  • Discounts
  • Service Charges
  • Tenders
  • Taxes
  • Menu Item Availability
  • Menu Items Barcode

The Checks API provides the ability to calculate, create and manage checks within a revenue center using the details acquired from the Organizations and Configuration APIs. The exposed endpoints fall into the following subject areas:

  • Calculations
  • Check Operations

The Employee API provides the ability to get information about the following subject areas within a property:

  • Employee

Notifications API provides the ability to manage call back POST notifications messages that are sent to the integrator when they register to receive a notification for following events:

  • Organization
  • Configuration
  • Check
  • Employee

You can view a list of all REST Endpoints.