Query Parameters
The STS Gen2 APIs use the following query parameters. Required parameters may vary by endpoint; refer to the API and request documentation to determine where each parameter is required or used.
| Name | Description | Type/Format | Required | Example | API | Request |
|---|---|---|---|---|---|---|
| checkEmployeeRef | The reference number of the employee who owns the check. This parameter allows checks to be returned for a specific employee only. | integer | No | 65 | Checks API | GET /checks |
| checkNumbers | Only checks with the specified check numbers are returned. Multiple checks with the same check number may be returned. | array[integer] | No | 543,976 | Checks API | GET /checks |
| count | Total number of items in the collection for all pages. | number | Yes | 5 | Organization API | Declared reusable parameter; GET /search/locations; GET /search/revenueCenters |
| EmployeeId | Employee ID number. | integer/int64 | Yes | 1111 | Employees API | Declared reusable parameter; GET /employees |
| floor | address floor | string | No | "1" | Organization API | Declared reusable parameter; GET /search/locations; GET /search/revenueCenters |
| includeClosed | When includeClose is set to true, both open and closed checks are returned. When includeClose is set to false, only open checks are returned. The default value is false if the parameter is not specified. | boolean | No | true | Checks API | GET /check |
| latitude | WGS84 latitude, in degrees | number | Yes | 51.5074 | Organization API | Declared reusable parameter; GET /search/locations; GET /search/revenueCenters |
| limit | The limit applied to the current page. This parameter specifies the maximum number of items to return in the request. | integer | No | 50 | Organization API | Declared reusable parameter; GET /organizations; GET /organizations/{orgShortName}/locations; GET /organizations/{orgShortName}/locations/{locRef}/revenueCenters |
| locRef | The location identifier. | string | Yes | "fdmnh144" | Checks API | Declared reusable parameter |
| LocRef | The location identifier. | string | No | "fdmnh144" | Configuration API v1 | Declared reusable parameter; GET /menus/summary |
| LocRef | The location identifier. | string | Yes | "fdmnh144" | Configuration API v1 | Declared reusable parameter; GET /barcodes/collection; GET /discounts/collection; GET /menus/items/unavailable; GET /serviceCharges/collection; GET /taxes; GET /tenders/collection |
| LocRef | The location identifier. | string | No | "fdmnh144" | Configuration API v2 | Declared reusable parameter; GET /menus/summary |
| LocRef | The location identifier. | string | Yes | "fdmnh144" | Configuration API v2 | Declared reusable parameter |
| LocRef | The location identifier. Will be forced to lower-case. | string | Yes | "fdmnh144" | Employees API | Declared reusable parameter; GET /employees |
| locRef | Location Identifier | string | Yes | "fdmnh144" | Organization API | Declared reusable parameter; GET /search/revenueCenters |
| longitude | WGS84 Longitude, in degrees | number | Yes | -0.1278 | Organization API | Declared reusable parameter; GET /search/locations; GET /search/revenueCenters |
| offset | The offset indicating the starting position of the current page within the collection. If the offset parameter is not included in the request, all objects are returned. | integer | No | 0 | Organization API | Declared reusable parameter; GET /organizations; GET /organizations/{orgShortName}/locations; GET /organizations/{orgShortName}/locations/{locRef}/revenueCenters |
| orderTypeRef | Only checks of this order type are included in the results. | integer | No | 2 | Checks API | GET /checks |
| orgShortName | The organization identifier. | string | Yes | "tfoinc" | Checks API | Declared reusable parameter |
| OrgShortName | The organization identifier. | string | Yes | "tfoinc" | Configuration API v1 | Declared reusable parameter; GET /barcodes/collection; GET /discounts/collection; GET /menus/items/unavailable; GET /menus/summary; GET /serviceCharges/collection; GET /taxes; GET /tenders/collection |
| OrgShortName | The organization identifier. | string | Yes | "tfoinc" | Configuration API v2 | Declared reusable parameter; GET /menus/summary |
| OrgShortName | The organization identifier. Will be forced to lower-case. | string | Yes | "tfoinc" | Employees API | Declared reusable parameter; GET /employees |
| orgShortName | Organization Identifier | string | Yes | "tfoinc" | Organization API | Declared reusable parameter; GET /search/locations; GET /search/revenueCenters |
| radius | The search radius in meters. | number | No | 5000 | Organization API | Declared reusable parameter; GET /search/locations; GET /search/revenueCenters |
| rvcRef | The revenue center identifier. | integer | Yes | 42 | Checks API | Declared reusable parameter |
| RvcRef | The revenue center identifier. | string | No | 42 | Configuration API v1 | Declared reusable parameter; GET /menus/summary |
| RvcRef | The revenue center identifier. | string | Yes | 42 | Configuration API v1 | Declared reusable parameter; GET /barcodes/collection; GET /discounts/collection; GET /menus/items/unavailable; GET /serviceCharges/collection; GET /taxes; GET /tenders/collection |
| RvcRef | The revenue center identifier. | string | No | 42 | Configuration API v2 | Declared reusable parameter; GET /menus/summary |
| RvcRef | The revenue center identifier. | string | Yes | 42 | Configuration API v2 | Declared reusable parameter |
| sinceTime | Only checks created on or after this time are returned in the result. Date time is UTC. | string/time | No | "2020-12-31T23:59Z" | Checks API | GET /checks |
| tableName | A table reference used to filter by table number or table name. The tableName attribute can represent either a single table number or a table name, both of which are represented as strings in the API. RVC option 18 determines whether the value provided in tableName is interpreted by the POS as the table name or the table number. | string | No | "12" | Checks API | GET /checks |