Menu Items

GET /locations/:locationId/menu-items

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

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

Retrieves all menu items for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of menu item 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 menu item.	Yes
locationId	string	The unique ID for the location.
deleted	boolean	True if the menu item has been marked as deleted.	Yes
available	boolean	True if the menu item is marked as available at the location.
name	string	The name of the menu item.	Yes
openItem	boolean	True if the menu item is an "open item" (meaning it's name is overriden by the POS operator when placed on an order).	Yes
reportCategoryId	string	The unique ID of the report category that the menu item belongs to.	Yes
standardPriceAmount	string	The standard price (order type and pricing levels/events are not taken into consideration) of the menu item (not including priced subitems/modifiers). The value is a decimal number string representing US dollars. For example, $1.40 will be represented as "1.4".
plu	string	The plu ID for the menu item.	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 Payload

×
[
    {
        "id": "abc123",
        "locationId": "LocationX",
        "deleted": false,
        "available": true,
        "name": "Bottled Water",
        "openItem": false,
        "reportCategoryId": "abc1234",
        "standardPriceAmount": "1.4",
      	"plu": "12345"
    }
]

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/menu-items/:menuItemId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/menu-items/:menuItemId

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

Retrieves a single menu item for the supplied location.

Response Payload Structure

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