Locations

GET /locations/:locationId

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

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

Retrieves basic information for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single location object structured as follows:

Field Name	Field Type	Field Description	Org Level Attribute*
id	string	The unique ID for the location.
organizationid	string	The unique ID for the organization that the location belongs to.	Yes
name	string	The name of the location.
deleted	boolean	True if the location has been marked as deleted.
fiscalendofdaytime	int64
spotonmerchantid	string

📘

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": "LocationXXXX",
    "organizationId": "9eir75uthr746rhnjk234dg50",
    "name": "Smoke's Burgers",
    "deleted": false,
    "fiscalendofdaytime": 10800000,
    "spotonmerchantid": "2jf74gse87s4g365hjghejdi6"
}

Headers
x-api-key	Your API Key

Path Variables
LocationID	The unique ID for the location