{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cc1eda9d-ff2a-4401-b4d5-a3450959fb5e","name":"Connect Engine","description":"_Connect Engine_ is an API oriented to the implementation of programs that communicate with the POS Aloha system using 2 approaches:\n\n- Https protocol\n    \n- IO socket for remote Access\n    \n\nA software implements the functions that interact with ALohaPOS, discriminating if requests comes from the cloud, or locally inside a restaurant's network.\n\nIt provides tools so that developers teams can interact with the Aloha POS system, and extend the inherent potentialities of this system, such as: Payment Systems, Kiosks, Mobile Applications and much more.\n\n**Connect Engine API works in 3 modes:**\n\n- Local\n    \n- Remote\n    \n- Cloud (Triton Cloud is a separete API)\n    \n\n**Allowed HTTPs requests:**\n\n> **GET** : To request information  \n**POST** : To submiot data \n  \n\n**Description Of Usual Server Responses:**\n\n> **200 OK** - the request was successful (some API calls may return 201 instead). \n  \n\n**201 Created** - the request was successful and a resource was created.\n\n**204 No Content** - the request was successful but there is no representation to return (i.e. the response is empty).\n\n**400 Bad Request** - the request could not be understood or was missing required parameters.\n\n**401 Unauthorized** - authentication failed or user doesn't have permissions for requested operation.\n\n**403 Forbidden** - access denied.\n\n**404 Not Found** - resource was not found.405 Method Not Allowed - requested method is not supported for resource.\n\n# Classes Definitions\n\n**tables Class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| tableId | `integer` | Aloha table ID |\n| tableDef | `integer` | Aloha table ref |\n| name | `string` | Table name |\n| empId | `integer` | Employee ID |\n| isOpen | `boolean` | Returns `TRUE` if the table is open. `FALSE` if not open |\n| checks | `checks[]` | An `array` of objects for each of the checks on this table |\n\n---\n\n**checks Class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| checkId | `integer` | Aloha check ID |\n| displayCheckId | `integer` | Aloha display check ID |\n| openTime | `DateTime` | Date & time when the check was opened |\n| isOpen | `boolean` | Returns `TRUE` if the table is open, `FALSE` if not open |\n| subTotal | `decimal` | Check subtotal |\n| tax | `decimal` | Check total tax |\n| total | `decimal` | Check total |\n| amountDue | `decimal` | Check amount due |\n\n---\n\n**itemEntries Class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| id | `integer` | Aloha entry ID |\n| name | `string` | Aloha entry name |\n| price | `decimal` | Aloha entry price |\n| modifiers | `int[]` | An `integer array` of modifiers |\n| image | `byte[]` | An `bytes array` containing the image |\n| count | `int` | The length of the `bytes array` for the image |\n\n---\n\n**modEntries Class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| id | `integer` | Aloha Modifier ID |\n| name | `string` | Aloha Modifier name |\n| min | `integer` | Minimum amount |\n| max | `integer` | Maximum amount |\n| free | `integer` | Free Flag |\n| isFlowReq | `boolean` | `True` or `False` |\n| items | `modItems[]` | An `array` of modifier items. |\n\n---\n\n**modItems Class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| id | `integer` | Aloha Mod item ID |\n| price | `decimal` | Aloha Mod item price |\n| image | `byte[]` | An `bytes array` containing the image |\n\n---\n\n**tenders Class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| id | `integer` | Aloha tender ID |\n| Name | `string` | Aloha tender name |\n| tenderType | `string` | Name for the type of tender |\n| isTipAccepted | `boolean` | `TRUE` or `FALSE` |\n| maxTips | `integer` | Maximum amount for tips |\n| user1 | `string` | Custom Entry #1 |\n| user2 | `string` | Custom Entry #2 |\n| user3 | `string` | Custom Entry #3 |\n| user4 | `string` | Custom Entry #4 |\n\n---\n\n**getEntriesCheck Class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| checkId | `integer` | Aloha check ID |\n| entries | `getEntriesCheckItems[]` | An `array` of all the check entries |\n\n---\n\n**getEntriesCheckItems Class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| itemId | `integer` | Item ID |\n| price | `decimal` | Item Price |\n| name | `string` | Name for the type of tender |\n| discountedPrice | `decimal?` | `nullable` discounted price |\n| displayPrice | `string` | Price displayed |\n| quantity | `int?` | `nullable` Quantity |\n| mode | `string` | Mode |\n| level | `string` | Level |\n| data | `string` | Data |\n\n---\n\n**payments class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| paymentId | `integer` | Aloha payment ID |\n| checkId | `integer` | Aloha check ID |\n| Name | `string` | Name for the type of payment |\n| tenderId | `integer` | Aloha tender ID |\n| cardNumber | `string` | Card utilized |\n| amount | `decimal` | Payment amount |\n| tip | `decimal` | Tip amount |\n| auth | `string` | Authorization number |\n| expDate | `string` | Expiration date `MMYY` |\n| hostIp | `string` | Data |\n\n---\n\n**paymentInfo class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| amount | `decimal` | Amount to be paid |\n| tenderId | `int` | Tender ID for the transaction |\n| tip | `decimal` | Tip amount to be paid |\n| cardNumber | `string` | Card utilized |\n| expDate | `string` | Card expiration date `MMYY` |\n| auth | `integer` | Authorization number |\n\n---\n\n**orderEntries class**\n\n> Used on: \n  \n\n| Variable | Type | Value |\n| --- | --- | --- |\n| level | `string` | Level |\n| price | `decimal` | Item Price |\n| itemId | `integer` | Item ID |\n\n---\n\n# JSON Structure for Errors\n\n**Error JSON Example**\n\n``` json\n{\n    'status': 'ERROR',\n    'result': 'Exception - Exception message will appear here.'\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6395545","team":246598,"collectionId":"cc1eda9d-ff2a-4401-b4d5-a3450959fb5e","publishedId":"T17Gf7yD","public":true,"publicUrl":"https://docs.connectengine.ycspr.net","privateUrl":"https://go.postman.co/documentation/6395545-cc1eda9d-ff2a-4401-b4d5-a3450959fb5e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/fa6c6fb8-4f8f-4ff2-8945-5fe5b79d161e/WUNTLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/fa6c6fb8-4f8f-4ff2-8945-5fe5b79d161e/WUNTLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.8","publishDate":"2026-05-12T16:32:41.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/fa6c6fb8-4f8f-4ff2-8945-5fe5b79d161e/WUNTLnBuZw==","logoDark":"https://content.pstmn.io/fa6c6fb8-4f8f-4ff2-8945-5fe5b79d161e/WUNTLnBuZw=="}},"statusCode":200},"environments":[],"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"}],"canonicalUrl":"https://docs.connectengine.ycspr.net/view/metadata/T17Gf7yD"}