Simphony Kiosk JS API

Title and Copyright Information
Introduction
Prerequisites
Solution Overview
Get Started
1. Initialization
2. KioskParameters
3. Pos Configuration
4. Calculate a Check
5. Create Check Payment
6. Submit a Check
7. Submit Print Lines
8. Logging
9. Events
10. Employee Verification
11. Age Verification
12. Redeem Stored Value Card
13. Void Redeem Stored Value Card
Simphony Kiosk JavaScript API ▸
- Static members
- .__SimphonyKioskAPI
Types used in ordering ▸
- Static members
- .AuthAndPayRequest
- .AuthAndPayResponse
- .Check
- .CheckHeader
- .CheckTotals
- .ComboMealItem
- .CondimentItem
- .DiscountItem
- .ExtensionItem
- .MenuItem
- .PaymentData
- .ServiceChargeItem
- .TaxItem
- .TenderItem
- .PrintLinesRequest
- .PrintLinesResponse
- .Error
- .PosApiResponse
- .WebViewOperationRsp
POS Configuration Types ▸
Examples

Title and Copyright Information

Oracle® Simphony
Kiosk JavaScript API Reference Guide
Release 19.9
G43101-01
September 2025

Introduction

The Simphony Kiosk JS API provides an interface that can be utilized by an HTML5 Kiosk ordering application to access the necessary pieces of the POS logic in the Simphony ServiceHost to obtain configuration datasets, be notified of pertinent system events, trigger tax and totals calculation, initiate payment processing and create checks in the Point of Sale.
Additionally, the API offers capabilities to allow a custom HTML5 App to send print commands to a local receipt printer as well as write errors and other important troubleshooting information to the EGateway log, allowing for a consistent source for troubleshooting information.

Prerequisites

A Web Development IDE of their choosing.
Integrators should be familiar with developing web based applications using common web technologies.
Integrators should be familiar with using common browser debug tools like those found in Firefox and Chrome.
Integrators should have a sound understanding of hospitality concepts and be familiar with Simphony application architecture and data models.
Integration to the Simphony Kiosk Javascript API filename KioskAPI.js, requires that integrators have a Simphony client on the appropriate version up and running and configured as a Kiosk.

Solution Overview

Simphony Kiosk JavaScript API solution overview.

SIMPHONY KIOSK JAVASCRIPT API Solution Overview

Get Started

Kiosk JavaScript API will only be loaded and accessible when using the Workstation in Kiosk mode and a web UI is loaded by Kiosk Handler in a local browser.

1. Initialization

The SimphonyKioskApi must be initalized before use. This allows it to make the necessary websocket network connections and fetch any data it needs from Simphony.

When initialization is complete the ApiReady event will be raised. See Events for various kind of events raised by SimphonyKioskAPI.

API call

SimphonyKioskAPI.initialize({config});

Parameters {Config}


`key`	`required`		This is a string to identify your client app, e.g. 'MyKioskWebApp'. Used by Simphony logging.
`onApiEvent`	`required`		This is the callback function to handle events raised by `SimphonyKioskApi`. It should take one argument, the `event` object.

Example of API call

var config =
{
  key: 'MyKioskWebApp',
  onApiEvent: myOnApiEventHandler,
};

SimphonyKioskAPI.initialize(config);

Example of `onApiEvent` callback

function myOnApiEventHandler(event)
{
  switch (event.Message)
  {
    case 'ApiReady':
      console.log('SimphonyKioskAPI initialized successfully and is ready for use.');
      break;
    default:
      console.log(event.Message);
      break;
  }
}

2. KioskParameters

Getting kiosk parameters from kioskParameters

This API provides JSON string containing various settings for the Kiosk web app.

Its value in the KioskParameters are entries in EMC's "Content" for the current revenue center.

Before making an kioskParameters API call, please make sure that the SimphonyKioskAPI.initialize api has been called sucessfully and ApiReady event has been raised. Attempts to do so before initalization is complete will result in errors or incorrect data.

API call

SimphonyKioskAPI.kioskParameters;

Example of API call

const kioskParameters: string = SimphonyKioskAPI.kioskParameters;
  if(kioskParameters) {
      let appSettings = JSON.parse(kioskParameters);
          var orgShortName: string = appSettings.orgShortName;
          var locRef: string = appSettings.locRef;
      }

KioskParameters

KioskParameters can have other settings as per the requirement, follwoing are the absoulte necessary required field to use Simphony Kiosk API.

{
    "kioskParameters": [
        {
            "orgShortName": "Lorem",
            "locRef": "Ipsum",
            "rvcRef": 1,
            "kioskEmployeeNumber": 2,
            "paymentDataSettings":{
                "siteId": "POS_Site_ID",
                "transCurrency": "USD"
            },
            "tenders": [
                {
                    "tenderId": 201,
                    "useSPIPayments": true
                }
            ],
            "orderTypes": [
                {
                    "orderTypeRef": 1,
		                "postOrderInstructions": {
                        "paidInFull": {
                            "en-US": [
                                "1. Take your receipt and proceed to the pickup area.",
                                "2: Look for the status of your order on the order status boards.",
                                "3. Once your order number is called, proceed to the order collection station."
                            ]
                        },
                        "balanceRemaining": {
                            "en-US": [
                                "1. Bal remaining.Take your receipt and proceed to the pickup area.",
                                "2: Look for the status of your order on the order status boards.",
                                "3. Once your order number is called, proceed to the order collection station."
                            ]
                        }
                    }
                }
            ]
        }
    ]
}

3. Pos Configuration

Getting configuration from posConfiguration

The SimphonyKioskApi's posConfiguration property contains all the configuration settings for the revenue center.

Before making a posConfiguration API call, please make sure that the SimphonyKioskAPI.initialize api has been called sucessfully and ApiReady event has been raised. Attempts to do so before initalization is complete will result in errors or incorrect data.

API call

SimphonyKioskAPI.posConfiguration;

Example of API call

const menu: string = SimphonyKioskAPI.posConfiguration?.menu;
  if (menu)
  {
    let menu = JSON.parse(menu);
  }

Properties of `posConfiguration`

The properties of posConfiguration contain the various types of data. The following properties are defined on posConfiguration. A brief description is given below. A more complete specification can be found at ConfigurationData.


Menu		A menu describes the set of items that can be ordered from a revenue center. The menu includes the menu items, prices, and related information to be used when ordering.
Discounts		The discount collection is a list of discounts that can be used when interacting with the checks endpoint. The API returns a collection of discounts that can be used at the specified revenue center.
Tenders		The tender collection is a list of tenders that can be used for payment when interacting with the checks endpoint. The API returns a collection of tenders for the specified revenue center.
ServiceCharges		The service charge collection is a list of service charges that can be used when interacting with the checks endpoint. The API returns a collection of service charges that can be used at the specified revenue center.
Barcodes		The barcodes array contains all available barcodes.
RVC		A revenue center represents the organizational entity that produces and sells items and services..
Location		A location represents the places of business within a customer's organization. A location can have one or more revenue centers.
MenuItemAvailability		This contains data about menu items which are currently unavailable for sale.
MenuV2		A menu V2 supports updated combo meals, enhanced condiment groups and introduces a new combo group structure.

4. Calculate a Check

SimphonyKioskApi has synchronous and asynchronous functions for calculating a check. Both functions take a check as the only parameter.

The calculateTotals(check) function will return a Check containing the result of the calculation, or an error response object if unsuccessful.

The calculateTotalsAsync(check) function returns a resolved Promise with a Check containing the result of the calculation, or a rejected Promise with an error response object if unsuccessful.

API call

SimphonyKioskAPI.calculateTotalsAsync({check});

Parameters {check}


`check`	`required`		The check to calculate.

Example of API call

try
  {
    var check = await SimphonyKioskAPI.calculateTotalsAsync(check);
  } catch (operationError)
  {
    console.Log(operationError.message);
  }

API Response {check}

calculateTotalsAsync(check) returns Check with the update on totals, taking the consideration of following charges.


`Discounts`			A discounts that can be applied to a transaction
`ServiceCharges`			A Service Charges that can be applied to a transaction.
`TaxTotal`			TaxTotal value excludes any inclusive taxn.
`PaymentTotal`			A total of Payment on the check.

Error Response Object

calculateTotalsAsync(check) returns an Error when a check's calculation fails.


`errorMessage`			A description of the error that occurred.
`posapiResponse`			Contains the `error code` and `message` containing additional details about the cause of the error.

5. Create Check Payment

Before a Check is submitted any required payments in its tenders should be created and processed. A tender can be either a Service Total or a Payment.

5.1 Service Total tenders

A Service Total is used to submit an order without payment, for Service Total tenders the payment will need to be removed. follow as mention in example. removePaymentData() must be executed to remove the empty payment created by the TenderItem constructor.

Example to create Service Total tenders

var tenderItem = new SimphonyKioskAPI.TenderItem();
tenderItem.tenderId = {tenderId}
tenderItem.total = {check.Total}
tenderItem.removePaymentData();

5.2 Payment Tender

SimphonyKioskApi has synchronous and asynchronous functions for creating a payment. Both functions take a AuthAndPayRequest as the only parameter.

The submitPayment({authAndPayRequest}) function takes an authAndPayRequest as an argument and returns an AuthAndPayResponse.

The submitPaymentAsync(AuthAndPayRequest) function takes an authAndPayRequest as an argument and returns a resolved Promise with an AuthAndPayResponse, or an error message if unsuccessful.

API call

SimphonyKioskAPI.submitPaymentAsync({authAndPayRequest});

Parameters {authAndPayRequest}


`TransAmount`	`required`	The TransAmount from {check.total}.
		The TransAmount should be represented in the smallest denomination for the currency from KioskParameters `paymentDataSettings.transCurrency`, for example $2.70 should be formated to 270 for TransAmount field.
`GuestNo`	`required`	The hardcoded value of `1`.
`Operator`	`required`	Can use from KioskParameters `kioskEmployeeNumber`, secondary option will be to get from {check.checkEmployeeRef}

Example of API call

var authAndPayRequest = new SimphonyKiosk.Payment.AuthAndPayRequest();
authAndPayRequest.TransAmount = 270;
authAndPayRequest.GuestNo = 1;
authAndPayRequest.Operator = 2;

try {
        let response = await SimphonyKioskAPI.submitPaymentAsync(authAndPayRequest);
    } catch (operationError) {
        return Promise.reject(operationError.message);
    }

API Response {AuthAndPayResponse}

submitPaymentAsync(authAndPayRequest) returns AuthAndPayResponse. Look into the following fields to identify the successful response.


`DriverSuccess`			If DriverSuccess is true then the payment provider was contacted successfully. If it is false then there was a problem contacting the payment provider and the payment was not processed. In this case `DriverMessage` may describe the problem encountered.
`DriverMessage`			If DriverSuccess is false may describe the problem encountered.
`RespCode`			If the payment provider was contacted successfully then RespCode will contain the response code from the payment provider indicating whether the request was successful or not, Successful `RespCode` are ["00", "11", "16"]
`ResponseXml`			Payment response from Merchant Account.

If successful the response should be added to the Check's tenders.paymentData before the check is submitted.

Example to create payment tenders

var tenderItem = new SimphonyKioskAPI.TenderItem();
tenderItem.tenderId = 2;
tenderItem.paymentData.type = "spi.v1";
tenderItem.paymentData.data = {authAndPayResponse.fields} // refer to the following table for `tenderItem.paymentData.data` object.

Fields value for "tenderItem" explained


`tenderId`			When including a "paymentData" object, the SPI interface will replace this "tenderId" with the correct tender based on the "issuerId" in the "data" object so this can just be a valid tender with a type of "payment", can use KioskParameters `tenderId`, where `useSPIPayments=true`.
`paymentData.type`			Always "spi.v1", intended to identify the format of data in the "data" property. Only Valid value : "spi.v1".

Fields value for "tenderItem.paymentData.data" explained


`transDateTime`			Date and Time of the transaction processing, from payment response {TransDateTime}
`transType`			From {TransType} field in AuthAndPayResponse.
`transAmount`			The TransAmount from {check.total}.
			The TransAmount should be represented in the smallest denomination for the currency from KioskParameters `paymentDataSettings.transCurrency`, for example $2.70 should be formated to 270 for TransAmount field.
