{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a65c8e75-3963-436b-949a-66afd49208b9","name":"Triton API","description":"All requests processed via the Triton API are means of communication to clients that have YCS's software Connect Engine installed. These requests enable developers to build applications and interfaces to connect in real-time with a POS system via internet communication.\r\n\r\nRequests to clients are only available if the Token is known, ConnectEngine is installed and licensed and andInternet connection is available. If you need an offline solution please ask for ConnectEngine API information.\r\n\r\n**Query Parameters:**\r\n>**Token**   : Client unique identifier.\r\n\r\n**Allowed HTTPs requests:**\r\n>**GET**     : To request information\r\n>**POST**    : To submit data\r\n\r\n**Description Of Usual Server Responses:**\r\n>**200 OK** - the request was successful (some API calls may return 201 instead).<br/>\r\n>**201 Created** - the request was successful and a resource was created.<br/>\r\n>**204 No Content** - the request was successful but there is no representation to return (i.e. the response is empty).<br/>\r\n>**400 Bad Request** - the request could not be understood or was missing required parameters.<br/>\r\n>**401 Unauthorized** - authentication failed or user doesn't have permissions for requested operation.<br/>\r\n>**403 Forbidden** - access denied.<br/>\r\n>**404 Not Found** - resource was not found.405 Method Not Allowed - requested method is not supported for resource.<br/>\r\n\r\n# JSON Structure for Errors #\r\n\r\n**Error JSON Example**\r\n```json\r\n{\r\n\t'status': 'ERROR',\r\n\t'result': 'Exception - Exception message will appear here.'\r\n}\r\n```\r\n\r\n# Classes Definitions #\r\nData being requested is defined by classes as follow:\r\n<br/>\r\n\r\n**Tables Class**<br/>\r\n>Used on: \r\n>  - [Tables list](#1c1a1d5c-a849-470b-9dee-15e762bd28f7)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| tableId | `integer` | Aloha table ID |\r\n| tableDef | `integer` | Aloha table ref |\r\n| name | `string` | Table name |\r\n| empId | `integer` | Employee ID |\r\n| isOpen | `boolean` | Returns `TRUE` if the table is open. `FALSE` if not open |\r\n| checks | `checks[]` | An `array` of objects for each of the checks on this table |\r\n\r\n***\r\n\r\n**checks Class**\r\n>Used on: \r\n>  - [REMOTE > Checks > Get Checks](#dd858e27-c5d7-4cf9-9427-859ae7b2de0b)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| checkId | `integer` | Aloha check ID |\r\n| displayCheckId | `integer` | Aloha display check ID |\r\n| openTime | `DateTime` | Date & time when the check was opened |\r\n| isOpen | `boolean` | Returns `TRUE` if the table is open, `FALSE` if not open |\r\n| subTotal | `decimal` | Check subtotal |\r\n| tax | `decimal` | Check total tax |\r\n| total | `decimal` | Check total |\r\n| amountDue | `decimal` | Check amount due |\r\n\r\n***\r\n\r\n**itemEntries Class**\r\n>Used on: \r\n>  - [REMOTE > Data Requests > Get Menu Items](#93efd72a-7d1c-4751-ae69-96ac70369522)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| id | `integer` | Aloha entry ID |\r\n| name | `string` | Aloha entry name |\r\n| price | `decimal` | Aloha entry price |\r\n| modifiers | `int[]` | An `integer array` of modifiers |\r\n| image | `byte[]` | An `bytes array` containing the image |\r\n| count | `int` | The length of the `bytes array` for the image |\r\n\r\n***\r\n\r\n**modEntries Class**\r\n>Used on: \r\n>  - [REMOTE > Data Requests > Get Menu Items](#93efd72a-7d1c-4751-ae69-96ac70369522)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| id | `integer` | Aloha Modifier ID |\r\n| name | `string` | Aloha Modifier name |\r\n| min | `integer` | Minimum amount |\r\n| max | `integer` | Maximum amount |\r\n| free | `integer` | Free Flag |\r\n| isFlowReq | `boolean` | `True` or `False` |\r\n| items | `modItems[]` | An `array` of modifier items. |\r\n\r\n***\r\n\r\n**modItems Class**\r\n>Used on: \r\n>  - **modEntries** class.\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| id | `integer` | Aloha Mod item ID |\r\n| price | `decimal` | Aloha Mod item price |\r\n| image | `byte[]` | An `bytes array` containing the image |\r\n\r\n***\r\n\r\n**tenders Class**\r\n>Used on: \r\n>  - [REMOTE > Data Requests > Get Tenders](#19c0a35d-0412-4e3b-9139-50b9a4c58dc8)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| id | `integer` | Aloha tender ID |\r\n| Name | `string` | Aloha tender name |\r\n| tenderType | `string` | Name for the type of tender |\r\n| isTipAccepted | `boolean` | `TRUE` or `FALSE` |\r\n| maxTips | `integer` | Maximum amount for tips |\r\n| user1 | `string` | Custom Entry #1 |\r\n| user2 | `string` | Custom Entry #2 |\r\n| user3 | `string` | Custom Entry #3 |\r\n| user4 | `string` | Custom Entry #4 |\r\n\r\n***\r\n\r\n**getEntriesCheck Class**\r\n>Used on: \r\n>  - [REMOTE > Checks > Get Entries](#f9e2ebdf-2e3d-475e-bd01-d65b0cb1f9af)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| checkId | `integer` | Aloha check ID |\r\n| entries | `getEntriesCheckItems[]` | An `array` of all the check entries |\r\n\r\n***\r\n\r\n**getEntriesCheckItems Class**\r\n>Used on: \r\n>  - **getEntriesCheck** class.\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| itemId | `integer` | Item ID |\r\n| price | `decimal` | Item Price |\r\n| name | `string` | Name for the type of tender |\r\n| discountedPrice | `decimal?` | `nullable` discounted price |\r\n| displayPrice | `string` | Price displayed |\r\n| quantity | `int?` | `nullable` Quantity |\r\n| mode | `string` | Mode |\r\n| level | `string` | Level |\r\n| data | `string` | Data |\r\n\r\n***\r\n\r\n**payments class**\r\n>Used on: \r\n>  - [REMOTE > Checks > Get Payments](#a1a37c14-b7e3-4f8b-898e-f52072d37480)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| paymentId | `integer` | Aloha payment ID |\r\n| checkId | `integer` | Aloha check ID |\r\n| Name | `string` | Name for the type of payment |\r\n| tenderId | `integer` | Aloha tender ID |\r\n| cardNumber | `string` | Card utilized |\r\n| amount | `decimal` | Payment amount |\r\n| tip | `decimal` | Tip amount |\r\n| auth | `string` | Authorization number |\r\n| expDate | `string` | Expiration date `MMYY` |\r\n| hostIp | `string` | Data |\r\n\r\n***\r\n\r\n**paymentInfo class**\r\n>Used on: \r\n>  - [REMOTE > Payments > Apply Cash Payment](#d17fae68-cbc5-4348-9645-37464f62a874)\r\n>  - [REMOTE > Payments > Apply CC Payment](#20573bbf-46cc-47ae-bd22-44b281ea8863)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| amount | `decimal` | Amount to be paid |\r\n| tenderId | `int` | Tender ID for the transaction |\r\n| tip | `decimal` | Tip amount to be paid |\r\n| cardNumber | `string` | Card utilized |\r\n| expDate | `string` | Card expiration date `MMYY` |\r\n| auth | `integer` | Authorization number|\r\n\r\n***\r\n\r\n**orderEntries class**\r\n>Used on: \r\n>  - [REMOTE > Orders > Submit Order](#9788f1d9-fcbe-4451-b512-21991658b040)\r\n\r\n| Variable | Type | Value |\r\n|:------:|:-----:|:-----:|\r\n| level | `string` | Level |\r\n| price | `decimal` | Item Price |\r\n| itemId | `integer` | Item ID |\r\n\r\n***","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6395545","team":246598,"collectionId":"a65c8e75-3963-436b-949a-66afd49208b9","publishedId":"TVmTbEks","public":true,"publicUrl":"https://docs.triton.ycspr.net","privateUrl":"https://go.postman.co/documentation/6395545-a65c8e75-3963-436b-949a-66afd49208b9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.10.1","publishDate":"2020-12-09T13:43:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"YCS AlohaTS","id":"134784ed-c346-4273-b753-05c7503fc988","owner":"6395545","values":[{"key":"tritontoken","value":"MTMjVHJpdG9uQVBJI2Fzb3JlMSNZQ1NQUkNPUlA=\n","enabled":true},{"key":"typeOfReference","value":"TABLE","enabled":true},{"key":"referenceId","value":"1","enabled":true},{"key":"empid","value":"103","enabled":true},{"key":"orderMode","value":"10","enabled":true},{"key":"tenderId","value":"100","enabled":true},{"key":"ycsstoreid","value":"80","enabled":true},{"key":"storeid","value":"1","enabled":true},{"key":"itemid","value":"13002","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/9ca00957cf3a92b8b218e1c3e3f2c0b3f7feae0f619ca9b2e5117339c6b945dd","favicon":"https://ycspr.net/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"YCS AlohaTS","value":"6395545-134784ed-c346-4273-b753-05c7503fc988"}],"canonicalUrl":"https://docs.triton.ycspr.net/view/metadata/TVmTbEks"}