REST API for Oracle Commerce Cloud December 2017

listLocations

get

/ccadmin/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: Type: integer

The number of location items to return. The default is 10.
offset: Type: integer

Index of the first location item to return. The default is 0.
sort: Type: 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.

Body

Root Schema : listLocations_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of location items.
limit: Type: integer

The number of location items to return.
offset: Type: integer

Index of the first location item to return.
sort: Type: array sort

Additional Properties Allowed:

The location items sorting criteria.
total: Type: integer

The total number of location items. Deprecated.
totalResults: Type: integer

The total number of location items.

Nested Schema : items

Type: array

The list of location items.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sort

Type: array

The location items sorting criteria.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

address1: Type: string

The first address field of the location.
address2: Type: string

The second address field of the location.
address3: Type: string

The third address field of the location.
city: Type: string

The city of the location.
country: Type: string

The country of the location.
county: Type: string

The county of the location.
distance: Type: number

A session-scoped property that contains the distance when searching for location items. Not applicable.
email: Type: string

The email address of the location.
endDate: Type: 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: Type: 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: Type: string

The fax number of the location.
hours: Type: string

The store opening hours. Only applicable to location type 'store'.
latitude: Type: number

The latitude of the location.
locationId: Type: string

The ID of the location. This ID will be generated if none is provided.
longitude: Type: number

The longitude of the location.
name: Type: string

The name of the location.
phoneNumber: Type: string

The phone number of the location.
postalCode: Type: string

The postal code of the location.
repositoryId: Type: string

The ID of the location repository item.
siteGroups: Type: array siteGroups

Additional Properties Allowed:

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: Type: array sites

Additional Properties Allowed:

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: Type: 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: Type: string

The state of the location.
type: Type: 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.

Items

Type: object items

Additional Properties Allowed:

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.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

id: Type: string

The site group ID associated with this location.

Nested Schema : items

Type: object

Properties

id: Type: string

The site ID associated with this location.

Nested Schema : items

Type: object

Properties

order: Type: string

Sort order: asc or desc.
property: Type: string

The property by which to sort the list of location items. The default is locationId.

Example 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",
            "hours":"9:00am - 5:00pm",
            "distance":null,
            "address3":null,
            "endDate":"2017-04-25T00:00:00.000Z",
            "address2":"Suite 101",
            "city":"Glen Allen",
            "address1":"4870 Sadler Rd.",
            "latitude":37.6659833,
            "postalCode":"23060",
            "county":"Henrico",
            "stateAddress":"VA",
            "sites":[
                {
                    "id":"siteUS"
                },
                {
                    "id":"siteCA"
                }
            ],
            "type":"store",
            "externalLocationId":"187",
            "phoneNumber":"(617) 386-1200",
            "siteGroups":[
                {
                    "id":"siteGroup1"
                },
                {
                    "id":"siteGroup2"
                }
            ],
            "locationId":"CRSHome-GlenAllen187",
            "repositoryId":"4000345",
            "name":"CRS Home - Glen Allen #187",
            "faxNumber":"(617) 386-1200",
            "startDate":"2016-04-25T00:00:00.000Z",
            "email":"store187@example.com",
            "longitude":-77.5063697
        }
    ]
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "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",
    "hours": "9:00am - 5:00pm",
    "distance": null,
    "address3": null,
    "endDate": "2017-04-25T00:00:00.000Z",
    "address2": "Suite 101",
    "city": "Glen Allen",
    "address1": "4870 Sadler Rd.",
    "latitude": 37.6659833,
    "postalCode": "23060",
    "county": "Henrico",
    "stateAddress": "VA",
    "sites": [
      {"id": "siteUS"},
      {"id": "siteCA"}
    ],
    "type": "store",
    "externalLocationId": "187",
    "phoneNumber": "(617) 386-1200",
    "siteGroups": [
      {"id": "siteGroup1"},
      {"id": "siteGroup2"}
    ],
    "locationId": "CRSHome-GlenAllen187",
    "repositoryId": "4000345",
    "name": "CRS Home - Glen Allen #187",
    "faxNumber": "(617) 386-1200",
    "startDate": "2016-04-25T00:00:00.000Z",
    "email": "store187@example.com",
    "longitude": -77.5063697
  }]
}