`tipTotal`			Include from the total tip value selected by the user.
`transCurrency`			Can use KioskParameters `paymentDataSettings.transCurrency`, example value: "USD".
`siteId`			From `{MerchantId}` field in AuthAndPayResponse.
`transToken`			From `{TransToken}` field in AuthAndPayResponse.
`issuerId`			From `{IssuerId}` field in AuthAndPayResponse. .
`pan`			From `{PAN}` field in AuthAndPayResponse.
`expiryDate`			From `{ExpiryDate}` field in AuthAndPayResponse, format must be "YYMM" to meet SPI requirement.
`entryMode`			From `{EntryMode}` field in AuthAndPayResponse.
`cardPresent`			Can use KioskParameters `cardPresent`. If easier, this value can always be set to "1" as cards can only be processed via the PED with Kiosk..
`authCode`			From `{AuthCode}` field in AuthAndPayResponse.
`alternateTransRef`			From `{AlternateTransRef}` field in AuthAndPayResponse.

6. Submit a Check

Once a Check is ready it can be submitted.

SimphonyKioskApi has synchronous and asynchronous functions for submitting a Check. Both functions take a Check as the only parameter.

The submitCheck(check) function returns the Check.

The submitCheckAsync(check) function returns a Promise containing a Check.

API call

SimphonyKioskAPI.submitCheckAsync({check});

Parameters {check}


`check`	`required`		The check to be submitted.

Example of API call

try
  {
    var check = await SimphonyKioskAPI.submitCheckAsync(check);
  } catch (operationError)
  {
    console.Log(operationError.message);
  }

API Response {check}

submitCheckAsync(check) returns check.

Error Response Object

submitCheckAsync(check) returns an Error when fails.


`errorMessage`			A description of the error that occurred.
`posapiResponse`			Contains the `error code` and `message` containing additional details about the cause of the error.

7. Submit Print Lines

SimphonyKioskApi has synchronous and asynchronous functions to send PrintedLines to the printer. Both functions take a PrintLinesRequest as the only parameter.

A printer must be setup on the ServiceHost running the KioskAPI.js to use the printing function.

The submitPrintLines(printLinesRequest) function returns the PrintLinesResponse.

The submitPrintJobAsync(printLinesRequest) function returns a Promise containing a PrintLinesResponse.

API call

SimphonyKioskAPI.submitPrintLines({printLinesRequest});

Parameters {printLinesRequest}


`printerNumber`	`required`	The printer number configured.
`reference`	`optional`	The printed lines reference.
`lines`	`optional`	The list of printed lines to be printed on the local printer.

Example of API call

try
  {
    let printLinesRequest = new SimphonyKiosk.Printing.PrintLinesRequest();

    printLinesRequest.printerNumber = 4;
    printLinesRequest.reference = 'Print job refernce';
    printLinesRequest.lines.push('------------------------------');
    printLinesRequest.lines.push('Print line 1');
    printLinesRequest.lines.push('Print line 2');
    printLinesRequest.lines.push('------------------------------');

    var printLinesResponse = await SimphonyKioskAPI.submitPrintJobAsync(printLinesRequest);

  } catch (operationError)
  {
    console.Log(operationError.message);
  }

API Response {printLinesResponse}

submitPrintJobAsync(printLinesRequest) returns PrintLinesResponse.


`Success`			Opertion success true/false.
`Message`			Print job submitted to printer [printerNumber], text lines [Number of lines printed].

8. Logging

Logging to EGateway with logToHost

The SimphonyKioskApi's logToHost can be use to send log entries to EGateway logs.

API call

SimphonyKioskAPI.logToHost({message}, {level});

Parameters


`message`	`required`		The parameter `message` is a string containing the message for the entry.
`level`	`required`		The parameter `level` is a number indicating the Simphony log level severity for the entry.

level value	Simphony log level
-99	NONE
-3	LOG_ALWAYS_ERROR
-2	LOG_ALWAYS_WARN
-1	LOG_ALWAYS_INFO
0	LOG_ALWAYS_DEBUG
0	LOG_ALWAYS
1	LIGHT_FLOW
2	GENERAL_FLOW
3	DETAIL_FLOW
4	BUFFER_DUMPS
5	ULTIMATE_DEBUG

Example of API call

SimphonyKioskAPI.logToHost('My General Flow message', 2);
SimphonyKioskAPI.logToHost("Some message at level zero" 0);

9. Events

The SimphonyKioskApi raises asynchronous events which can be handled.

Example of event handler call

private onApiEvent(event) {
        switch (event.Message) {
            case 'ApiReady':
                console.log("SimphonyKioskService onApiEvent 'ApiReady'. Dispatching ConnectedEvent");
                break;
            case 'Error':
                eventTarget.dispatchEvent(new ErrorEvent({
                    severity: event.IsFatal ? Severity.Fatal : Severity.Ignorable,
                    message: event.Description
                }));
                break;
        }
    }

Event types by `Message`

SimphonyKioskApi raises following events, events will have one of the folowing values for Message:

ApiReady
ServerConnectionLost
Error
ConfigurationDataUpdated
MenuItemAvailabilityDataUpdated
Scanner
ScannerError

Events may have one or more of the following properties populated:

Description
Data
IsFatal

`ApiReady`

Raised when the SimphonyKioskApi is initialized and ready for use.


`Description`:	The event code which was returned from the websocket connection.

`ServerConnectionLost`

Raised when the websocket loses connection.


`Description`:	The event code which was returned from the websocket connection.
`IsFatal`:	The event code which was returned from the websocket connection.

`Error`

Raised when there is an error from the websocket connection.


`Description`:	The string `'Server communications error: '` followed by the event code which was returned from the websocket connection.
`IsFatal`:	boolean which indicates if the error is recoverable or not.

`ConfigurationDataUpdated`

Raised when updated configuration data is sent to SimphonyKioskApi from the POS.

`MenuItemAvailabilityDataUpdated`

Raised when the updated menu item availability data is sent to SimphonyKioskApi from the POS.

`Scanner`

Raised when a barcode is scanned.


`Data`:	The value of the scanned barcode as a string.

`ScannerError`

Raised when a barcode is scanned unsuccessfully.


`Description`:	The reason for the failure.

10. Employee Verification

SimphonyKioskApi has synchronous and asynchronous functions for employee verification. Both functions take 'Country-Language code' string as the only parameter.

The validateEmployee(language) function will return a WebViewOperationRsp containing the employee verification URL.

The validateEmployeeAsync(language) function will return a WebViewOperationRsp containing the employee verification URL.

API call

SimphonyKioskAPI.validateEmployeeAsync({language});

Parameters {check}


`language`	`required`		The Country-Language code.

Example of API call

try
  {
    var language = "en-US"
    var webviewOperationRsp = await SimphonyKioskAPI.validateEmployeeAsync(language);
  } catch (operationError)
  {
    console.Log(operationError.message);
  }

API Response {webviewOperationRsp}

validateEmployeeAsync(language) returns WebViewOperationRsp.


`Url`			URL to load the employee verification module

If the call fails the response of WebViewOperationRsp.


`Url`			No URl return
`Message`			An active webview is already open
`Description`			Only one webview served up by kiosk handler can be open at any time. If an attempt is made to open a subsequent webview, callers will receive this response clarifying why the request was not honored.

Employee Verificaiton Workflow

Use the WebViewOperationRsp.Url to load the following employee verification workflow:

Employee Card Swipe Screen

On a valid employee swipe card event following response is send

    {
      isValid: true,
      message: ""
      type: "employee_validation"
    }

With invalid employee swipe a request to reswipe card is return:

Employee Reswipe Screen

On reswipe cancelation following response is return

    {
      isValid: false,
      message: "User Cancelled"
      type: "employee_validation"
    }

11. Age Verification

SimphonyKioskApi has synchronous and asynchronous functions for age verification. Both functions take 'Country-Language code' string as the only parameter.

The validateAlcoholPurchase(language) function will return a WebViewOperationRsp containing the age verification URL.

The validateAlcoholPurchaseAsync(language) function will return a WebViewOperationRsp containing the age verification URL.

API call

SimphonyKioskAPI.validateAlcoholPurchaseAsync({language});

Parameters {check}


`language`	`required`		The Country-Language code.

Example of API call

try
  {
    var language = "en-US"
    var webviewOperationRsp = await SimphonyKioskAPI.validateAlcoholPurchaseAsync(language);
  } catch (operationError)
  {
    console.Log(operationError.message);
  }

API Response {webviewOperationRsp}

validateAlcoholPurchaseAsync(language) returns WebViewOperationRsp.


`Url`			URL to load the employee verification module

If the call fails the response of WebViewOperationRsp.


`Url`			No URl return
`Message`			An active webview is already open
`Description`			Only one webview served up by kiosk handler can be open at any time. If an attempt is made to open a subsequent webview, callers will receive this response clarifying why the request was not honored.

Age Verificaiton Workflow

Use the WebViewOperationRsp.Url to load the following age verification workflow:

Age verification request screen

Click on Employee Login to load the following employee verification workflow:

Employee card wwipe screen

On a valid employee swipe card event, age verification is loaded

Age verification screen

On age verificaiton Yes event following response is return

    {
      isValid: true,
      message: ""
      type: "alcoholpurchase_validation"
    }

On age verificaiton No event following response is return

    {
      isValid: false,
      message: "Age requirement not met"
      type: "alcoholpurchase_validation"
    }

12. Redeem Stored Value Card

SimphonyKioskApi has synchronous and asynchronous functions to redeem and void redeem stored value card.

Both functions take 'RedeemCardRequest' the parameter.

The submitStoredValueCommandModuleRedeemCard(RedeemCardRequest) function will return a RedeemCardURLResponse containing the stored value card redeem URL.

The submitStoredValueCommandModuleRedeemCardAsync(RedeemCardRequest) function will return a RedeemCardURLResponse containing the stored value card redeem URL.

API call

SimphonyKioskAPI.submitStoredValueCommandModuleRedeemCardAsync(RedeemCardRequest);

Parameters {RedeemCardRequest}


`commandModuleObjNum`	`required`	The command module number.
`ModuleId`	`required`	The moduleId as define in EMC.
`RvcNumber`	`required`	The revenue center number.
`EmployeeId`	`required`	The employee Id.
`Language`	`required`	The Country-Language code.
`CheckTotalDue`	`required`	The Total due on the check.

Example of API call

var redeemCardRequest = new SimphonyKiosk.StoredValueCommandModule.RedeemCardRequest();
redeemCardRequest.CommandModuleObjNum = 1;
redeemCardRequest.ModuleId = "KioskModule"; 
redeemCardRequest.RvcNumber = 28;
redeemCardRequest.EmployeeId = 38;
redeemCardRequest.Language = "en-US";
redeemCardRequest.CheckTotalDue = 25.50;

try
  {
    var redeemCardResponse = await SimphonyKioskAPI.submitStoredValueCommandModuleRedeemCardAsync(redeemCardRequest);
  } catch (operationError)
  {
    console.Log(operationError.message);
  }

API Response {RedeemCardResponse}

submitStoredValueCommandModuleRedeemCardAsync(redeemCardRequest) returns #RedeemCardURLResponse.


`Url`			URL to load the stored value card redeem module
`Message`			TODO: ?. "An active webview is already open"
`Description`			TODO: ?

Redeem Stored value card workflow

Use the redeemCardResponse.Url to load the following Stored value card workflow:

SVC Card Swipe Screen

SVC Card Enter Number Screen

With valid svc swipe card or card number enter payment screen follow

Payment Screen

Success payment response return:

    {
      RedeemCardSuccess: true,
      RedeemAmount: 25.50,
      ItemType: "T",
      ItemNumber: 2,
      IsOfflineAutoVoid: false,
      Message: "RedeemCard"
    }

Failed payment response return:

    {
      RedeemCardSuccess: false,
      RedeemAmount: 0,
      ItemType: null,
      ItemNumber: 0,
      IsOfflineAutoVoid: false,
      Message: "RedeemCard"
    }

13. Void Redeem Stored Value Card

SimphonyKioskApi has synchronous and asynchronous functions to redeem and void redeem stored value card.

Both functions take 'RedeemCardRequest' the parameter.

