{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Orders","type":"basic","slug":"orders","excerpt":"","body":"Orders represent a customer interaction and have the following properties:\n \n  * Identified by numbers, such as 1, 2, 3,... that are assigned and associated with a Tracker.\n  * Move through states such as **started**, **located** and **cleared**.\n  * Have an order type of `ON_PREMISE` or `TO_GO` and can change types.\n  * A `TO_GO` order will still be located when a customer places the Tracker on a table while waiting on their order.\n  * Orders can be paged to notify a customer that their `TO_GO` order is ready for pickup.\n\n**Order Attributes** \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Details\",\n    \"0-0\": \"tableNumber\",\n    \"0-1\": \"A table within a location.\",\n    \"1-0\": \"orderLocated\",\n    \"1-1\": \"The time the tracker was placed on the table.\",\n    \"2-0\": \"orderGuid\",\n    \"2-1\": \"Unique identifier for an order.\",\n    \"3-0\": \"orderCleared\",\n    \"3-1\": \"The time the tracker was cleared.\",\n    \"4-0\": \"orderClearedReason\",\n    \"4-1\": \"How the order was cleared.\",\n    \"4-2\": \"TRACKER, MANAGER_OVERRIDE, or AUTOMATIC\",\n    \"5-0\": \"orderType\",\n    \"5-1\": \"Indicated either an on premise or to go order\",\n    \"6-0\": \"orderStarted\",\n    \"6-1\": \"The time the tracker was started.\",\n    \"7-0\": \"orderPaged\",\n    \"7-1\": \"The time the order was paged.\",\n    \"8-0\": \"orderNumber\",\n    \"8-1\": \"The order number printed on the tracker.\",\n    \"9-0\": \"ipAddress\",\n    \"9-1\": \"The ip address of the computer that uploaded the data.\",\n    \"10-0\": \"locationGuid\",\n    \"10-1\": \"Unique identifier of location where table tracker system is located.\",\n    \"11-0\": \"accountGuid\",\n    \"11-1\": \"Unique identifier for the account that owns the table tracker system.\",\n    \"12-0\": \"timeToSit\",\n    \"13-0\": \"deliveryTime\",\n    \"12-1\": \"Sit time in seconds.\",\n    \"13-1\": \"Delivery time in seconds.\"\n  },\n  \"cols\": 3,\n  \"rows\": 14\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"/rest/v3/orders{?offset,limit,dateFrom,dateTo,orderType,accountGuid,orderNumber,tableNumber,locationGuid}\"\n}\n[/block]\nRetrieve a list of orders in the system, starting at offset and returning a maximum limit of orders.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameters\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Details\",\n    \"0-0\": \"offset\",\n    \"0-1\": \"The starting point of the list.\",\n    \"0-2\": \"number, optional\\ndefault: 0\",\n    \"1-0\": \"limit\",\n    \"1-1\": \"The maximum number of order to retrieve.\",\n    \"1-2\": \"number, optional\\ndefault: 25\",\n    \"2-0\": \"dateFrom\",\n    \"2-1\": \"order created after a specific date time\",\n    \"2-2\": \"datetime, optional\\ninclusive\",\n    \"3-0\": \"dateTo\",\n    \"3-1\": \"order created before a specific date time\",\n    \"3-2\": \"datetime, optional\\nexclusive\",\n    \"4-0\": \"orderType\",\n    \"4-1\": \"type of order\",\n    \"4-2\": \"string optional\\nvalues: ON_PREMISE, TO_GO\",\n    \"5-0\": \"orderNumber\",\n    \"5-1\": \"The order number printed on the tracker.\",\n    \"5-2\": \"string, optional\",\n    \"6-0\": \"accountGuid\",\n    \"6-1\": \"The account guid.\",\n    \"6-2\": \"string, optional\",\n    \"7-0\": \"tableNumber\",\n    \"7-1\": \"A number of a table inside a location.\",\n    \"7-2\": \"string, optional\\nEx: 22, 45\",\n    \"8-0\": \"locationGuid\",\n    \"8-1\": \"The location guid.\",\n    \"8-2\": \"string, optional\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)\\n\\n$.ajax({\\n    url: \\\"https://connect.lrsus.com/rest/v3/orders\\\",\\n    type: \\\"GET\\\",\\n    headers: {\\n        \\\"Authorization\\\": \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\\\",\\n    },\\n})\\n.done(function(data, textStatus, jqXHR) {\\n    console.log(\\\"HTTP Request Succeeded: \\\" + jqXHR.status);\\n    console.log(data);\\n})\\n.fail(function(jqXHR, textStatus, errorThrown) {\\n    console.log(\\\"HTTP Request Failed\\\");\\n})\\n.always(function() {\\n    /* ... */\\n});\\n\",\n      \"language\": \"javascript\"\n    },\n    {\n      \"code\": \"import java.io.IOException;\\nimport org.apache.http.client.fluent.*;\\n\\npublic class SendRequest\\n{\\n  public static void main(String[] args) {\\n    sendRequest();\\n  }\\n  \\n  private static void sendRequest() {\\n    \\n    // Report Controller orders (GET )\\n    \\n    try {\\n      \\n      // Create request\\n      Content content = Request.Get(\\\"https://connect.lrsus.com/rest/v3/orders\\\")\\n      \\n      // Add headers\\n      .addHeader(\\\"Authorization\\\", \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\\\")\\n      \\n      // Fetch request and return content\\n      .execute().returnContent();\\n      \\n      // Print content\\n      System.out.println(content);\\n    }\\n    catch (IOException e) { System.out.println(e); }\\n  }\\n}\",\n      \"language\": \"java\"\n    },\n    {\n      \"code\": \"// Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)\\n\\nNSURL* URL = [NSURL URLWithString::::at:::\\\"https://connect.lrsus.com/rest/v3/orders\\\"];\\nNSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];\\nrequest.HTTPMethod = @\\\"GET\\\";\\n\\n// Headers\\n\\n[request addValue:@\\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\\\" forHTTPHeaderField:@\\\"Authorization\\\"];\\n\\n// Connection\\n\\nNSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];\\n[connection start];\\n\\n\",\n      \"language\": \"objectivec\"\n    },\n    {\n      \"code\": \"curl -X \\\"GET\\\" \\\"https://connect.lrsus.com/rest/v3/orders\\\" \\\\\\n\\t-H \\\"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\\\"\\n\",\n      \"language\": \"curl\"\n    },\n    {\n      \"code\": \"# Install the Python Requests library:\\n# `pip install requests`\\n\\nimport requests\\n\\ndef send_request():\\n    # Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)\\n\\n    try:\\n        r = requests.get(\\n            url=\\\"https://connect.lrsus.com/rest/v3/orders\\\",\\n            headers = {\\n                \\\"Authorization\\\":\\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\\\",\\n            },\\n        )\\n        print('Response HTTP Status Code   : {status_code}'.format(status_code=r.status_code))\\n        print('Response HTTP Response Body : {content}'.format(content=r.content))\\n    except requests.exceptions.RequestException as e:\\n        print('HTTP Request failed')\\n\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response 200 (application/json)\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n          \\\"status\\\": 200,\\n          \\\"count\\\": \\\"25\\\",\\n          \\\"offset\\\" : 50,\\n          \\\"limit\\\" : 25,\\n          \\\"first\\\" : \\\"https://connect.lrsus.com/rest/v3/orders?offset=0&limit=25\\\",\\n          \\\"previous\\\" : \\\"https://connect.lrsus.com/rest/v3/orders?offset=25&limit=25\\\",\\n          \\\"next\\\" : \\\"https://connect.lrsus.com/rest/v3/orders?offset=75&limit=25\\\",\\n          \\\"last\\\" : \\\"https://connect.lrsus.com/rest/v3/orders?offset=8745&limit=25\\\", \\n          \\\"items\\\": [\\n            {\\n              \\\"tableNumber\\\": \\\"22\\\",\\n              \\\"orderLocated\\\": \\\"2014-08-21T10:05:59+00:00\\\",\\n              \\\"orderGuid\\\": \\\"9e1da5eb-59ea-4003-9c1c-15160879c88d\\\",\\n              \\\"orderCleared\\\": \\\"2014-08-21T10:00:41+00:00\\\",\\n              \\\"orderClearedReason\\\" : \\\"TRACKER\\\",\\n              \\\"orderType\\\": \\\"ON_PREMISE\\\",\\n              \\\"orderStarted\\\": \\\"2014-08-21T10:00:36+00:00\\\",\\n              \\\"orderPaged\\\" : \\\"2014-08-21T10:01:36+00:00\\\",\\n              \\\"orderNumber\\\": \\\"66\\\",\\n              \\\"ipAddress\\\" : \\\"8.8.8.8\\\",\\n              \\\"locationGuid\\\" : \\\"3333333-59ea-4003-9c1c-00060879c88d\\\",\\n              \\\"accountGuid\\\" : \\\"777da5eb-59ea-4003-9c1c-00060879c88d\\\",\\n              \\\"timeToSit\\\" : \\\"123\\\",\\n              \\\"deliveryTime\\\" : \\\"301\\\"\\n            },\\n            ...\\n            {\\n              \\\"tableNumber\\\": \\\"33\\\",\\n              \\\"orderLocated\\\": \\\"2014-08-21T10:05:59+00:00\\\",\\n              \\\"orderGuid\\\": \\\"xxaabb5eb-59ea-4003-9c1c-15160879c88d\\\",\\n              \\\"orderCleared\\\": \\\"2014-08-21T10:00:41+00:00\\\",\\n              \\\"orderClearedReason\\\" : \\\"MANAGER_OVERRIDE\\\",\\n              \\\"orderType\\\": \\\"TO_GO\\\",\\n              \\\"orderStarted\\\": \\\"2014-08-21T10:00:36+00:00\\\",\\n              \\\"orderPaged\\\" : \\\"2014-08-21T10:01:36+00:00\\\",\\n              \\\"orderNumber\\\": \\\"66\\\",\\n              \\\"ipAddress\\\" : \\\"8.8.8.8\\\",\\n              \\\"locationGuid\\\" : \\\"3333333-59ea-4003-9c1c-00060879c88d\\\",\\n              \\\"accountGuid\\\" : \\\"777da5eb-59ea-4003-9c1c-00060879c88d\\\",\\n              \\\"timeToSit\\\" : \\\"223\\\",\\n              \\\"deliveryTime\\\" : \\\"501\\\"\\n            }\\n          ]\\n        }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"/rest/v3/orders/{orderGuid}\"\n}\n[/block]\nRetrieve a single order by its unique identifier.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)\\n\\n$.ajax({\\n    url: \\\"https://connect.lrsus.com/rest/v3/orders/7c089977-edeb-43b6-9303-872e0385d598\\\",\\n    type: \\\"GET\\\",\\n    headers: {\\n        \\\"Authorization\\\": \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\\\",\\n    }\\n})\\n.done(function(data, textStatus, jqXHR) {\\n    console.log(\\\"HTTP Request Succeeded: \\\" + jqXHR.status);\\n    console.log(data);\\n})\\n.fail(function(jqXHR, textStatus, errorThrown) {\\n    console.log(\\\"HTTP Request Failed\\\");\\n})\\n.always(function() {\\n    /* ... */\\n});\\n\",\n      \"language\": \"javascript\"\n    },\n    {\n      \"code\": \"import java.io.IOException;\\nimport org.apache.http.client.fluent.*;\\n\\npublic class SendRequest\\n{\\n  public static void main(String[] args) {\\n    sendRequest();\\n  }\\n  \\n  private static void sendRequest() {\\n    \\n    // Report Controller orders Duplicate (GET )\\n    \\n    try {\\n      \\n      // Create request\\n      Content content = Request.Get(\\\"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598\\\")\\n      \\n      // Add headers\\n      .addHeader(\\\"Authorization\\\", \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\\\")\\n      \\n      // Fetch request and return content\\n      .execute().returnContent();\\n      \\n      // Print content\\n      System.out.println(content);\\n    }\\n    catch (IOException e) { System.out.println(e); }\\n  }\\n}\",\n      \"language\": \"java\"\n    },\n    {\n      \"code\": \"// Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)\\n\\nNSURL* URL = [NSURL URLWithString:@\\\"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598\\\"];\\nNSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];\\nrequest.HTTPMethod = @\\\"GET\\\";\\n\\n// Headers\\n\\n[request addValue:@\\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\\\" forHTTPHeaderField:@\\\"Authorization\\\"];\\n\\n// Connection\\n\\nNSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];\\n[connection start];\\n\\n\",\n      \"language\": \"objectivec\"\n    },\n    {\n      \"code\": \"curl -X \\\"GET\\\" \\\"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598\\\" \\\\\\n\\t-H \\\"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\\\"\\n\",\n      \"language\": \"curl\"\n    },\n    {\n      \"code\": \"# Install the Python Requests library:\\n# `pip install requests`\\n\\nimport requests\\n\\ndef send_request():\\n    # Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)\\n\\n    try:\\n        r = requests.get(\\n            url=\\\"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598\\\",\\n            headers = {\\n                \\\"Authorization\\\":\\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\\\",\\n            },\\n        )\\n        print('Response HTTP Status Code   : {status_code}'.format(status_code=r.status_code))\\n        print('Response HTTP Response Body : {content}'.format(content=r.content))\\n    except requests.exceptions.RequestException as e:\\n        print('HTTP Request failed')\\n\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameters\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Details\",\n    \"0-0\": \"orderGuid\",\n    \"0-1\": \"The unique identifier of the order to retrieve.\",\n    \"0-2\": \"string, required\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response 200 (application/json)\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n          \\\"status\\\": 200,\\n          \\\"order\\\" :  {\\n              \\\"tableNumber\\\": \\\"22\\\",\\n              \\\"orderLocated\\\": \\\"2014-08-21T10:05:59+00:00\\\",\\n              \\\"orderGuid\\\": \\\"9e1da5eb-59ea-4003-9c1c-15160879c88d\\\",\\n              \\\"orderCleared\\\": \\\"2014-08-21T10:00:41+00:00\\\",\\n              \\\"orderClearedReason\\\" : \\\"TRACKER\\\",\\n              \\\"orderType\\\": \\\"ON_PREMISE\\\",\\n              \\\"orderStarted\\\": \\\"2014-08-21T10:00:36+00:00\\\",\\n              \\\"orderPaged\\\" : \\\"2014-08-21T10:01:36+00:00\\\",\\n              \\\"orderNumber\\\": \\\"66\\\",\\n              \\\"ipAddress\\\" : \\\"8.8.8.8\\\",\\n              \\\"locationGuid\\\" : \\\"3333333-59ea-4003-9c1c-00060879c88d\\\",\\n              \\\"accountGuid\\\" : \\\"777da5eb-59ea-4003-9c1c-00060879c88d\\\",\\n              \\\"timeToSit\\\" : \\\"123\\\",\\n              \\\"deliveryTime\\\" : \\\"301\\\"\\n           }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"58766da64a24f82f00bbf28b","version":{"version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["58766da64a24f82f00bbf286","5e97f10ca9631a0231d9c19a"],"_id":"58766da54a24f82f00bbf285","releaseDate":"2017-01-11T17:38:45.993Z","project":"552819c1555b9e0d00564f74","__v":2,"createdAt":"2017-01-11T17:38:45.993Z"},"__v":0,"createdAt":"2015-07-01T15:03:47.290Z","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"58766da64a24f82f00bbf286","version":"58766da54a24f82f00bbf285","project":"552819c1555b9e0d00564f74","createdAt":"2015-04-10T18:43:14.538Z","__v":0},"project":"552819c1555b9e0d00564f74","user":"55157a70c859ac2f0001b535","githubsync":"","parentDoc":null}
Orders represent a customer interaction and have the following properties: * Identified by numbers, such as 1, 2, 3,... that are assigned and associated with a Tracker. * Move through states such as **started**, **located** and **cleared**. * Have an order type of `ON_PREMISE` or `TO_GO` and can change types. * A `TO_GO` order will still be located when a customer places the Tracker on a table while waiting on their order. * Orders can be paged to notify a customer that their `TO_GO` order is ready for pickup. **Order Attributes** [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Details", "0-0": "tableNumber", "0-1": "A table within a location.", "1-0": "orderLocated", "1-1": "The time the tracker was placed on the table.", "2-0": "orderGuid", "2-1": "Unique identifier for an order.", "3-0": "orderCleared", "3-1": "The time the tracker was cleared.", "4-0": "orderClearedReason", "4-1": "How the order was cleared.", "4-2": "TRACKER, MANAGER_OVERRIDE, or AUTOMATIC", "5-0": "orderType", "5-1": "Indicated either an on premise or to go order", "6-0": "orderStarted", "6-1": "The time the tracker was started.", "7-0": "orderPaged", "7-1": "The time the order was paged.", "8-0": "orderNumber", "8-1": "The order number printed on the tracker.", "9-0": "ipAddress", "9-1": "The ip address of the computer that uploaded the data.", "10-0": "locationGuid", "10-1": "Unique identifier of location where table tracker system is located.", "11-0": "accountGuid", "11-1": "Unique identifier for the account that owns the table tracker system.", "12-0": "timeToSit", "13-0": "deliveryTime", "12-1": "Sit time in seconds.", "13-1": "Delivery time in seconds." }, "cols": 3, "rows": 14 } [/block] [block:api-header] { "type": "get", "title": "/rest/v3/orders{?offset,limit,dateFrom,dateTo,orderType,accountGuid,orderNumber,tableNumber,locationGuid}" } [/block] Retrieve a list of orders in the system, starting at offset and returning a maximum limit of orders. [block:api-header] { "type": "basic", "title": "Parameters" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Details", "0-0": "offset", "0-1": "The starting point of the list.", "0-2": "number, optional\ndefault: 0", "1-0": "limit", "1-1": "The maximum number of order to retrieve.", "1-2": "number, optional\ndefault: 25", "2-0": "dateFrom", "2-1": "order created after a specific date time", "2-2": "datetime, optional\ninclusive", "3-0": "dateTo", "3-1": "order created before a specific date time", "3-2": "datetime, optional\nexclusive", "4-0": "orderType", "4-1": "type of order", "4-2": "string optional\nvalues: ON_PREMISE, TO_GO", "5-0": "orderNumber", "5-1": "The order number printed on the tracker.", "5-2": "string, optional", "6-0": "accountGuid", "6-1": "The account guid.", "6-2": "string, optional", "7-0": "tableNumber", "7-1": "A number of a table inside a location.", "7-2": "string, optional\nEx: 22, 45", "8-0": "locationGuid", "8-1": "The location guid.", "8-2": "string, optional" }, "cols": 3, "rows": 9 } [/block] [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "// Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)\n\n$.ajax({\n url: \"https://connect.lrsus.com/rest/v3/orders\",\n type: \"GET\",\n headers: {\n \"Authorization\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\",\n },\n})\n.done(function(data, textStatus, jqXHR) {\n console.log(\"HTTP Request Succeeded: \" + jqXHR.status);\n console.log(data);\n})\n.fail(function(jqXHR, textStatus, errorThrown) {\n console.log(\"HTTP Request Failed\");\n})\n.always(function() {\n /* ... */\n});\n", "language": "javascript" }, { "code": "import java.io.IOException;\nimport org.apache.http.client.fluent.*;\n\npublic class SendRequest\n{\n public static void main(String[] args) {\n sendRequest();\n }\n \n private static void sendRequest() {\n \n // Report Controller orders (GET )\n \n try {\n \n // Create request\n Content content = Request.Get(\"https://connect.lrsus.com/rest/v3/orders\")\n \n // Add headers\n .addHeader(\"Authorization\", \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\")\n \n // Fetch request and return content\n .execute().returnContent();\n \n // Print content\n System.out.println(content);\n }\n catch (IOException e) { System.out.println(e); }\n }\n}", "language": "java" }, { "code": "// Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)\n\nNSURL* URL = [NSURL URLWithString:@\"https://connect.lrsus.com/rest/v3/orders\"];\nNSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];\nrequest.HTTPMethod = @\"GET\";\n\n// Headers\n\n[request addValue:@\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\" forHTTPHeaderField:@\"Authorization\"];\n\n// Connection\n\nNSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];\n[connection start];\n\n", "language": "objectivec" }, { "code": "curl -X \"GET\" \"https://connect.lrsus.com/rest/v3/orders\" \\\n\t-H \"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\"\n", "language": "curl" }, { "code": "# Install the Python Requests library:\n# `pip install requests`\n\nimport requests\n\ndef send_request():\n # Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)\n\n try:\n r = requests.get(\n url=\"https://connect.lrsus.com/rest/v3/orders\",\n headers = {\n \"Authorization\":\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0\",\n },\n )\n print('Response HTTP Status Code : {status_code}'.format(status_code=r.status_code))\n print('Response HTTP Response Body : {content}'.format(content=r.content))\n except requests.exceptions.RequestException as e:\n print('HTTP Request failed')\n", "language": "python" } ] } [/block] [block:api-header] { "type": "basic", "title": "Response 200 (application/json)" } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"count\": \"25\",\n \"offset\" : 50,\n \"limit\" : 25,\n \"first\" : \"https://connect.lrsus.com/rest/v3/orders?offset=0&limit=25\",\n \"previous\" : \"https://connect.lrsus.com/rest/v3/orders?offset=25&limit=25\",\n \"next\" : \"https://connect.lrsus.com/rest/v3/orders?offset=75&limit=25\",\n \"last\" : \"https://connect.lrsus.com/rest/v3/orders?offset=8745&limit=25\", \n \"items\": [\n {\n \"tableNumber\": \"22\",\n \"orderLocated\": \"2014-08-21T10:05:59+00:00\",\n \"orderGuid\": \"9e1da5eb-59ea-4003-9c1c-15160879c88d\",\n \"orderCleared\": \"2014-08-21T10:00:41+00:00\",\n \"orderClearedReason\" : \"TRACKER\",\n \"orderType\": \"ON_PREMISE\",\n \"orderStarted\": \"2014-08-21T10:00:36+00:00\",\n \"orderPaged\" : \"2014-08-21T10:01:36+00:00\",\n \"orderNumber\": \"66\",\n \"ipAddress\" : \"8.8.8.8\",\n \"locationGuid\" : \"3333333-59ea-4003-9c1c-00060879c88d\",\n \"accountGuid\" : \"777da5eb-59ea-4003-9c1c-00060879c88d\",\n \"timeToSit\" : \"123\",\n \"deliveryTime\" : \"301\"\n },\n ...\n {\n \"tableNumber\": \"33\",\n \"orderLocated\": \"2014-08-21T10:05:59+00:00\",\n \"orderGuid\": \"xxaabb5eb-59ea-4003-9c1c-15160879c88d\",\n \"orderCleared\": \"2014-08-21T10:00:41+00:00\",\n \"orderClearedReason\" : \"MANAGER_OVERRIDE\",\n \"orderType\": \"TO_GO\",\n \"orderStarted\": \"2014-08-21T10:00:36+00:00\",\n \"orderPaged\" : \"2014-08-21T10:01:36+00:00\",\n \"orderNumber\": \"66\",\n \"ipAddress\" : \"8.8.8.8\",\n \"locationGuid\" : \"3333333-59ea-4003-9c1c-00060879c88d\",\n \"accountGuid\" : \"777da5eb-59ea-4003-9c1c-00060879c88d\",\n \"timeToSit\" : \"223\",\n \"deliveryTime\" : \"501\"\n }\n ]\n }", "language": "json" } ] } [/block] [block:api-header] { "type": "get", "title": "/rest/v3/orders/{orderGuid}" } [/block] Retrieve a single order by its unique identifier. [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "// Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)\n\n$.ajax({\n url: \"https://connect.lrsus.com/rest/v3/orders/7c089977-edeb-43b6-9303-872e0385d598\",\n type: \"GET\",\n headers: {\n \"Authorization\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\",\n }\n})\n.done(function(data, textStatus, jqXHR) {\n console.log(\"HTTP Request Succeeded: \" + jqXHR.status);\n console.log(data);\n})\n.fail(function(jqXHR, textStatus, errorThrown) {\n console.log(\"HTTP Request Failed\");\n})\n.always(function() {\n /* ... */\n});\n", "language": "javascript" }, { "code": "import java.io.IOException;\nimport org.apache.http.client.fluent.*;\n\npublic class SendRequest\n{\n public static void main(String[] args) {\n sendRequest();\n }\n \n private static void sendRequest() {\n \n // Report Controller orders Duplicate (GET )\n \n try {\n \n // Create request\n Content content = Request.Get(\"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598\")\n \n // Add headers\n .addHeader(\"Authorization\", \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\")\n \n // Fetch request and return content\n .execute().returnContent();\n \n // Print content\n System.out.println(content);\n }\n catch (IOException e) { System.out.println(e); }\n }\n}", "language": "java" }, { "code": "// Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)\n\nNSURL* URL = [NSURL URLWithString:@\"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598\"];\nNSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];\nrequest.HTTPMethod = @\"GET\";\n\n// Headers\n\n[request addValue:@\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\" forHTTPHeaderField:@\"Authorization\"];\n\n// Connection\n\nNSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];\n[connection start];\n\n", "language": "objectivec" }, { "code": "curl -X \"GET\" \"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598\" \\\n\t-H \"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\"\n", "language": "curl" }, { "code": "# Install the Python Requests library:\n# `pip install requests`\n\nimport requests\n\ndef send_request():\n # Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)\n\n try:\n r = requests.get(\n url=\"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598\",\n headers = {\n \"Authorization\":\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo\",\n },\n )\n print('Response HTTP Status Code : {status_code}'.format(status_code=r.status_code))\n print('Response HTTP Response Body : {content}'.format(content=r.content))\n except requests.exceptions.RequestException as e:\n print('HTTP Request failed')\n", "language": "python" } ] } [/block] [block:api-header] { "type": "basic", "title": "Parameters" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Details", "0-0": "orderGuid", "0-1": "The unique identifier of the order to retrieve.", "0-2": "string, required" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response 200 (application/json)" } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"order\" : {\n \"tableNumber\": \"22\",\n \"orderLocated\": \"2014-08-21T10:05:59+00:00\",\n \"orderGuid\": \"9e1da5eb-59ea-4003-9c1c-15160879c88d\",\n \"orderCleared\": \"2014-08-21T10:00:41+00:00\",\n \"orderClearedReason\" : \"TRACKER\",\n \"orderType\": \"ON_PREMISE\",\n \"orderStarted\": \"2014-08-21T10:00:36+00:00\",\n \"orderPaged\" : \"2014-08-21T10:01:36+00:00\",\n \"orderNumber\": \"66\",\n \"ipAddress\" : \"8.8.8.8\",\n \"locationGuid\" : \"3333333-59ea-4003-9c1c-00060879c88d\",\n \"accountGuid\" : \"777da5eb-59ea-4003-9c1c-00060879c88d\",\n \"timeToSit\" : \"123\",\n \"deliveryTime\" : \"301\"\n }\n}", "language": "json" } ] } [/block]