Orders
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
orTO_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
Name | Description | Details |
---|---|---|
tableNumber | A table within a location. | |
orderLocated | The time the tracker was placed on the table. | |
orderGuid | Unique identifier for an order. | |
orderCleared | The time the tracker was cleared. | |
orderClearedReason | How the order was cleared. | TRACKER, MANAGER_OVERRIDE, or AUTOMATIC |
orderType | Indicated either an on premise or to go order | |
orderStarted | The time the tracker was started. | |
orderPaged | The time the order was paged. | |
orderNumber | The order number printed on the tracker. | |
ipAddress | The ip address of the computer that uploaded the data. | |
locationGuid | Unique identifier of location where table tracker system is located. | |
accountGuid | Unique identifier for the account that owns the table tracker system. | |
timeToSit | Sit time in seconds. | |
deliveryTime | Delivery time in seconds. |
/rest/v3/orders{?offset,limit,dateFrom,dateTo,orderType,accountGuid,orderNumber,tableNumber,locationGuid}
Retrieve a list of orders in the system, starting at offset and returning a maximum limit of orders.
Parameters
Name | Description | Details |
---|---|---|
offset | The starting point of the list. | number, optional default: 0 |
limit | The maximum number of order to retrieve. | number, optional default: 25 |
dateFrom | order created after a specific date time | datetime, optional inclusive |
dateTo | order created before a specific date time | datetime, optional exclusive |
orderType | type of order | string optional values: ON_PREMISE, TO_GO |
orderNumber | The order number printed on the tracker. | string, optional |
accountGuid | The account guid. | string, optional |
tableNumber | A number of a table inside a location. | string, optional Ex: 22, 45 |
locationGuid | The location guid. | string, optional |
Request
// Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)
$.ajax({
url: "https://connect.lrsus.com/rest/v3/orders",
type: "GET",
headers: {
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0",
},
})
.done(function(data, textStatus, jqXHR) {
console.log("HTTP Request Succeeded: " + jqXHR.status);
console.log(data);
})
.fail(function(jqXHR, textStatus, errorThrown) {
console.log("HTTP Request Failed");
})
.always(function() {
/* ... */
});
import java.io.IOException;
import org.apache.http.client.fluent.*;
public class SendRequest
{
public static void main(String[] args) {
sendRequest();
}
private static void sendRequest() {
// Report Controller orders (GET )
try {
// Create request
Content content = Request.Get("https://connect.lrsus.com/rest/v3/orders")
// Add headers
.addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0")
// Fetch request and return content
.execute().returnContent();
// Print content
System.out.println(content);
}
catch (IOException e) { System.out.println(e); }
}
}
// Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)
NSURL* URL = [NSURL URLWithString:@"https://connect.lrsus.com/rest/v3/orders"];
NSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];
request.HTTPMethod = @"GET";
// Headers
[request addValue:@"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0" forHTTPHeaderField:@"Authorization"];
// Connection
NSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];
[connection start];
curl -X "GET" "https://connect.lrsus.com/rest/v3/orders" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0"
# Install the Python Requests library:
# `pip install requests`
import requests
def send_request():
# Report Controller orders (GET https://connect.lrsus.com/rest/v3/orders)
try:
r = requests.get(
url="https://connect.lrsus.com/rest/v3/orders",
headers = {
"Authorization":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3ODAwMjksInN1YiI6IlY5MjhaNENSV1hUM1oxWlFJNzRUSk5UUFgiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc4ODI5fQ.HImt7h2ML-gNsphXIxRIlIv9IV8uLuOuSx8QKyezeA0",
},
)
print('Response HTTP Status Code : {status_code}'.format(status_code=r.status_code))
print('Response HTTP Response Body : {content}'.format(content=r.content))
except requests.exceptions.RequestException as e:
print('HTTP Request failed')
Response 200 (application/json)
{
"status": 200,
"count": "25",
"offset" : 50,
"limit" : 25,
"first" : "https://connect.lrsus.com/rest/v3/orders?offset=0&limit=25",
"previous" : "https://connect.lrsus.com/rest/v3/orders?offset=25&limit=25",
"next" : "https://connect.lrsus.com/rest/v3/orders?offset=75&limit=25",
"last" : "https://connect.lrsus.com/rest/v3/orders?offset=8745&limit=25",
"items": [
{
"tableNumber": "22",
"orderLocated": "2014-08-21T10:05:59+00:00",
"orderGuid": "9e1da5eb-59ea-4003-9c1c-15160879c88d",
"orderCleared": "2014-08-21T10:00:41+00:00",
"orderClearedReason" : "TRACKER",
"orderType": "ON_PREMISE",
"orderStarted": "2014-08-21T10:00:36+00:00",
"orderPaged" : "2014-08-21T10:01:36+00:00",
"orderNumber": "66",
"ipAddress" : "8.8.8.8",
"locationGuid" : "3333333-59ea-4003-9c1c-00060879c88d",
"accountGuid" : "777da5eb-59ea-4003-9c1c-00060879c88d",
"timeToSit" : "123",
"deliveryTime" : "301"
},
...
{
"tableNumber": "33",
"orderLocated": "2014-08-21T10:05:59+00:00",
"orderGuid": "xxaabb5eb-59ea-4003-9c1c-15160879c88d",
"orderCleared": "2014-08-21T10:00:41+00:00",
"orderClearedReason" : "MANAGER_OVERRIDE",
"orderType": "TO_GO",
"orderStarted": "2014-08-21T10:00:36+00:00",
"orderPaged" : "2014-08-21T10:01:36+00:00",
"orderNumber": "66",
"ipAddress" : "8.8.8.8",
"locationGuid" : "3333333-59ea-4003-9c1c-00060879c88d",
"accountGuid" : "777da5eb-59ea-4003-9c1c-00060879c88d",
"timeToSit" : "223",
"deliveryTime" : "501"
}
]
}
/rest/v3/orders/{orderGuid}
Retrieve a single order by its unique identifier.
Request
// Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)
$.ajax({
url: "https://connect.lrsus.com/rest/v3/orders/7c089977-edeb-43b6-9303-872e0385d598",
type: "GET",
headers: {
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo",
}
})
.done(function(data, textStatus, jqXHR) {
console.log("HTTP Request Succeeded: " + jqXHR.status);
console.log(data);
})
.fail(function(jqXHR, textStatus, errorThrown) {
console.log("HTTP Request Failed");
})
.always(function() {
/* ... */
});
import java.io.IOException;
import org.apache.http.client.fluent.*;
public class SendRequest
{
public static void main(String[] args) {
sendRequest();
}
private static void sendRequest() {
// Report Controller orders Duplicate (GET )
try {
// Create request
Content content = Request.Get("https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598")
// Add headers
.addHeader("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo")
// Fetch request and return content
.execute().returnContent();
// Print content
System.out.println(content);
}
catch (IOException e) { System.out.println(e); }
}
}
// Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)
NSURL* URL = [NSURL URLWithString:@"https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598"];
NSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];
request.HTTPMethod = @"GET";
// Headers
[request addValue:@"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo" forHTTPHeaderField:@"Authorization"];
// Connection
NSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];
[connection start];
curl -X "GET" "https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo"
# Install the Python Requests library:
# `pip install requests`
import requests
def send_request():
# Report Controller orders Duplicate (GET https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598)
try:
r = requests.get(
url="https://connect.lrsus.com/rest/v3/orders/7c088e77-edeb-43b6-9303-872e0385d598",
headers = {
"Authorization":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NzkwMjMsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1Nzc3ODIzfQ.2oid1WTdZ36pR0cLKal_QcdBCHFfzmM4ogFC1lfxEUo",
},
)
print('Response HTTP Status Code : {status_code}'.format(status_code=r.status_code))
print('Response HTTP Response Body : {content}'.format(content=r.content))
except requests.exceptions.RequestException as e:
print('HTTP Request failed')
Parameters
Name | Description | Details |
---|---|---|
orderGuid | The unique identifier of the order to retrieve. | string, required |
Response 200 (application/json)
{
"status": 200,
"order" : {
"tableNumber": "22",
"orderLocated": "2014-08-21T10:05:59+00:00",
"orderGuid": "9e1da5eb-59ea-4003-9c1c-15160879c88d",
"orderCleared": "2014-08-21T10:00:41+00:00",
"orderClearedReason" : "TRACKER",
"orderType": "ON_PREMISE",
"orderStarted": "2014-08-21T10:00:36+00:00",
"orderPaged" : "2014-08-21T10:01:36+00:00",
"orderNumber": "66",
"ipAddress" : "8.8.8.8",
"locationGuid" : "3333333-59ea-4003-9c1c-00060879c88d",
"accountGuid" : "777da5eb-59ea-4003-9c1c-00060879c88d",
"timeToSit" : "123",
"deliveryTime" : "301"
}
}
Updated less than a minute ago