The submitStoredValueCommandModuleVoidRedeemCard(VoidRedeemCardRequest) function will return a RedeemCardURLResponse containing the stored value card void redeem URL.

The submitStoredValueCommandModuleVoidRedeemCardAsync(VoidRedeemCardRequest) function will return a RedeemCardURLResponse containing the stored value card void redeem URL.

API call

SimphonyKioskAPI.submitStoredValueCommandModuleVoidRedeemCardAsync(VoidRedeemCardRequest);

Parameters {VoidRedeemCardRequest}


`commandModuleObjNum`	`required`	The command module number.
`ModuleId`	`required`	The moduleId as define in EMC.
`RvcNumber`	`required`	The revenue center number.
`EmployeeId`	`required`	The employee Id.
`Language`	`required`	The Country-Language code.
`VoidRedeemAmount`	`required`	The Total amount to void redeem.

Example of API call

var voidRedeemCardRequest = new SimphonyKiosk.StoredValueCommandModule.VoidRedeemCardRequest();
voidRedeemCardRequest.CommandModuleObjNum = 1;
voidRedeemCardRequest.ModuleId = "KioskModule"; 
voidRedeemCardRequest.RvcNumber = 28;
voidRedeemCardRequest.EmployeeId = 38;
voidRedeemCardRequest.Language = "en-US";
voidRedeemCardRequest.VoidRedeemAmount = 25.50;

try
  {
    var voidRedeemCardResponse = await SimphonyKioskAPI.submitStoredValueCommandModuleVoidRedeemCardAsync(voidRedeemCardRequest);
  } catch (operationError)
  {
    console.Log(operationError.message);
  }

API Response {VoidRedeemCardResponse}

submitStoredValueCommandModuleVoidRedeemCardAsync(voidRedeemCardRequest) returns VoidRedeemCardResponse.


`Url`			URL to load the stored value card void redeem module

Void Redeem process run in the background and once process finish the following response is return.

    {
      VoidRedeemCardSuccess: false,
      LastError: 0,
      Message: "VoidRedeemCard"
    }

Simphony Kiosk JavaScript API

The Simphony Kiosk JavaScript API can be used to get information about a revenue center and place orders.

Simphony Kiosk JavaScript API

Static Members

▸ new __SimphonyKioskAPI()

new __SimphonyKioskAPI()

Instance Members

▸ initialize(config)

Initializes the API. It opens a connection to the POS and loads kioskParameters and posConfiguration data

initialize(config: any)

Type: Function

Parameters

config (any) Configuration for the API

Name	Description
config.key `string`	A string identifying the client, e.g. 'DeveloperKioskWebApp'
config.onApiEvent `any`	A function to handle events raised by the API #events raised by the API will have one of the folowing values for event.Message:'ApiReady', 'Scanner', 'ScannerError', 'Error', 'Startup', 'ConfigurationDataUpdated', 'MenuItemAvailabilityDataUpdated', 'ServerConnectionLost', 'DataStore'

▸ kioskParameters

A JSON string containing various settings for the Kiosk Web app, Its value is KioskParameters entry in EMC's @Content@ for the current revenue center.

kioskParameters

Type: KioskParameters

Returns

any: an object containing the kiosk parameters, or null if not found

▸ logToHost(text, level)

Sends a log message to the EGateway log

logToHost(text: string, level: number)

Parameters

text (string) The log message text

level (number) The log severity level (NONE: -99, LOG_ALWAYS_ERROR: -3, LOG_ALWAYS_WARN: -2, LOG_ALWAYS_INFO: -1, LOG_ALWAYS_DEBUG: 0, LOG_ALWAYS: 0, LIGHT_FLOW: 1, GENERAL_FLOW: 2, DETAIL_FLOW: 3, BUFFER_DUMPS: 4, ULTIMATE_DEBUG: 5)

▸ submitPayment(req)

Submits a payment for processing

submitPayment(req: AuthAndPayRequest): AuthAndPayResponse

Parameters

req (AuthAndPayRequest) The payment request

Returns

AuthAndPayResponse: The payment response

▸ submitPaymentAsync(req)

Submits a payment for processing

submitPaymentAsync(req: AuthAndPayRequest): AuthAndPayResponse

Parameters

req (AuthAndPayRequest) The payment request

Returns

AuthAndPayResponse: A promise containing the payment response

▸ calculateTotals(check)

Calculates the totals for a check

calculateTotals(check: Check): any

Parameters

check (Check) The check to calculate

Returns

any: The result or the error encountered.

▸ calculateTotalsAsync(check)

Calculates the totals for a check

calculateTotalsAsync(check: Check): any

Parameters

check (Check) The check to calculate

Returns

any: A promise containing the result or the error encountered.

▸ submitCheck(check)

Submits a check

submitCheck(check: Check): any

Parameters

check (Check) The check to submit

Returns

any: The result or the error encountered.

▸ submitCheckAsync(check)

Submits a check

submitCheckAsync(check: Check): any

Parameters

check (Check) The check to submit

Returns

any: A promise containing the result or the error encountered.

Types used in ordering

These are the types used for creating and placing Checks.

Types used in ordering

Static Members

▸ new AuthAndPayRequest()

AuthAndPayRequest class

new AuthAndPayRequest()

Instance Members

▸ TransAmount

Gets or sets the TransAmount

TransAmount

Properties

TransAmount (number)

▸ GuestNo

Gets or sets the GuestNo

GuestNo

Properties

GuestNo (number)

▸ Operator

Gets or sets the Operator

Operator

Properties

Operator (string)

▸ new AuthAndPayResponse()

AuthAndPayResponse class

new AuthAndPayResponse()

Instance Members

▸ DriverSuccess

Gets or sets the DriverSuccess

DriverSuccess

Properties

DriverSuccess (boolean)

▸ DriverMessage

Gets or sets the DriverMessage

DriverMessage

Properties

DriverMessage (string)

▸ DriverDescription

Gets or sets the DriverDescription

DriverDescription

Properties

DriverDescription (string)

▸ RequestXml

Gets or sets the RequestXml

RequestXml

Properties

RequestXml (string)

▸ ResponseXml

Gets or sets the ResponseXml

ResponseXml

Properties

ResponseXml (string)

▸ SequenceNo

Gets or sets the SequenceNo

SequenceNo

Properties

SequenceNo (string)

▸ TransType

Gets or sets the TransType

TransType

Properties

TransType (string)

▸ RespCode

Gets or sets the RespCode, successful RespCode are ["00", "11", "16"]

RespCode

Properties

RespCode (string)

▸ RespText

Gets or sets the RespText

RespText

Properties

RespText (string)

▸ TransToken

Gets or sets the TransToken

TransToken

Properties

TransToken (string)

▸ IssuerId

Gets or sets the IssuerId

IssuerId

Properties

IssuerId (string)

▸ PAN

Gets or sets the PAN

PAN

Properties

PAN (string)

▸ ExpiryDate

Gets or sets the ExpiryDate

ExpiryDate

Properties

ExpiryDate (string)

▸ AuthCode

Gets or sets the AuthCode

AuthCode

Properties

AuthCode (string)

▸ RRN

Gets or sets the RRN

RRN

Properties

RRN (string)

▸ AlternateTransRef

Gets or sets the AlternateTransRef

AlternateTransRef

Properties

AlternateTransRef (string)

▸ EntryMode

Gets or sets the EntryMode

EntryMode

Properties

EntryMode (string)

▸ OfflineFlag

Gets or sets the OfflineFlag

OfflineFlag

Properties

OfflineFlag (string)

▸ MerchantId

Gets or sets the MerchantId

MerchantId

Properties

MerchantId (string)

▸ TerminalId

Gets or sets the TerminalId

TerminalId

Properties

TerminalId (string)

▸ ExtTerminalId

Gets or sets the ExtTerminalId

ExtTerminalId

Properties

ExtTerminalId (string)

▸ CardAlias

Gets or sets the CardAlias

CardAlias

Properties

CardAlias (string)

▸ PrintData

Gets or sets the PrintData

PrintData

Properties

PrintData (string)

▸ new Check()

The model for a Check.

new Check()

Instance Members

▸ taxes

Array of tax item. (optional)

taxes

Properties

taxes (Array<TaxItem>?)

▸ printedLines

Array of Printed Lines. If there was no printer configured on the device that received the request, the printedLines will not be returned. (optional)

printedLines

Properties

printedLines (Array<string>?)

▸ extensions

Array of extension detail. (optional)

extensions

Properties

extensions (Array<ExtensionItem>?)

▸ serviceCharges

Array of service charges. (optional)

serviceCharges

Properties

serviceCharges (Array<ServiceChargeItem>?)

▸ discounts

Array of discounts. (optional)

discounts

Properties

discounts (Array<DiscountItem>?)

▸ comboMeals

Array of combo meal items. (optional) If there were no combo meal items on the check the returned array will be empty.

comboMeals

Properties

comboMeals (Array<ComboMealItem>?)

▸ menuItems

Array of menu items. (optional)

menuItems

Properties

menuItems (Array<MenuItem>?)

▸ checkNotifications

Array of past notifications for the check. (optional)

checkNotifications

Properties

checkNotifications (Array<object>?)

▸ tenders

Array of tender items. (optional)

tenders

Properties

tenders (Array<TenderItem>?)

▸ header

The check header contains information describing the overall check.

header

Properties

header (CheckHeader)

▸ totals

Contains a set of totals for aspects of the check. (optional)

The values from the check total object relate in the following way:

subtotal (sum of menu items sales - discounts) - discountTotal + autoServiceChargeTotal + serviceChargeTotal + taxTotal - paymentTotal = totalDue

totals

Properties

totals (CheckTotals)

▸ new CheckHeader()

The check header contains information describing the overall check.

new CheckHeader()

Instance Members

▸ informationLines

An array of strings containing text that may appear on the guest check. (optional) Consult the POS administrator to determine what is supported by their configuration.

informationLines

Properties

informationLines (Array<string>?)

▸ isTrainingCheck

Flag used to identify a training check. (optional)

isTrainingCheck

Properties

isTrainingCheck (boolean?)

▸ language

The language culture reference associated with the check. (optional) This value is used to return "name" property of check items in a desired language.

language

Properties

language (string?)

▸ guestCount

The number of guests on the check. (optional)

guestCount

Properties

guestCount (int?)

▸ pickupTime

The time requested for the order to be collected. (optional)

If not provided the current time plus the Service Level Time for the given order type is assumed. Time is local in the request but UTC in the response.

pickupTime

Properties

pickupTime (Date?)

▸ fireTime

The time requested for the order to "fire" to the kitchen. (optional)

This is when preparation will start. If not provided, the current time is assumed. The dateTime in requests should be reflected in the Location/RVCs localized time, while responses will be shown in Zulu/UTC+0.

fireTime

Properties

fireTime (Date?)

▸ openTime

The time the check is opened/created. Time is UTC. (optional)

openTime

Properties

openTime (Date?)

▸ tableGroupNumber

The table-group of the check. (optional)

Assigned by POS and indicates the number of checks open checks with the same table.

tableGroupNumber

Properties

tableGroupNumber (int?)

▸ tableName

Table number or name (optional)

The table for the check from the revenue center configuration.tableName attribute can reflect either a single table number or a table name (in both cases represented by a string data type in the api).

RVC option bit 18 is responsible for deciding if the value reflected in the tableName is utilized by the POS as the table name or the table number.

tableName

Properties

tableName (string?)

▸ orderTypeRef

The order type identifier from the revenue center configuration.

orderTypeRef

Properties

orderTypeRef (number)

▸ checkEmployeeRef

The identifier of the employee that is used for the operations.Simphony: the employee object number.

checkEmployeeRef

Properties

checkEmployeeRef (number)

▸ checkName

The reference for the check provided at time of check creation. (optional)

This must be unique among all open checks at the revenue center.

checkName

Properties

checkName (string?)

▸ checkNumber

A check identifier generated by the POS when the check is created. (optional)

checkNumber

Properties

checkNumber (int?)

▸ idempotencyId

A unique identifier for the request generated by the integrator.

Pattern: [0-9a-f]{32} This should be a UUID v4 formatted value minus dashes.

idempotencyId

Properties

idempotencyId (string)

