Header Parameters
The STS Gen2 APIs use the following header parameters. Required headers may vary by endpoint; refer to the API and request documentation to determine where each header is required or used.
| Name | Description | Type/Format | Required | Example | API | Request |
|---|---|---|---|---|---|---|
| Simphony-OrgShortName | Organization identifier. Configuration and Employees APIs force this value to lower-case. | string | Yes | "tfoinc" |
Checks API Configuration API v1 Configuration API v2 Employees API |
Checks API: DELETE /checks/{checkRef}; GET /checks; GET /checks/{checkRef}; GET /checks/{checkRef}/printed; HEAD /checks/connectionStatus; POST /checks; POST /checks/calculator; POST /checks/{checkRef}/round Configuration API v1: GET /menus/{menuId} Configuration API v2: GET /menus/{menuId} Employees API: declared reusable header |
| Simphony-LocRef | Location identifier. Configuration and Employees APIs force this value to lower-case. | string | Yes | "fdmnh144" |
Checks API Configuration API v1 Configuration API v2 Employees API |
Checks API: DELETE /checks/{checkRef}; GET /checks; GET /checks/{checkRef}; GET /checks/{checkRef}/printed; HEAD /checks/connectionStatus; POST /checks; POST /checks/calculator; POST /checks/{checkRef}/round Configuration API v1: GET /menus/{menuId} Configuration API v2: GET /menus/{menuId} Employees API: declared reusable header |
| Simphony-RvcRef | Revenue center identifier | integer | Yes | 42 |
Checks API Configuration API v1 Configuration API v2 |
Checks API: DELETE /checks/{checkRef}; GET /checks; GET /checks/{checkRef}; GET /checks/{checkRef}/printed; HEAD /checks/connectionStatus; POST /checks; POST /checks/calculator; POST /checks/{checkRef}/round Configuration API v1: GET /menus/{menuId} Configuration API v2: GET /menus/{menuId} |
| Accept Language | Identifies the language desired for the response. | string | No | "en-US" |
Checks API |
Checks API: GET /checks/{checkRef}; GET /checks/{checkRef}/printed; POST /checks; POST /checks/calculator; POST /checks/{checkRef}/round |
| Simphony Features | Enables optional Simphony features. Supported values include detect-duplicate-request and enable-condiment-prefix. Multiple values can be supplied as a comma-separated list. | string | No | "detect-duplicate-request,enable-condiment-prefix" |
Checks API |
Checks API: POST /checks; POST /checks/{checkRef}/round |
| Prefer | Requests the preferred response format for check responses. Supported values include normal and includePrintedOutput. | array[string] | No | "normal" or "includePrintedOutput" |
Checks API |
Checks API: declared reusable header |
| If-Modified-Since | Standard HTTP caching header used for conditional GET requests. | string | No | "Wed, 21 Oct 2015 07:28:00 GMT" |
Configuration API v1 Configuration API v2 Employees API |
Configuration API v1: GET /barcodes/collection; GET /discounts/collection; GET /menus/{menuId}; GET /serviceCharges/collection; GET /taxes; GET /tenders/collection Configuration API v2: GET /menus/{menuId} Employees API: GET /employees |
| If-None-Match | Standard HTTP caching header used for ETag-based conditional GET requests. | string | No | "abc123" |
Configuration API v1 Configuration API v2 Employees API |
Configuration API v1: GET /barcodes/collection; GET /discounts/collection; GET /menus/items/unavailable; GET /menus/{menuId}; GET /serviceCharges/collection; GET /taxes; GET /tenders/collection Configuration API v2: GET /menus/{menuId} Employees API: GET /employees |
| Digest | Base64 encoded HMACSHA256 hash of the ASCII-encoded request message body, using the subscriber key as the hash key. | string | Yes | "<Base64 HMACSHA256 digest>" |
Notifications Webhook |
Notifications Webhook: POST /webhook |
| Key-Id | Identifier of the key used to sign the webhook digest. | string | Yes | "<key id>" |
Notifications Webhook |
Notifications Webhook: POST /webhook |