V1 REST Endpoints

Sort by

Task Path Method

Configuration API/V1

The STS Gen2 Configuration Service is used to interact with POS system configuration. Items are configured for each revenue center uder property and organization. Available revenue centers can be obtained from the Organization Service.

Paths

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

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

The Configuration API provides access to the Tables, Menu (menu items, condiments, condiment rules, pricing...), Discounts, Service Charges, Tenders, Taxes, Menu Item Availability, Menu Items Barcode resources configured for a revenue center.

Because each revenue center is uniquely identified by a combination of the {orgShortName}, {locRef}, and {rvcRef} then the path to each of the resources includes these values.

The following is not supported for STS Gen2 on-premises integrations:
- /barcodes/collection

Get a menu

Method: get

Path: /api/v1/menus/{menuId}

Get a summary of all available menus

Method: get

Path: /api/v1/menus/summary

Get tax definitions

Method: get

Path: /api/v1/taxes

Get the barcode collection

Method: get

Path: /api/v1/barcodes/collection

Get the collection of unavailable menu items

Method: get

Path: /api/v1/menus/items/unavailable

Get the discount collection

Method: get

Path: /api/v1/discounts/collection

Get the service charge collection

Method: get

Path: /api/v1/serviceCharges/collection

Get the tender collection

Method: get

Path: /api/v1/tenders/collection