▸ checkRef

The unique check reference generated by the POS system when the check is created. (optional)

checkRef

Properties

checkRef (string?)

▸ rvcRef

Revenue center identifier.

rvcRef

Properties

rvcRef (number)

▸ locRef

Location identifier.

locRef

Properties

locRef (string)

▸ orgShortName

Organization identifier.

orgShortName

Properties

orgShortName (string)

▸ status

Information about the status of the check. (optional)

Allowed Values:

open: indicates the check has a balance due and is 'open' (meaning it can be modified)
closed: indicates the check has been paid in full and is 'closed' (meaning it cannot be modified)

status

Properties

status (string?)

▸ paymentStoreId

An identifier of a payment store provided by the point of sale. (optional) testing

paymentStoreId

Properties

paymentStoreId (string?)

▸ preparationStatus

Information about the preparation status of the check, with submitCheck response. (optional)

Allowed Values:

Uninitialized: indicates that the check was not fired. In use when pickupTime and fireTime is utilized in the request. Also returned when check status is "closed".
Submitted: indicates that one or more items on the check have been fired to the kitchen.
Prepared: indicates that one or more items on the check have been prepared and moved "bumped" to the next stage.
Packaged: indicates that the check expedition was done.

preparationStatus

Properties

preparationStatus (string?)

▸ new CheckTotals()

Contains a set of totals for aspects of the check.

The values from the check total object relate in the following way:

subtotal (sum of menu items sales - discounts) - discountTotal + autoServiceChargeTotal + serviceChargeTotal + taxTotal - paymentTotal = totalDue

new CheckTotals()

Instance Members

▸ subtotal

The subtotal of the check. (optional)

This is the sum of net menu item totals.

The net menu item total for a single menu item is: (menu item total + item discounts + surcharge).

subtotal

Properties

subtotal (decimal?)

▸ subtotalDiscountTotal

The total of discounts applied to the subtotal. (optional)

subtotalDiscountTotal

Properties

subtotalDiscountTotal (decimal?)

▸ autoServiceChargeTotal

The total of service charges automatically added to the check. (optional)

autoServiceChargeTotal

Properties

autoServiceChargeTotal (decimal?)

▸ serviceChargeTotal

The service charge total of the check. (optional)

serviceChargeTotal

Properties

serviceChargeTotal (decimal?)

▸ taxTotal

The tax total of the check. (optional)

This value excludes any inclusive tax.

taxTotal

Properties

taxTotal (decimal?)

▸ paymentTotal

The total of the payments on the check. (optional)

paymentTotal

Properties

paymentTotal (decimal?)

▸ totalDue

The remaining balance due for the check. (optional)

totalDue

Properties

totalDue (decimal?)

▸ new ComboMealItem()

A Combo Meal that can be ordered.

new ComboMealItem()

Instance Members

▸ comboMealId

Combo meal object number.

comboMealId

Properties

comboMealId (number)

▸ seat

Seat assignment for the item. (optional)

seat

Properties

seat (int?)

▸ comboItem

A menu item on the check represents an item that is purchased.

comboItem

Properties

comboItem (MenuItem)

▸ mainItem

A menu item on the check represents an item that is purchased.

mainItem

Properties

mainItem (MenuItem)

▸ sideItems

Combo meal side items (for example, French Fries or Coke).

sideItems

Properties

sideItems (Array<MenuItem>)

▸ extensions

Array of extension detail (optional)

extensions

Properties

extensions (Array<ExtensionItem>?)

▸ new CondimentItem()

CondimentItem class

new CondimentItem()

Instance Members

▸ referenceText

Additional text associated with the item. (optional)

referenceText

Properties

referenceText (string?)

▸ seat

Seat number of item on the check. (optional)

seat

Properties

seat (int?)

▸ total

Amount of item for the specified quantity. (optional)

total

Properties

total (decimal?)

▸ priceSequence

The price sequence number to set the appropriate price level. (optional)

priceSequence

Properties

priceSequence (int?)

▸ unitPrice

The price that should be used for the item. (optional)

unitPrice

Properties

unitPrice (number)

▸ quantity

The quantity of this item. (optional)

If present minimum value is 1.

quantity

Properties

quantity (decimal?)

▸ name

The name of the menu item defined in the POS. (optional)

name

Properties

name (string?)

▸ definitionSequence

The menu item definition sequence identifier.

Indicates the definition of item that is used.

This value is ignored on Oracle.RES platform.

definitionSequence

Properties

definitionSequence (number)

▸ condimentId

The menu item's POS identifier.

condimentId

Properties

condimentId (number)

▸ surcharge

Surcharge amount. (optional)

surcharge

Properties

surcharge (decimal?)

▸ itemDiscounts

Array of discounts applied to the menu item. (optional)

itemDiscounts

Properties

itemDiscounts (Array<DiscountItem>?)

▸ new DiscountItem()

Definition of a discount that can be applied to a transaction.

new DiscountItem()

Instance Members

▸ discountId

The discount identifier.

discountId

Properties

discountId (number)

▸ name

The name of the discount defined in the POS. (optional)

name

Properties

name (string?)

▸ seat

Seat number of item on the check. (optional)

seat

Properties

seat (int?)

▸ referenceText

Additional text associated with the discount. (optional)

referenceText

Properties

referenceText (string?)

▸ total

The value of the discount for the associated line number. (optional)

In the request, if the discount is an open discount then set value to the amount (1.25) or percentage (0.1250 for 12.5%) that should be applied.

For preset discounts the total property in the request is ignored.

In the response, the total is the amount by which the transaction is discounted.

total

Properties

total (decimal?)

▸ isAutomatic

Flag to indicate the item was applied by automatically by the POS system. (optional)

isAutomatic

Properties

isAutomatic (boolean?)

▸ extensions

Array of extension detail.

extensions

Properties

extensions (Array<ExtensionItem>)

▸ new ExtensionItem()

Object that can contain extensibility detail to be stored with the check.

new ExtensionItem()

Instance Members

▸ options

Array of options that define behavior of the extension item. (optional)

Option	Description
printOnDisplay	When specified the displayName is shown on the display
printOnReceipt	When specified the displayName is printed on the receipt/check
printInKitchen	When specified the displayName is printed on the kitchen chit
includeInApiResponse	When specified the extension item is return as part of the check in the API responses.

options

Properties

options (Array<string>?)

▸ displayName

A string displayed and/or printed if this item is displayed or printed. (optional)

displayName

Properties

displayName (string?)

▸ appName

The name of the application associated with this data. (optional)

Defined by the caller.

appName

Properties

appName (string?)

▸ dataName

Name of the data stored by this extensibility item. (optional)

dataName

Properties

dataName (string?)

▸ dataType

Describes the type of data stored by this extensibility item . (optional)

Defined by the caller.

dataType

Properties

dataType (string?)

▸ data

The data payload for the extensibility data. (optional)

data

Properties

data (string?)

▸ new MenuItem()

A menu item on the check represents an item that is purchased. 111

new MenuItem()

Instance Members

▸ itemDiscounts

Array of discounts applied to the menu item. (optional)

itemDiscounts

Properties

itemDiscounts (Array<DiscountItem>?)

▸ surcharge

The calculated surcharge amount based on the rate configured for the surcharge associated with the item. (optional)

surcharge

Properties

surcharge (decimal?)

▸ referenceText

Additional text associated with the item. (optional)

Maximum Length: 20

referenceText

Properties

referenceText (string?)

▸ seat

Seat number of item on the check. (optional)

seat

Properties

seat (int?)

▸ total

The total cost of the item (extended to account for the quantity). (optional)

total

Properties

total (decimal?)

▸ priceSequence

The price sequence number to set the appropriate price level. (optional)

priceSequence

Properties

priceSequence (int?)

▸ unitPrice

The price associated with the item. (optional)

unitPrice

Properties

unitPrice (decimal?)

▸ quantity

The quantity of this menu item. (optional)

If present minimum value is 1.

quantity

Properties

quantity (decimal?)

▸ name

The name of the menu item defined in the POS. (optional)

name

Properties

name (string?)

▸ definitionSequence

The menu item definition sequence identifier. (optional)

Indicates the definition of item that is used.

This value is ignored on Oracle.RES platform.

definitionSequence

Properties

definitionSequence (number)

▸ menuItemId

The menu item's POS identifier.

menuItemId

Properties

menuItemId (number)

▸ condiments

Array of condiments represented in menu item. (optional)

If there are no condiments configured, this array will be empty.

condiments

Properties

condiments (Array<CondimentItem>?)

▸ extensions

Array of extension detail.

extensions

Properties

extensions (Array<ExtensionItem>)

▸ new PaymentData()

Payment data for the Check.

The Simphony Payment Interface (SPI) data. Only Oracle payment partners have the ability to utilise the SPI payemnt data.

new PaymentData()

Instance Members

▸ type

Describes the type of data contained in this payment data object.

Type structure identifier, format identifier values can be found at https://docs.oracle.com/en/industries/hospitality/integration_platforms.html.

type

Properties

type (string)

▸ data

Object containing data for the type of payment.

data

▸ new ServiceChargeItem()

A service charge that can be applied to a transaction.

new ServiceChargeItem()

Instance Members

▸ serviceChargeId

The service charge's object number reference.

serviceChargeId

Properties

serviceChargeId (number)

▸ name

The name of the service charge. (optional)

name

Properties

name (string?)

▸ total

The value of the service charge. (optional)

In the request, if the service charge is an open then set value to the amount (1.25) or percentage (0.1250 for 12.5%) that should be applied.

For preset a service charge the total property in the request is ignored. In the response, the total is the amount of the service charge applied to the check.

total

Properties

total (decimal?)

▸ seat

Seat number of item on the check. (optional)

seat

Properties

seat (int?)

▸ referenceText

Additional text associated with the service charge. (optional)

referenceText

Properties

referenceText (string?)

▸ extensions

Array of extension detail. (optional)

extensions

Properties

extensions (Array<ExtensionItem>?)

▸ new TaxItem()

TaxItem class

new TaxItem()

Instance Members

▸ taxRateId

Gets or sets the taxRateId

taxRateId

Properties

taxRateId (number)

▸ name

Gets or sets the name

name

Properties

name (string)

▸ total

Gets or sets the total

total

Properties

total (number)

▸ new TenderItem()

TenderItem class

new TenderItem()

Instance Members

▸ tenderId

Tender identifier.

tenderId

Properties

tenderId (number)

▸ name

The name of the tender defined in the POS. (optional)

name

Properties

name (string?)

▸ total

The total of the tender item. (optional)

A value of zero will result payment for the full amount.

total

Properties

total (decimal?)

▸ chargedTipTotal

The amount of charged tip to apply to the transaction. (optional)

This amount is the portion of the payment that represents the charged tip.

The chargedTipTotal field will not have an impact on a check if the "total" field is not specified.

chargedTipTotal

Properties

chargedTipTotal (decimal?)

▸ referenceText

Additional text associated with the tender. (optional)

referenceText

Properties

referenceText (string?)

▸ paymentData

Payment data for the tender (optional)

You can access Oracle Payment Interface documentation through the following Oracle Hospitality documentation page: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html

paymentData

Properties

paymentData (PaymentData?)

▸ extensions

Array of extension detail. (optional)

extensions

Properties

extensions (Array<ExtensionItem>?)

▸ removePaymentData()

Sets paymentData to 'undefined'. This should be used when using a serviceTotal tender.

removePaymentData()

▸ new PrintLinesRequest()

The model for a PrintLinesRequest.

new PrintLinesRequest()

Instance Members

▸ printerNumber

Gets or sets the Printer Number

printerNumber

Properties

PrinterNumber (number)

▸ reference

Gets or sets the printed lines reference

reference

Properties

reference (string)

▸ lines

Gets the Printed lines collection, Push the Printed lines to the collection

lines

Properties

lines (string)

▸ new PrintLinesResponse()

The model for a PrintLinesResponse.

new PrintLinesResponse()

Instance Members

▸ success

Gets or sets printing success

success

Properties

Success (boolean)

▸ message

Gets or sets message

message

Properties

Success (boolean)

▸ new Error()

Error response of SimphonyKioskApi.

new Error()

Instance Members

▸ errorMessage

Brief explanation of the cause of the error.

