listLocations
get
/ccstore/v1/locations
List Locations. Retrieves and lists all the available locations using the given query options for paging and sorting.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The number of location items to return. The default is 10.
-
offset(optional): integer
Index of the first location item to return. The default is 0.
-
sort(optional): string
The location items sorting criteria. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |property|string|The property by which to sort the list of location items. The default is locationId.| |order|string|The sort order, either 'asc' (ascending) or 'desc' (decending). The default is 'asc'.|
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listLocations_response
Type:
Show Source
object
-
items(optional):
array items
The list of location items.
-
limit(optional):
integer
The number of location items to return.
-
offset(optional):
integer
Index of the first location item to return.
-
sort(optional):
array sort
The location items sorting criteria.
-
total(optional):
integer
The total number of location items. Deprecated.
-
totalResults(optional):
integer
The total number of location items.
Nested Schema : items
Type:
Show Source
object
-
address1(optional):
string
The first address field of the location.
-
address2(optional):
string
The second address field of the location.
-
address3(optional):
string
The third address field of the location.
-
city(optional):
string
The city of the location.
-
country(optional):
string
The country of the location.
-
county(optional):
string
The county of the location.
-
distance(optional):
number
A session-scoped property that contains the distance when searching for location items. Not applicable.
-
email(optional):
string
The email address of the location.
-
endDate(optional):
string
The end date for the location. This is used when performing a search for inventory available from a store during a specific date range. If the search contains a specific date range, only locations that have a date that are contained within that date range will be displayed.
-
externalLocationId(optional):
string
An optional additional location ID, such as the merchant store ID. Use this if you have extra parameters for identifying your stores or locations.
-
faxNumber(optional):
string
The fax number of the location.
-
hours(optional):
string
The store opening hours. Only applicable to location type 'store'.
-
inventory(optional):
boolean
Indicates that location has it's own inventory.
-
latitude(optional):
number
The latitude of the location.
-
locationId(optional):
string
The ID of the location. This ID will be generated if none is provided.
-
longitude(optional):
number
The longitude of the location.
-
name(optional):
string
The name of the location.
-
phoneNumber(optional):
string
The phone number of the location.
-
pickUp(optional):
boolean
Indicates that the location allows customers to collect their items.
-
postalCode(optional):
string
The postal code of the location.
-
repositoryId(optional):
string
The ID of the location repository item.
-
siteGroups(optional):
array siteGroups
List of site groups. A location can be constrained to a list of site groups. If no site group is defined, the location is available on all sites.
-
sites(optional):
array sites
List of sites. A location can be constrained to a list of sites. If no site is defined, the location is available on all sites.
-
startDate(optional):
string
The start date for the location. This is used when performing a search for inventory available from a store during a specific date range. If the search contains a specific date range, only locations that have a date that are contained within that date range will be displayed.
-
stateAddress(optional):
string
The state of the location.
-
type(optional):
string
The type of location, either 'location' or 'store'.
Nested Schema : siteGroups
Type:
array
List of site groups. A location can be constrained to a list of site groups. If no site group is defined, the location is available on all sites.
Show Source
Nested Schema : sites
Type:
array
List of sites. A location can be constrained to a list of sites. If no site is defined, the location is available on all sites.
Show Source
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The site group ID associated with this location.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The site ID associated with this location.
-
repositoryId(optional):
string
The site repositoryId associated with this location.
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Sort order: asc or desc.
-
property(optional):
string
The property by which to sort the list of location items. The default is locationId.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":1,
"links":[
{
"rel":"self",
"href":"https://www.example.com/ccadminui/v1/locations"
}
],
"sort":[
{
"property":"locationId",
"order":"asc"
}
],
"items":[
{
"country":"USA",
"distance":null,
"endDate":"2017-04-25T00:00:00.000Z",
"city":"Glen Allen",
"latitude":37.6659833,
"postalCode":"23060",
"county":"Henrico",
"stateAddress":"VA",
"pickUp":false,
"sites":[
{
"repositoryId":"siteUS",
"id":"siteUS"
},
{
"repositoryId":"siteCA",
"id":"siteCA"
}
],
"inventory":false,
"type":"store",
"locationId":"GlenAllen187",
"email":"store187@example.com",
"longitude":-77.5063697,
"hours":"9:00am - 5:00pm",
"address3":null,
"address2":"Suite 101",
"address1":"4870 Sadler Rd.",
"externalLocationId":"187",
"phoneNumber":"(617) 386-1200",
"siteGroups":[
{
"id":"siteGroup1"
},
{
"id":"siteGroup2"
}
],
"repositoryId":"4000345",
"name":"Glen Allen #187",
"faxNumber":"(617) 386-1200",
"startDate":"2016-04-25T00:00:00.000Z"
}
]
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code