Modifier Options

GET /locations/:locationId/modifier-options

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

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

Retrieves all modifier options for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of modifier option 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 option.	Yes
locationId	string	The unique ID for the location.
name	string	The name of the modifier option.	Yes
deleted	boolean	True if the modifier option 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": "Extra",
        "deleted": true
    }
]

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/modifier-options/:modifierOptionId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/modifier-options/:modifierOptionId

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

Retrieves a single modifier option for the supplied location.

Response Payload Structure

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