Order Types

GET /locations/:locationId/order-types

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

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

Retrieves all order types for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of order type 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 order type.	Yes
locationId	string	The unique ID for the location.
name	string	The name of the order type.	Yes
deleted	boolean	True if the order type has been marked as deleted.	Yes
enabled	boolean	True if the order type is enabled at the location.
wtmId	int64	an integer that identifies this order type uniquely within an organization	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": "Dine In",
        "deleted": false,
        "enabled": true
      	"wtmId": 6543
    }
]

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/order-types/:orderTypeId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/order-types/:orderTypeId

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

Retrieves a single order type for the supplied location.

Response Payload Structure

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