errorMessage

Properties

errorMessage (string)

▸ posapiResponse

Additional details about the cause of the error.

posapiResponse

Properties

PosApiResponse (PosApiResponse)

▸ new PosApiResponse()

Additional details about the cause of the Error.

new PosApiResponse()

Instance Members

▸ code

Error Code.

code

Properties

code (string)

▸ message

A detailed explanation of the cause of the error.

message

Properties

header (message)

▸ new WebViewOperationRsp()

WebViewOperationRsp response of Employee Verification.

new WebViewOperationRsp()

Instance Members

▸ url

URL to the employee verification module.

url

Properties

url (string)

▸ message

TODO: ??

message

Properties

message (string)

▸ description

TODO: ??

description

Properties

description (string)

POS Configuration Types

These are the types returned by SimphonyKioskApi posConfiguration()

POS Configuration Types

Static Members

▸ ConfigurationData

Configuration data for this revenue center

ConfigurationData

Type: Object

Properties

menu (Menu) : The menu for this revenue center

discounts (DiscountCollection) : The discounts for this revenue center

tenders (TenderCollection) : The tenders for this revenue center

servicecharges (ServiceChargeCollection) : The service charges for this revenue center

barcodes (BarcodeCollection) : The barcodes for this revenue center

rvc (RevenueCenter) : Information about this revenue center

location (Location) : The location for this revenue center

menuitemAvailability (MenuItemAvailability) : The currently unavailable menu items for this revenue center

▸ new Menu()

A menu describes the set of items that can be ordered from a revenue center. The menu includes the menu items, prices, and related information necessary to order an item.

new Menu()

Instance Members

▸ orgShortName

Organization identifier

orgShortName

Type: string

Example

"mymeal"

▸ locRef

Location identifier

locRef

Type: string

Example

"store66"

▸ rvcRef

Revenue Center identifier

rvcRef

Type: number

Example

▸ menuId

Menu Identifier

menuId

Type: string

Example

"myb:store2:dining"

▸ name

Menu name

name

Type: string

Example

"Bar Menu"

▸ description

A description of the menu

description

Type: string?

▸ menuItems

The menu's menu items

menuItems

Type: Array<MenuItems>

▸ comboMeals

The menu's combo meals

comboMeals

Type: Array<ComboMealItem>?

▸ condimentItems

The menu's condiments

condimentItems

Type: Array<CondimentItems>?

▸ condimentGroups

The menu's condiment groups

condimentGroups

Type: Array<CondimentGroup>?

▸ familyGroups

The menu's family groups

familyGroups

Type: Array<FamilyGroupItem>?

▸ allergens

The menu's allergens

allergens

Type: Array<Allergen>?

▸ new MenuItems()

A Menu Item is an item that is ordered.

new MenuItems()

Instance Members

▸ name

The menu item's name translated into multiple languages

name

Type: TranslatedString?

▸ menuItemId

Menu Item Identifier

menuItemId

Type: number

Example

▸ familyGroupRef

Reference to a family group item in menu.familyGroups

familyGroupRef

Type: number

▸ definitions

Definitions for this menu item.

definitions

Type: Array<MenuItemDefinition>

▸ dietaryInformation

Dietary information for this menu item

dietaryInformation

Type: Array<string>?

▸ tags

Tags for this menu item

tags

Type: Array<string>?

▸ tagGroups

Tag groups for this menu item

tagGroups

Type: Array<TagGroup>?

▸ new MenuItemDefinition()

A menu item definition contains operational attributes of a menu item.

new MenuItemDefinition()

Instance Members

▸ definitionSequence

The number of the definition. This value is used when ordering the item.

definitionSequence

Type: number

▸ name

The menu item definition's name translated into multiple languages.

name

Type: TranslatedString?

▸ name2

The menu item definition's name2 translated into multiple languages.

name2

Type: TranslatedString

▸ slus

A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.

slus

Type: Array<ScreenLookup>?

▸ taxClassRef

Reference to tax class definition.

taxClassRef

Type: number?

▸ prices

Collection of prices that can be uses when ordering a menu item.

prices

Type: Array<MenuItemPrice>?

▸ defaultCondiments

The collection of condiments associated with the menu item by default.

defaultCondiments

Type: Array<DefaultCondiment>?

▸ condimentGroupRules

Defines a set of condiment groups from which items are selected when adding an the menu item to a guest check.

condimentGroupRules

Type: Array<CondimentGroupRule>?

▸ consumerName

The consumer name translated into multiple languages.

consumerName

Type: TranslatedString?

▸ consumerDescription

The consumer description translated into multiple languages.

consumerDescription

Type: TranslatedString?

▸ images

A collection of information about images for this item.

images

Type: Array<ImageLink>?

▸ consumerAdvisoryText

The consumer advisory text translated into multiple languages.

consumerAdvisoryText

Type: TranslatedString?

▸ allergens

List of identifiers that references allergens that apply to this menu item.

allergens

Type: Array<string>?

Example

["milk","peanut"]

▸ nutritionalData

A list of nutritional data for the menu item. It is assumed that nutritional items are defined where the serving size is one of the menu item.

nutritionalData

Type: Array<NutritionalData>?

▸ options

A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.).

options

Type: Array<"containsAlcohol">?

▸ tags

List of tags that apply to this menu item.

tags

Type: Array<string>?

Example

["hot","cold"]

▸ tagGroups

List of tag groups that apply to this menu item.

tagGroups

Type: Array<TagGroup>?

▸ extensions

Container for extension data.

extensions

Type: Object?

▸ new CondimentItems()

A Condiment Item is an item used to provide information about how a menu item is prepared. Condiments may have prices that add to price of the item it modifies. Condiments may also have default condiments and its condiment modifications, e.g., a Steak with Salad option that has a dressing option.

new CondimentItems()

Instance Members

▸ name

The name of the condiment translated into multiple languages

name

Type: TranslatedString

▸ condimentId

Condiment Item Identifier

condimentId

Type: number

Example

▸ familyGroupRef

Reference to a family group item in menu.familyGroups

familyGroupRef

Type: number

▸ definitions

This condiment's definitions

definitions

Type: Array<CondimentItemDefinition>

▸ dietaryInformation

Dietary information for this condiment item

dietaryInformation

Type: Array<string>?

▸ tags

Tags for this condiment item

tags

Type: Array<string>?

▸ tagGroups

Tag groups for this condiment item

tagGroups

Type: Array<TagGroup>?

▸ new FamilyGroupItem()

Model for a Family Group

new FamilyGroupItem()

Instance Members

▸ familyGroupItemId

Identifier for the family group

familyGroupItemId

Type: number

▸ name

The name of the family group translated into multiple languages.

name

Type: TranslatedString?

▸ consumerName

The consumer facing name of the family group translated into multiple languages.

consumerName

Type: TranslatedString?

▸ consumerDescription

The consumer facing description of the family group translated into multiple languages.

consumerDescription

Type: TranslatedString?

▸ images

Information about images for this family group.

images

Type: Array<ImageLink>?

▸ new Allergen()

Model for an allergen

new Allergen()

Instance Members

▸ allergenId

Identifier for an allergen.

allergenId

Type: string

▸ name

The name of the allergen translated into multiple languages.

name

Type: TranslatedString?

▸ new CondimentItemDefinition()

A condiment item definition contains operational attributes of a condiment item.

new CondimentItemDefinition()

Instance Members

▸ number

The number of the definition. This value is used when ordering the item.

number

Type: number

▸ name

The name of this condiment definition translated into multiple languages.

name

Type: TranslatedString

▸ name2

The name2 of this condiment definition translated into multiple languages.

name2

Type: TranslatedString

▸ slus

A collection of the screen-lookup groups for the item. This value is provided to group or filter items on a user interface.

slus

Type: Array<ScreenLookup>?

▸ prices

Collection of prices that can be used when ordering a condiment item.

prices

Type: Array<MenuItemPrice>?

▸ consumerName

The consumer name translated into multiple languages.

consumerName

Type: TranslatedString?

▸ consumerDescription

The consumer description translated into multiple languages.

consumerDescription

Type: TranslatedString?

▸ images

A collection of information about images for this item.

images

Type: Array<ImageLink>?

▸ allergens

List of identifiers that references allergens that apply to this condiment item.

allergens

Type: Array<string>?

Example

["milk","peanut"]

▸ nutritionalData

List of nutritional Data that apply to this condiment item.

nutritionalData

Type: Array<NutritionalData>?

▸ options

A list of option values. If present the corresponding option is set. Duplicates are ignored. (Note - Supported by Simphony version 19.2.1 or greater. Ignored for Simphony version 19.2.0.).

options

Type: Array<"containsAlcohol">?

▸ tags

List of tags that apply to this condiment item.

tags

Type: Array<string>?

Example

["hot","cold"]

▸ tagGroups

Tag groups that apply to this condiment item.

tagGroups

Type: Array<TagGroup>?

▸ extensions

Container for extension data

extensions

Type: Object?

▸ new CondimentGroup()

A group that references one-or-more condiment items

new CondimentGroup()

Instance Members

▸ condimentGroupId

Condiment Group Identifier

condimentGroupId

Type: number

Example

▸ name

The name of this condiment group translated into multiple languages.

name

Type: TranslatedString

▸ condimentItemRefs

An array of references to items in the Menu.condimentItems collection.

condimentItemRefs

Type: Array<number>

▸ consumerName

The consumer name translated into multiple languages.

consumerName

Type: TranslatedString?

▸ consumerDescription

The consumer description translated into multiple languages.

consumerDescription

Type: TranslatedString?

▸ images

A collection of information about images for this item.

images

Type: Array<ImageLink>?

▸ new DefaultCondiment()

Represents a default condiment for a menu item.

new DefaultCondiment()

Instance Members

▸ condimentRef

A reference to the condiment that is a default. This is condimentId of an item from the menu.condimentItems collection.

condimentRef

Type: number

▸ quantity

The quantity of condiment applied by default.

quantity

Type: number

▸ new ScreenLookup()

Information about a Screen Lookup (SLU)

new ScreenLookup()

Instance Members

▸ sluNumber

Represents the SLU property name of the POS menu item definition. SLU2 is sluNumber = 2, SLU8 is sluNumber = 8 etc. SLU is sluNumber = 1.

sluNumber

Type: number

▸ sluId

The identifier (SluIndex) of the SLU.

sluId

Type: number

▸ name

The SLU name translated into multiple languages.

name

Type: TranslatedString?

▸ images

Information about images for this SLU.

images

Type: Array<ImageLink>?

▸ new MenuItemPrice()

Represents a price for a menu item.

new MenuItemPrice()

Instance Members

▸ priceSequence

The price sequence

priceSequence

Type: number

▸ price

The price that can be used when a adding the menu item to a check.

price

Type: number

▸ name

Describes some facet of the price; an example might be a size.

name

Type: string?

▸ new DiscountCollection()

A collection of discount information for a revenue center

new DiscountCollection()

Instance Members

▸ orgShortName

Organization identifier

orgShortName

Type: string

Example

"mymeal"

▸ locRef

Location identifier

locRef

Type: string

Example

"store"

▸ rvcRef

Revenue Center identifier

rvcRef

Type: number

Example

▸ items

A collection of discount items

items

Type: Array<DiscountItems>?

▸ new DiscountItems()

Definition of a discount that can be applied to a transaction.

new DiscountItems()

Instance Members

▸ discountId

Discount identifier

discountId

Type: number

Example

▸ name

A string that contains translations into multiple languages

name

Type: TranslatedString?

▸ type

Discount type. Is either "amount" or "percentage".

type

Type: string

Example

"amount"

▸ value

The amount or percentage of the discount. If value is not present or is zero, then the value must be provided when the discount is added to a check.

value

Type: number?

Example

▸ consumerName

The consumer name translated into multiple languages

consumerName

Type: TranslatedString?

▸ consumerDescription

The consumer description translated into multiple languages

consumerDescription

Type: TranslatedString?

▸ images

A collection of information about images for this item

images

Type: Array<ImageLink>?

▸ extensions

Container for extension data

extensions

Type: Object?

▸ new TenderCollection()

Definition of a tender that can be applied to a transaction.

new TenderCollection()

Instance Members

▸ orgShortName

