Modifiers

GET /locations/:locationId/modifiers

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

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

Retrieves all modifiers for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of modifier 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 modifier.	Yes
locationId	string	The unique ID for the location.
name	string	The name of the modifier.	Yes
reportCategoryId	string	The unique ID of the report category that the modifier belongs to.	Yes
deleted	boolean	True if the modifier 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": "Coke",
        "reportCategoryId": "abc1234",
        "deleted": false
    }
]

Headers
x-api-key	Your API Key

Path Variable
locationId	The unique ID for the location

GET /locations/:locationId/modifiers/:modifierId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/modifiers/:modifierId

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

Retrieves a single modifier for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single JSON modifier 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
modifierId	The unique ID for the modifier