Get all locations

Retrieves a paginated list of all locations

Authorizations

Authorization

string

header

required

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

locationSearchModel

object

Show child attributes

locationSearchModel.locationNums

string

To query location based on a single or multiple location numbers. For multiple location numbers, add comma separated values.

Example:

"13,12,15"

locationSearchModel.locationTypes

string

To query location based on single or multiple location types. For multiple location types, add comma separated values.

Example:

"warehouse, pickup"

paginationModel

object

Pagination object represents the process of separating data into different pages

Show child attributes

paginationModel.total

integer

Total number of location records

Example:

1

paginationModel.limit

integer

Number of records returned on a single page

Required range: x >= 1

Example:

1

paginationModel.offset

integer

Number of records skipped before selecting the records, default is zero

Required range: x >= 1

Example:

0

Response

200

application/json

Success

Paginated location details

locations

object[]

This object contains location details

Show child attributes

locations.attributes

object

Location attribute object

Example:

{ "isReturns": true }

locations.id

string

Unique location identifier

Example:

"622fae9a065d9e62a4029f79"

locations.locationNum

integer

Unique number to identify the location

Example:

13

locations.name

string

Location name

Example:

"CA"

locations.isActive

boolean

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

Example:

true

locations.address

object

Location address details

Show child attributes

locations.address.addressLine1

string

Address line 1

Example:

"2800 Ashcraft Court"

locations.address.addressLine2

string

Address line 2

Example:

"Fairview road"

locations.address.addressLine3

string

Address line 3

Example:

"N 9 1/2 street"

locations.address.addressLine4

string

Address line 4

Example:

"Coronado school"

locations.address.city

string

city

Example:

"Coronado"

locations.address.state

string

State name the location belongs to

Example:

"California"

locations.address.country

string

Country name of the location

Example:

"USA"

locations.address.postalCode

string

Postal code

Example:

92118

locations.address.type

string

Address type

Example:

"2800 Ashcraft Court"

locations.address.contact

object[]

Contact list

Location contact details

Show child attributes

locations.address.contact.type

string

Contact type

Example:

"Residence"

locations.address.contact.email

string

Email address of the location

Example:

"[e-mail]"

locations.address.contact.phone

object[]

Phone list

Phone details

Show child attributes

locations.address.contact.phone.number

string

Example:

"555-555-5555"

locations.address.contact.phone.type

string

Example:

"mobile"

locations.address.contact.name

object

Name object contains full name of the individual to contact, who reside in the location

Show child attributes

locations.address.contact.name.first

string

First name

Example:

"John"

locations.address.contact.name.middle

string

Middle name

Example:

"Mark"

locations.address.contact.name.last

string

Last name

Example:

"Doe"

locations.type

string

Location type

Example:

"warehouse"

locations.createdAt

string

Date on which the location is created

locations.updatedAt

string

Date on which the location is updated

locations.operatingHours

object[]

Operating hours of the location

Operating hours of the location

Show child attributes

locations.operatingHours.day

string

Day of the week

Example:

"Monday"

locations.operatingHours.hours

object[]

Show child attributes

locations.operatingHours.hours.open

string

Location opening time

Example:

"10:00"

locations.operatingHours.hours.close

string

Location closing time

Example:

"16:00"

locations.operatingHours.hours.type

enum<string>

operating type

Available options:

OPEN,

PICK_UP

locations.coordinates

object

coordinate details of the location in Geo Json format

Show child attributes

locations.coordinates.type

string

Coordinate type

Example:

"Point"

locations.coordinates.coordinates

number[]

Coordinate list, x and y coordinates in degree

locations.services

object

JSON attributes on which locations are allowed to filter

Example:

{ "isCurbsidePickUp": false }

pagination

object

Pagination object represents the process of separating data into different pages

Show child attributes

pagination.total

integer

Total number of location records

Example:

1

pagination.limit

integer

Number of records returned on a single page

Required range: x >= 1

Example:

1

pagination.offset

integer

Number of records skipped before selecting the records, default is zero

Required range: x >= 1

Example:

0