Organization identifier

orgShortName

Type: string

Example

"mymeal"

▸ locRef

Location identifier

locRef

Type: string

Example

"store66"

▸ rvcRef

Revenue Center identifier

rvcRef

Type: number

Example

▸ items

The tender items for this revenue center

items

Type: Array<TenderItems>?

▸ new TenderItems()

Definition of a tender that can be applied to a transaction.

A tender can be either a 'service total' or a 'payment'. A 'service total' is used to submit an order without payment.

new TenderItems()

Example

{foo: bar}

Instance Members

▸ tenderId

Tender Identifier

tenderId

Type: number

▸ name

Tender Name

name

Type: string

▸ type

Tender Type

type

Type: ("serviceTotal" | "payment")

Example

"serviceTotal"

▸ consumerName

The consumer name translated into multiple languages

consumerName

Type: TranslatedString?

▸ consumerDescription

The consumer description translated into multiple languages

consumerDescription

Type: TranslatedString?

▸ images

A collection of information about images for this item

images

Type: Array<ImageLink>?

▸ extensions

Container for extension data

extensions

Type: Object

▸ new ServiceChargeCollection()

A collection of service charges for a revenue center

new ServiceChargeCollection()

Instance Members

▸ orgShortName

Organization identifier

orgShortName

Type: string

Example

"mymeal"

▸ locRef

Location identifier

locRef

Type: string

Example

"store66"

▸ rvcRef

Revenue Center identifier

rvcRef

Type: number

Example

▸ items

The service charges for this revenue center

items

Type: Array<ServiceChargeItems>?

▸ new ServiceChargeItems()

Definition of a service charge that can be applied to a transaction.

new ServiceChargeItems()

Instance Members

▸ serviceChargeId

Service Charge Identifier

serviceChargeId

Type: number

▸ name

Service Charge name

name

Type: string?

▸ type

Service Charge Type

type

Type: ("amount" | "percentage")

Example

"amount"

▸ value

The amount or percentage of the service charge. If value is not present or is zero, then the value must be provided when the service charge is added to a check.

value

Type: number?

Example

▸ consumerName

The consumer name translated into multiple languages

consumerName

Type: TranslatedString?

▸ consumerDescription

The consumer description translated into multiple languages

consumerDescription

Type: TranslatedString?

▸ images

A collection of information about images for this item

images

Type: Array<ImageLink>?

▸ extensions

Container for extension data

extensions

Type: Object

▸ new BarcodeCollection()

A collection of barcode items for a revenue center.

new BarcodeCollection()

Instance Members

▸ orgShortName

Organization identifier.

orgShortName

Type: string

Example

"mymeal"

▸ locRef

Location identifier.

locRef

Type: string

Example

"store66"

▸ rvcRef

Revenue Center identifier.

rvcRef

Type: number

Example

▸ items

The barcodes for this revenue center.

items

Type: Array<BarcodeItem>?

▸ new BarcodeItem()

A barcode and associated information.

new BarcodeItem()

Instance Members

▸ barcodeId

Identifier for the barcode item.

barcodeId

Type: number

▸ barcode

The value of the barcode.

barcode

Type: string

Example

"000123456890"

▸ menuItemId

The menu item identifier for the barcode.

menuItemId

Type: number

Example

▸ definitionSequence

The menu item definition identifier for the barcode.

definitionSequence

Type: number?

▸ price

The alternate price for the barcode.

price

Type: number?

▸ priceSequence

The price sequence for the barcode.

priceSequence

Type: number?

▸ preparationCost

The alternate preparation cost for the barcode.

preparationCost

Type: number?

▸ new RevenueCenter()

Revenue Center Revenue Center (Rvc) is the organizational unit that produces and sells items. A Revenue Center has a Property.

new RevenueCenter()

Example

{
"orgShortName": "HWFC",
"locRef": "HWFCrobbie",
"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"
},
"isDefault": true,
"serviceLevelTime": 10
},
{
"orderChannelId": 2,
"name": {
"en-US": "Mobile Ordering"
},
"isDefault": false,
"serviceLevelTime": 4
}
],
"tables": [
"1",
"2",
"3",
"B1",
"B2"
],
"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
}
}

Instance Members

▸ orgShortName

Organization identifier.

orgShortName

Type: string

▸ locRef

Location identifier.

locRef

Type: string

▸ rvcRef

Revenue Center Identifier.

rvcRef

Type: number

Example

▸ name

Revenue Center Name.

name

Type: string

Example

"Bar"

▸ orderTypes

Array of order types that are available at this revenue center.

orderTypes

Type: Array<OrderType>?

Example

[{"orderTypeRef":1,"name":"Eat In"},{"orderTypeRef":2,"name":"Take Out","serviceLevelTime":30,"suggestedTips":[{"isDefault":true,"percentage":"10\""}]}]

▸ orderChannels

Array of order channels that are available at this revenue center.

orderChannels

Type: Array<OrderChannel>?

Example

[{"orderChannelId":1,"name": {"en-US": "Default"} , "isDefault": true}, {"orderChannelId":2,"name": {"en-US": "Mobile Ordering"} , "isDefault": false}]}]

▸ tables

Array of restaurant table identifiers.

tables

Type: Array<string>?

Example

["1","2","3","B1","B2"]

▸ consumerName

consumer facing name.

consumerName

Type: string?

▸ address

Represents a postal address.

address

Type: PostalAddress?

▸ geoLocation

Coordinate of a location.

geoLocation

Type: GeoLocation?

▸ extensions

Container for extension data.

extensions

Type: Object?

▸ phoneNumber

Associated phone number.

phoneNumber

Type: string?

▸ new 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.

new OrderType()

Example

{"orderTypeRef":1,"name":"Eat In"}

Instance Members

▸ orderTypeRef

Order Type Identifier.

orderTypeRef

Type: number?

▸ name

The name of the order type.

name

Type: string?

▸ serviceLevelTime

The required time for the given order type to be prepared.

serviceLevelTime

Type: number?

▸ suggestedTips

An array of suggested tip values.

suggestedTips

Type: Array<SuggestedTip>?

▸ new OrderChannel()

Defines an order channel.

new OrderChannel()

Example

{"orderChannelId":2,"name": {"en-US": "Mobile Ordering"} , "isDefault": false}

Instance Members

▸ orderChannelId

Order Channel Identifier.

orderChannelId

Type: number?

▸ name

The name of the order channel.

name

Type: string?

▸ serviceLevelTime

The required time for the given order type to be prepared.

serviceLevelTime

Type: number?

▸ isDefault

Is default channel.

isDefault

Type: boolean?

▸ new 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.

new SuggestedTip()

Example

{"isDefault":true,"percentage":10}

Instance Members

▸ isDefault

A boolean flag indicating if it is the default one when part of a list.

isDefault

Type: boolean?

▸ percentage

The value of the suggested tip in percents.

percentage

Type: number?

▸ new PostalAddress()

Represents a postal address.

new PostalAddress()

Instance Members

▸ addressLine1

First line of an address.

addressLine1

Type: string?

▸ addressLine2

Second line of an address.

addressLine2

Type: string?

▸ addressLine3

Third line of an address.

addressLine3

Type: string?

▸ floor

The floor in a building.

floor

Type: string?

▸ locality

city/town/village.

locality

Type: string?

▸ postalcode

state/county/province.

postalcode

Type: string?

▸ country

name of country, or country code.

country

Type: string?

▸ notes

Additional address details.

notes

Type: string?

▸ new GeoLocation()

Coordinate of a location.

Both latitude and longitude must contain valid values.

new GeoLocation()

Instance Members

▸ latitude

WGS84 latitude, in degrees (min value -90, max value 90)

latitude

Type: number?

▸ longitude

WGS84 Longitude, in degrees (min value -180, max value 180)

longitude

Type: number?

▸ new Organization()

Organization An organization is the business entity that manages food service operations.

new Organization()

Example

{"orgShortName":"HWFC","name":"Hermit Woods Food Co."}

Instance Members

▸ orgShortName

Organization identifier.

orgShortName

Type: string

Example

"HWFC"

▸ name

The organization name.

name

Type: string

Example

"Hermit Woods Food Co."

▸ new Location()

Location A location represents a physical place managed by an organization.

new Location()

Example

{"orgShortName":"HWFC","locRef":"HWFCrobbie","name":"Robbie Mills Stadium","currency":"USD","languages":["en-GB","fr-FR","de-DE"],"timezone":{"ianaName":"Europe/London","windowsName":"GMT Standard Time","tzIndex":85},"address":{"addressLine1":"144 W 54th St","addressLine2":"Suite 11B","floor":"42A","locality":"New York","region":"NY","postalCode":"10019","country":"USA","notes":"West Entrance"},"phoneNumber":"(0030) 0453 343 234","geoLocation":{"latitude":40.763188,"longitude":-73.914835},"posPlatform":{"name":"Oracle.Simphony","version":"19.2.0.1234"}}

Instance Members

▸ orgShortName

Organization identifier.

orgShortName

Type: string

▸ locRef

Location identifier.

locRef

Type: string

Example

"HWFCrobbie"

▸ name

Location name.

name

Type: string

Example

"Robbie Mills Stadium"

▸ currency

The currency of the location. Pricing displayed on menus from the location are in this currency, and all check operations are in this currency. Currency is presented in.

currency

Type: string?

Example

"EUR"

▸ languages

Array of language culture reference strings configured for the location. First language listed is the default used if a request is made for an undefined language.

languages

Type: Array<string>?

Example

["en-GB","fr-FR","de-DE"]

▸ timezone

Represents the associated timezone.

timezone

Type: Timezone?

▸ phoneNumber

Associated phone number.

phoneNumber

Type: PhoneNumber?

▸ address

Represents a postal address.

address

Type: PostalAddress?

▸ geoLocation

Coordinate of a location.

geoLocation

Type: GeoLocation?

▸ posPlatform

Identifies the POS Platform running at the location.

posPlatform

Type: PosPlatform?

▸ extensions

Container for extension data.

extensions

Type: Object

▸ notes

additional details.

notes

Type: string?

▸ consumerName

consumer facing name.

consumerName

Type: string?

▸ new MenuItemAvailability()

A collection of currently unavailable menu items.

new MenuItemAvailability()

Instance Members

▸ orgShortName

Organization identifier.

orgShortName

Type: string

Example

"mymeal"

▸ locRef

Location identifier.

locRef

Type: string

Example

"store66"

▸ rvcRef

Revenue Center identifier.

rvcRef

Type: number

Example

▸ items

Information about unavailable menu items.

items

Type: Array<MenuItemAvailabilityData>?

▸ new MenuItemAvailabilityData()

Availability data for a menu item.

new MenuItemAvailabilityData()

Instance Members

▸ menuItemId

The unavailable menu item object identifier.

menuItemId

Type: number

▸ definitions

The unavailable definition sequences of the menu item.

definitions

Type: Array<MenuItemAvailabilityDefinitionSequence>?

▸ new MenuItemAvailabilityDefinitionSequence()

A definition sequence

new MenuItemAvailabilityDefinitionSequence()

Instance Members

▸ definitionSequence

The definition sequence

definitionSequence

Type: number

▸ new Timezone()

Represents the associated timezone.

new Timezone()

Example

{ianaName: "Asia/Kathmandu", windowsName: "Nepal Standard Time", tzIndex: 193 }

Instance Members

▸ ianaName

Name in linux OS system.

ianaName

Type: string?

Example

'Asia/Kathmandu'

▸ windowsName

Name in windows OS system.

windowsName

Type: string?

Example

'Nepal Standard Time'

▸ tzIndex

The integer representation of the Index column from https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values

tzIndex

Type: number

Example

▸ new PosPlatform()

Identifies the POS Platform running at the location.

new PosPlatform()

Instance Members

▸ name

Name of the platform.

name

Type: string

▸ version

Version of the platform.

version

Type: string

▸ new TaxDefinitions()

Tax definitions for a revenue Center

new TaxDefinitions()

Instance Members

▸ orgShortName

Organization identifier

orgShortName

Type: string

Example

"mymeal"

▸ locRef

Location identifier

locRef

Type: string

Example

"store66"

▸ rvcRef

Revenue Center identifier

rvcRef

Type: number

Example

