Stations
GET /locations/:locationId/stations
https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/stations
curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//stations' \
--header 'x-api-key;'
Retrieves all POS stations for the supplied location.
Response Payload Structure
The response body for a "200 OK" response will contain a JSON array of station objects. Each object in the array will be structured as follows:
Field Name | Field Type | Field Description |
---|---|---|
id | string | The unique ID for the station. |
locationId | string | The unique ID for the location. |
name | string | The name of the station. |
deleted | boolean | True if the station has been marked as deleted. |
Example Response
[
{
"id": "0zflp4wp0ngpbkplafgek4z1nm",
"locationId": "LocationX",
"name": "Server 1",
"deleted": false
}
]
Headers | |
---|---|
x-api-key | Your API Key |
Path Variables | |
---|---|
locationId | The unique ID for the station |
GET /locations/:locationId/stations/:stationId
https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/stations/:stationId
curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//stations/' \
--header 'x-api-key;'
Retrieves a single POS station for the supplied location.
Response Payload Structure
The response body for a "200 OK" response will contain a single JSON station 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 |
stationId | The unique ID for the station |
Updated over 2 years ago