Locations
Get Location Info
Retrieves the basic information for a specific location, such as its name, address, contact details, logo, cover photo, and ordering capabilities.
GET
/
api
/
v1
/
locations
/
{locationSlug}
Authorizations
X-API-Key
string
headerrequiredPath Parameters
locationSlug
string
requiredThe location slug.
Response
200 - application/json
id
string
The location's unique ID.
locationSlug
string
The unique URL-friendly name of the location.
displayName
string
The display name of the location.
description
string
A description of the location.
coverPhotoUrl
string
URL of the location's background image.
logoUrl
string
URL of the location's logo image.
address
string
The location's address.
phoneNumber
string
The location's phone number.
emailAddress
string
The location's email address.
isOrderingPausedByMerchant
boolean
Indicates whether orders are paused by merchant
isOrderingAllowedBySubscription
boolean
Indicates whether ordering is currently allowed due to subscription
isOrderingAllowedByAdmin
boolean
Indicates whether ordering is currently allowed by platform
isScheduledOrderAllowed
boolean
Indicates whether scheduled orders are allowed or not
timezone
string
The location's timezone (e.g., 'America/Los_Angeles').