▸ taxClasses

A collection of tax classes

taxClasses

Type: Array<TaxClassItem>

▸ taxRates

A collection of tax rates

taxRates

Type: Array<TaxRateItem>

▸ new TaxClassItem()

Tax class defines a collection of active tax rates.

new TaxClassItem()

Instance Members

▸ taxClassId

Tax class identifier.

taxClassId

Type: number

▸ activeTaxRateRefs

Set of references to active tax rate items for this tax class.

activeTaxRateRefs

Type: Array<number>?

▸ new TaxRateItem()

Definition of a tax rate.

new TaxRateItem()

Instance Members

▸ taxRateId

Tax rate identifier. This is the Simphony tax rate index.

taxRateId

Type: number

▸ percentage

Tax rate percentage.

percentage

Type: number?

▸ taxType

The tax rate type. Valid values are

disabled
addonBreakpoint
addonPercent
includedPercent
surcharge

taxType

Type: ("disabled" | "addonBreakpoint" | "addonPercent" | "includedPercent" | "surcharge")?

Example

"addonBreakpoint"

▸ name

Tax rate names translated into multiple languages

name

Type: TranslatedString?

▸ repeatStartIndex

Breakpoint start index

repeatStartIndex

Type: number?

▸ repeatEndIndex

Breakpoint end index

repeatEndIndex

Type: number?

▸ startAmount

The breakpoint start amount

startAmount

Type: number?

▸ breakpoints

Breakpoint table

breakpoints

Type: Array<number>?

▸ new TranslatedString()

new TranslatedString()

Example

{"en-US":"Coffee","de-DE":"Kaffee","ar-AR":"قهوة"}

▸ new ImageLink()

Represents a link to an image

new ImageLink()

Instance Members

▸ index

Index for the image

index

Type: string?

▸ url

URL for the image.

url

Type: string

Example

"https://oracleObjectStore.com/images/coffee822815.jpg"

▸ altText

Alt text for the image

altText

Type: string?

Example

"pizza"

▸ description

Description text for the image

description

Type: string?

▸ isCloudImage

Indicates if the image is stored in Oracle Cloud

isCloudImage

Type: boolean?

▸ size

Image size

size

Type: string?

▸ new MenuV2()

A menu describes the set of items that can be ordered from a revenue center. The menu includes the menu items, prices, combo groups and related information necessary to order an item.

new MenuV2()

Instance Members

▸ orgShortName

Organization identifier

orgShortName

Type: string

Example

"mymeal"

▸ locRef

Location identifier

locRef

Type: string

Example

"store66"

▸ rvcRef

Revenue Center identifier

rvcRef

Type: number

Example

▸ menuId

Menu Identifier

menuId

Type: string

Example

"myb:store2:dining"

▸ name

Menu name

name

Type: string

Example

"Bar Menu"

▸ description

A description of the menu

description

Type: string?

▸ menuItems

The menu's menu items

menuItems

Type: Array<MenuItems>

▸ comboGroupsV2

The menu's combo groups

comboGroupsV2

Type: Array<ComboGroupsV2>?

▸ comboMealsV2

The menu's combo meals

comboMealsV2

Type: Array<ComboMealItemV2>?

▸ condimentItems

The menu's condiments

condimentItems

Type: Array<CondimentItems>?

▸ condimentGroups

The menu's condiment groups

condimentGroups

Type: Array<CondimentGroupV2>?

▸ familyGroups

The menu's family groups

familyGroups

Type: Array<FamilyGroupItem>?

▸ allergens

The menu's allergens

allergens

Type: Array<Allergen>?

▸ new ComboGroupsV2()

A Combo Group that may be reference as part of a Combo Meal.

new ComboGroupsV2()

Instance Members

▸ name

The name of the combo group translated into multiple languages

name

Type: TranslatedString

▸ comboGroupId

Combo Group Identifier

comboGroupId

Type: number

▸ items

A menu item which is part of a combo meal.

items

Type: Array<ComboGroupItemV2>

▸ new ComboGroupItemV2()

A menu item which is part of a combo meal.

new ComboGroupItemV2()

Instance Members

▸ count

The number of the menu item to add to the combo meal

count

Type: number

▸ menuItemRef

A reference to an item in the Menu.menuItems collection. This is the item ordered by default and if no sizing is available.

menuItemRef

Type: number

▸ prices

Combo group item price

prices

Type: Array<ComboGroupItemPriceV2>

▸ sizes

Identifies the item reference to use for each size, if combo meal is "sizable"

sizes

Type: Array<ComboGroupItemSizeV2>

▸ new ComboGroupItemPriceV2()

Combo group item price

new ComboGroupItemPriceV2()

Instance Members

▸ price

The price that can be used when a adding the combo group item to a check.

price

Type: number

▸ priceId

The identifier associated with the price.

priceId

Type: number

▸ new ComboGroupItemSizeV2()

Identifies the item reference to use for each size, if combo meal is "sizable"

new ComboGroupItemSizeV2()

Instance Members

▸ menuItemRef

Reference to menuItemId of item that is ordered for this size.

menuItemRef

Type: number

▸ sizeId

Size identifier

sizeId

Type: string

Example

"size1"

▸ new ComboMealItemV2()

A Combo Meal that can be ordered.

new ComboMealItemV2()

Instance Members

▸ name

The name of the combo meal translated into multiple languages

name

Type: TranslatedString

▸ comboMealId

The combo meal identifier

comboMealId

Type: number

▸ menuItemRef

A reference to the item in Menu.menuItems that represents the main item used when ordering a combo meal.

menuItemRef

Type: number

▸ options

Options related to the definition of this item. Indicates that 1 or more sizes can be applied to this combo meal.

options

Type: string

Example

"isSized"

▸ mealGroups

An array of combo groups.

mealGroups

Type: Array<ComboGroupMapV2>

▸ new ComboGroupMapV2()

Defines how a combo meal group is included in a combo meal

new ComboGroupMapV2()

Instance Members

▸ comboGroupRef

A Reference to menu.comboGroups[].comboGroupId

comboGroupRef

Type: number

▸ isPrimary

Defines if the combo group is the primary group

isPrimary

Type: boolean

▸ prices

An array of combo groups.

prices

Type: Array<ComboGroupItemPriceV2>

▸ sideCount

Side count

sideCount

Type: number

▸ new CondimentGroupV2()

A group that references one-or-more condiment items.

new CondimentGroupV2()

Instance Members

▸ condimentGroupId

Condiment Group Identifier.

condimentGroupId

Type: number

▸ name

The name of the condiment group translated into multiple languages

name

Type: TranslatedString

▸ condimentItemRefs

An array of condiment groups.

condimentItemRefs

Type: Array<CondimentGroupItemRefV2>

▸ ConsumerContentProperties

A collection of consumer based content

ConsumerContentProperties

Type: Array<ConsumerContentProperties>

▸ new CondimentGroupItemRefV2()

An array of references to items in the Menu.condimentItems collection.

new CondimentGroupItemRefV2()

Instance Members

▸ condimentItemRef

The condiment item's condimentId

condimentItemRef

Type: number

▸ definitionSequence

The condiment item definition's number

definitionSequence

Type: number

Examples

{
     "orgShortName": "mymeal",
     "locRef": "store66",
     "rvcRef": 2,
     "menuId": "myb:store2:dining",
     "name": "Bar Menu",
     "description": "string",
     "menuItems": [
         {
             "name": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             },
             "menuItemId": 32,
             "familyGroupRef": 0,
             "definitions": [
                 {
                     "definitionSequence": 0,
                     "name": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "name2": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "slus": [
                         {
                             "sluNumber": 0,
                             "sluId": 0,
                             "name": {
                                 "en-US": "Coffee",
                                 "de-DE": "Kaffee",
                                 "ar-AR": "قهوة"
                             },
                             "images": [
                                 {
                                     "index": "string",
                                     "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                                     "altText": "pizza",
                                     "description": "string",
                                     "isCloudImage": true,
                                     "size": "string"
                                 }
                             ]
                         }
                     ],
                     "taxClassRef": 0,
                     "prices": [
                         {
                             "priceSequence": 0,
                             "price": 0,
                             "name": "string"
                         }
                     ],
                     "defaultCondiments": [
                         {
                             "condimentRef": 0,
                             "quantity": 1
                         }
                     ],
                     "condimentGroupRules": [
                         {
                             "condimentGroupRef": 5802109,
                             "minimumCount": 1,
                             "maximumCount": 0
                         }
                     ],
                     "consumerName": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "consumerDescription": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "images": [
                         {
                             "index": "string",
                             "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                             "altText": "pizza",
                             "description": "string",
                             "isCloudImage": true,
                             "size": "string"
                         }
                     ],
                     "consumerAdvisoryText": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "allergens": [
                         "milk",
                         "peanut"
                     ],
                     "nutritionalData": [
                         {
                             "nutritionalItemId": "fat, sodium",
                             "value": 475,
                             "unitOfMeasure": "grams, milligrams, calorie",
                             "name": {
                                 "en-US": "Coffee",
                                 "de-DE": "Kaffee",
                                 "ar-AR": "قهوة"
                             }
                         }
                     ],
                     "options": [
                         "containsAlcohol"
                     ],
                     "tags": [
                         "hot",
                         "cold"
                     ],
                     "tagGroups": [
                         {
                             "id": "string",
                             "tags": [
                                 "spicy",
                                 "lo-carb"
                             ]
                         }
                     ],
                     "extensions": {
                         "additionalProp1": "string",
                         "additionalProp2": "string",
                         "additionalProp3": "string"
                     }
                 }
             ],
             "dietaryInformation": [
                 "string"
             ],
             "tags": [
                 "string"
             ],
             "tagGroups": [
                 {
                     "id": "string",
                     "tags": [
                         "spicy",
                         "lo-carb"
                     ]
                 }
             ]
         }
     ],
     "comboMeals": [
         {
             "comboMealId": 0,
             "name": "string",
             "menuItemRef": 0,
             "comboGroups": [
                 {
                     "comboGroupId": 0,
                     "name": "string",
                     "count": 0,
                     "isMainGroup": true,
                     "prices": [
                         {
                             "priceSequence": 0,
                             "price": 0,
                             "name": "string"
                         }
                     ],
                     "menuItems": [
                         {
                             "menuItemRef": 0,
                             "count": 0,
                             "prices": [
                                 {
                                     "priceSequence": 0,
                                     "price": 0,
                                     "name": "string"
                                 }
                             ]
                         }
                     ]
                 }
             ]
         }
     ],
     "condimentItems": [
         {
             "name": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             },
             "condimentId": 32,
             "familyGroupRef": 0,
             "definitions": [
                 {
                     "number": 0,
                     "name": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "name2": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "slus": [
                         {
                             "sluNumber": 0,
                             "sluId": 0,
                             "name": {
                                 "en-US": "Coffee",
                                 "de-DE": "Kaffee",
                                 "ar-AR": "قهوة"
                             },
                             "images": [
                                 {
                                     "index": "string",
                                     "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                                     "altText": "pizza",
                                     "description": "string",
                                     "isCloudImage": true,
                                     "size": "string"
                                 }
                             ]
                         }
                     ],
                     "prices": [
                         {
                             "priceSequence": 0,
                             "price": 0,
                             "name": "string"
                         }
                     ],
                     "consumerName": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "consumerDescription": {
                         "en-US": "Coffee",
                         "de-DE": "Kaffee",
                         "ar-AR": "قهوة"
                     },
                     "images": [
                         {
                             "index": "string",
                             "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                             "altText": "pizza",
                             "description": "string",
                             "isCloudImage": true,
                             "size": "string"
                         }
                     ],
                     "allergens": [
                         "milk",
                         "peanut"
                     ],
                     "nutritionalData": [
                         {
                             "nutritionalItemId": "fat, sodium",
                             "value": 475,
                             "unitOfMeasure": "grams, milligrams, calorie",
                             "name": {
                                 "en-US": "Coffee",
                                 "de-DE": "Kaffee",
                                 "ar-AR": "قهوة"
                             }
                         }
                     ],
                     "options": [
                         "containsAlcohol"
                     ],
                     "tags": [
                         "hot",
                         "cold"
                     ],
                     "tagGroups": [
                         {
                             "id": "string",
                             "tags": [
                                 "spicy",
                                 "lo-carb"
                             ]
                         }
                     ],
                     "extensions": {
                         "additionalProp1": "string",
                         "additionalProp2": "string",
                         "additionalProp3": "string"
                     }
                 }
             ],
             "dietaryInformation": [
                 "string"
             ],
             "tags": [
                 "string"
             ],
             "tagGroups": [
                 {
                     "id": "string",
                     "tags": [
                         "spicy",
                         "lo-carb"
                     ]
                 }
             ]
         }
     ],
     "condimentGroups": [
         {
             "condimentGroupId": 32,
             "name": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             },
             "condimentItemRefs": [
                 0
             ],
             "consumerName": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             },
             "consumerDescription": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             },
             "images": [
                 {
                     "index": "string",
                     "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                     "altText": "pizza",
                     "description": "string",
                     "isCloudImage": true,
                     "size": "string"
                 }
             ]
         }
     ],
     "familyGroups": [
         {
             "familyGroupItemId": 0,
             "name": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             },
             "consumerName": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             },
             "consumerDescription": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             },
             "images": [
                 {
                     "index": "string",
                     "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                     "altText": "pizza",
                     "description": "string",
                     "isCloudImage": true,
                     "size": "string"
                 }
             ]
         }
     ],
     "allergens": [
         {
             "allergenId": "string",
             "name": {
                 "en-US": "Coffee",
                 "de-DE": "Kaffee",
                 "ar-AR": "قهوة"
             }
         }
     ]
}

