Report Categories

GET /locations/:locationId/report-categories

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/report-categories

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//report-categories' \
--header 'x-api-key;'

Retrieves all report categories for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of report category objects. Each object in the array will be structured as follows:

Field Name	Field Type	Field Description	Org Level Attribute*
id	string	The unique ID for the report category.	Yes
locationId	string	The unique ID for the location.
name	string	The name of the report category.	Yes
parentId	string	The unique ID of the parent report category (report categories can be organized in a hierarchical fashion).	Yes
deleted	boolean	True if the report category has been marked as deleted.	Yes

📘
*Note that the values of fields marked as "Org Level Attribute" are shared amongst all locations that reside in the same POS organization.

Example Response

[
    {
        "id": "abc123",
        "locationId": "LocationX",
        "name": "Food",
        "parentId": "abc1234",
        "deleted": false
    }
]

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/report-categories/:reportCategoryId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/report-categories/:reportCategoryId

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//report-categories/' \
--header 'x-api-key;'

Retrieves a single report category for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single JSON report category object. See the parent route's documentation for more details.

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location
reportCategoryId	The unique ID for the report category