GET
/
location
/
{locationNum}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

locationNum
number
required

Unique number to identify the location

Response

200 - application/json

This object contains location details

attributes
object

Location attribute object

id
string

Unique location identifier

locationNum
integer

Unique number to identify the location

name
string

Location name

isActive
boolean

true indicates location is active<br />false indicates location is inactive.

address
object

Location address details

type
string

Location type

createdAt
string

Date on which the location is created

updatedAt
string

Date on which the location is updated

operatingHours
object[]

Operating hours of the location

coordinates
object

coordinate details of the location in Geo Json format

services
object

JSON attributes on which locations are allowed to filter

Was this page helpful?

Create locationUpdate location by overriding existing details