Discount Collection

{
    "orgShortName": "mymeal",
    "locRef": "store66",
    "rvcRef": 2,
    "items": [
        {
            "discountId": 13,
            "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
            },
            "type": "amount",
            "value": 5,
            "consumerName": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
            },
            "consumerDescription": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
            },
            "extensions": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
            }
        }
    ]
}

Service Charge Collection

{
    "orgShortName": "mymeal",
    "locRef": "store66",
    "rvcRef": 2,
    "items": [
        {
            "serviceChargeId": 0,
            "name": "string",
            "type": "amount",
            "value": 5,
            "consumerName": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
            },
            "consumerDescription": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
            },
            "extensions": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
            }
        }
    ]
}

Tax Definitions

{
    "orgShortName": "mymeal",
    "locRef": "store66",
    "rvcRef": 2,
    "taxClasses": [
        {
            "taxClassId": 0,
            "activeTaxRateRefs": [
                0
            ]
        }
    ],
    "taxRates": [
        {
            "taxRateId": 0,
            "percentage": 0,
            "taxType": "addonBreakpoint",
            "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
            },
            "repeatStartIndex": 0,
            "repeatEndIndex": 0,
            "startAmount": 0,
            "breakpoints": [
                0
            ]
        }
    ]
}

Tender Collection

{
    "orgShortName": "mymeal",
    "locRef": "store66",
    "rvcRef": 2,
    "items": [
        {
            "tenderId": 0,
            "name": "string",
            "type": "serviceTotal",
            "consumerName": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
            },
            "consumerDescription": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
            },
            "extensions": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
            }
        }
    ]
}

Barcode Collection

{
    "orgShortName": "mymeal",
    "locRef": "store66",
    "rvcRef": 2,
    "items": [
        {
            "barcodeId": 1,
            "barcode": "00003000002",
            "menuItemId": 32.
            "definitionSequence": 1,
            "price": 14.99
        }
    ]
}

MenuItem Availability

{
    "orgShortName": "mymeal",
    "locRef": "store66",
    "rvcRef": 2,
    "items": [
        {
            "menuItemId": 32,
            "definitions": [
                {
                    "definitionSequence": 1
                }
            ]
        }
    ]
}

Location

{
    "orgShortName": "tfoinc",
    "locRef": "fdmnh144",
    "name": "The Food Organization Inc",
    "currency": "USD",
    "languages": [
        "en-GB",
        "fr-FR",
        "de-DE"
    ],
    "timezone": {
        "ianaName": "America/New_York",
        "windowsName": "Eastern Standard Time",
        "tzIndex": 23
    },
    "address": {
        "addressLine1": "144 W 54th St",
        "addressLine2": "Suite 11B",
        "floor": "42A",
        "locality": "New York",
        "region": "NY",
        "postalCode": "10019",
        "country": "USA",
        "notes": "West Entrance"
    },
    "phoneNumber": "(0030) 0453 343 234",
    "geoLocation": {
        "latitude": 40.763188,
        "longitude": -73.914835
    },
    "posPlatform": {
        "name": "Oracle.Simphony",
        "version": "19.2.0.1234"
    }
}

Revenue Center

{
    "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
                }
            ]
        }
    ],
    "tables": [
        "1",
        "2",
        "3",
        "B1",
        "B2"
    ],
    "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
    }
}

GeoLocation

"geoLocation": {
    "latitude": 40.763188,
    "longitude": -73.914835
}

Order Type

"orderTypes": [
    {
        "orderTypeRef": 1,
        "name": "Eat In"
    },
    {
        "orderTypeRef": 2,
        "name": "Take Out"
    }
]

Suggested Tip

"suggestedTips": [
    {
        "isDefault": false,
        "percentage": 10
    },
    {
        "isDefault": true,
        "percentage": 20
    },
    {
        "isDefault": false,
        "percentage": 25
    }
]

Pos Platform

"posPlatform": {
    "name": "Oracle.Simphony",
    "version": "19.2.0.1234"
}

Postal Address

"address": {
    "addressLine1": "144 W 54th St",
    "addressLine2": "Suite 11B",
    "floor": "42A",
    "locality": "New York",
    "region": "NY",
    "postalCode": "10019",
    "country": "USA",
    "notes": "West Entrance"
}

Timezone

"timezone": {
  "ianaName": "America/New_York",
  "windowsName": "Eastern Standard Time",
  "tzIndex": 23
}

MenuV2

{
  "menuItems": [
    {
      "menuItemId": 32,
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "familyGroupRef": 0,
      "definitions": [
        {
          "definitionSequence": 0,
          "name": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "name2": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "slus": [
            {
              "sluNumber": 0,
              "sluId": 0,
              "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
              },
              "images": [
                {
                  "index": "string",
                  "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                  "altText": "Close-up of a cup of coffee with a saucer, showing a dark brown liquid with a frothy top.",
                  "description": "string",
                  "isCloudImage": true,
                  "size": "string"
                }
              ]
            }
          ],
          "taxClassRef": 0,
          "prices": [
            {
              "priceSequence": 0,
              "price": 0,
              "name": "string"
            }
          ],
          "defaultCondiments": [
            {
              "condimentRef": 0,
              "quantity": 1
            }
          ],
          "condimentGroupRules": [
            {
              "condimentGroupRef": 5802109,
              "minimumCount": 1,
              "maximumCount": 0
            }
          ],
          "consumerName": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "consumerDescription": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "images": [
            {
              "index": "string",
              "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
              "altText": "Close-up of a cup of coffee with a saucer, showing a dark brown liquid with a frothy top.",
              "description": "string",
              "isCloudImage": true,
              "size": "string"
            }
          ],
          "consumerAdvisoryText": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "allergens": [
            "milk",
            "peanut"
          ],
          "nutritionalData": [
            {
              "nutritionalItemId": "fat, sodium",
              "value": 475,
              "unitOfMeasure": "grams, milligrams, calorie",
              "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
              }
            }
          ],
          "options": [
            "allowCondimentPrefix",
            "containsAlcohol"
          ],
          "tags": [
            "hot",
            "cold"
          ],
          "tagGroups": [
            {
              "id": "string",
              "tags": [
                "spicy",
                "lo-carb"
              ]
            }
          ],
          "extensions": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ],
      "dietaryInformation": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "tagGroups": [
        {
          "id": "string",
          "tags": [
            "spicy",
            "lo-carb"
          ]
        }
      ]
    }
  ],
  "comboMeals": [
    {
      "comboMealId": 0,
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "options": "isSized",
      "menuItemRef": 0,
      "mealGroups": [
        {
          "comboGroupRef": 0,
          "isPrimary": true,
          "sideCount": 0,
          "prices": [
            {
              "priceId": 0,
              "price": 0
            }
          ]
        }
      ]
    }
  ],
  "comboGroups": [
    {
      "comboGroupId": 0,
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "items": {
        "menuItemRef": 0,
        "count": 0,
        "sizes": [
          {
            "sizeId": "size1",
            "menuItemRef": 0
          },
          {
            "sizeId": "size2",
            "menuItemRef": 0
          },
          {
            "sizeId": "size3",
            "menuItemRef": 0
          },
          {
            "sizeId": "size4",
            "menuItemRef": 0
          }
        ],
        "prices": [
          {
            "priceId": 0,
            "price": 0
          }
        ]
      },
      "alternateGroups": [
        {
          "comboGroupRef": 0
        }
      ]
    }
  ],
  "condimentItems": [
    {
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "condimentId": 32,
      "familyGroupRef": 0,
      "definitions": [
        {
          "number": 0,
          "name": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "name2": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "slus": [
            {
              "sluNumber": 0,
              "sluId": 0,
              "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
              },
              "images": [
                {
                  "index": "string",
                  "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
                  "altText": "Close-up of a cup of coffee with a saucer, showing a dark brown liquid with a frothy top.",
                  "description": "string",
                  "isCloudImage": true,
                  "size": "string"
                }
              ]
            }
          ],
          "prices": [
            {
              "priceSequence": 0,
              "price": 0,
              "name": "string"
            }
          ],
          "consumerName": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "consumerDescription": {
            "en-US": "Coffee",
            "de-DE": "Kaffee",
            "ar-AR": "قهوة"
          },
          "images": [
            {
              "index": "string",
              "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
              "altText": "Close-up of a cup of coffee with a saucer, showing a dark brown liquid with a frothy top.",
              "description": "string",
              "isCloudImage": true,
              "size": "string"
            }
          ],
          "allergens": [
            "milk",
            "peanut"
          ],
          "nutritionalData": [
            {
              "nutritionalItemId": "fat, sodium",
              "value": 475,
              "unitOfMeasure": "grams, milligrams, calorie",
              "name": {
                "en-US": "Coffee",
                "de-DE": "Kaffee",
                "ar-AR": "قهوة"
              }
            }
          ],
          "options": [
            "allowCondimentPrefix",
            "containsAlcohol"
          ],
          "tags": [
            "hot",
            "cold"
          ],
          "tagGroups": [
            {
              "id": "string",
              "tags": [
                "spicy",
                "lo-carb"
              ]
            }
          ],
          "extensions": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ],
      "dietaryInformation": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "tagGroups": [
        {
          "id": "string",
          "tags": [
            "spicy",
            "lo-carb"
          ]
        }
      ]
    }
  ],
  "condimentGroups": [
    {
      "condimentGroupId": 32,
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "condimentItemRefs": [
        {
          "condimentItemRef": 0,
          "definitionSequence": 0
        }
      ]
    }
  ],
  "familyGroups": [
    {
      "familyGroupItemId": 0,
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "consumerName": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "consumerDescription": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "images": [
        {
          "index": "string",
          "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
          "altText": "Close-up of a cup of coffee with a saucer, showing a dark brown liquid with a frothy top.",
          "description": "string",
          "isCloudImage": true,
          "size": "string"
        }
      ]
    }
  ],
  "allergens": [
    {
      "allergenId": "string",
      "name": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      }
    }
  ],
  "options": {
    "condimentPrefixes": [
      {
        "prefixId": integer,
        "prefixType": "string",
        "name": {
          "en-US": "No"
        }
      },
      {
        "prefixId": integer,
        "prefixType": "string",
        "name": {
          "en-US": "Add"
        }
      },
      {
        "prefixId": integer,
        "prefixType": "string",
        "name": {
          "en-US": "Substitute"
        }
      },
      {
        "prefixId": integer,
        "prefixType": "string",
        "name": {
          "en-US": "Desciption",
          "de-DE": "Beschreibung",
          "en-CA": "Desciption",
          "sk-SK": "Popis"
        }
      }
    ]
  },
  "menuId": "mymeal:store66:2",
  "name": "1",
  "orgShortName": "mymeal",
  "locRef": "store66",
  "rvcRef": 2
}