• Subcategories:
• Connection Status

Checks API REST Endpoints

Sort by

Task Path Method

Checks API

The STS Gen2 Checks API is used to create and manage the checks within a revenue center (use the Organization Service to locate a revenue center). Configuration content (for example, menu items or discounts) from the Configuration API is used to populate a check.

Paths

The {basePath} for resources on the Checks API is:

https://{host/path}/api/v1/

The Checks API provides access to the get and modify checks in a revenue center. The context of the operation is defined by the {orgShortName}, {locRef}, and {rvcRef} parameters. In many cases the operations are executed by routing request to on-premises services. This has an increased latency over requests that are processed by cloud-base services.

Check operations that include a check in the request, get the value of the {orgShortName}, {locRef}, and {rvcRef} from the request body via the check header. Check operations that do not include check in the requests, specify these values in the header.

Delete a check

Method: delete

Path: {basePath}/checks/{checkRef}

Get a check

Method: get

Path: {basePath}/checks/{checkRef}

Get a list of checks

Method: get

Path: {basePath}/checks

Get printed check

Method: get

Path: {basePath}/checks/{checkRef}/printed

Post a new check

Method: post

Path: {basePath}/checks

Post a new round to a check

Method: post

Path: {basePath}/checks/{checkRef}/round

Post calculate totals for a check

Method: post

Path: {basePath}/checks/calculator