1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Locations

getLocation

get

/ccadmin/v1/locations/{id}

Get Location. Retrieves the location details for a given location ID.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the requested location.
Query Parameters
type
Type: string
The type of location, either 'location' (default) or 'store'.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getLocation_response
Nested Schema : siteGroups
Type: array
List of site groups.
Nested Schema : sites
Type: array
List of sites.
Nested Schema : items
Type: object
Nested Schema : sites
Type: array
List of sites.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "country":"USA",
    "distance":null,
    "endDate":"2017-04-25T00:00:00.000Z",
    "city":"Glen Allen",
    "latitude":37.6659833,
    "postalCode":"23060",
    "county":"Henrico",
    "stateAddress":"VA",
    "sites":[
        {
            "repositoryId":"siteUS"
        },
        {
            "repositoryId":"siteCA"
        }
    ],
    "type":"store",
    "locationId":"CRSHome-GlenAllen187",
    "links":[
        {
            "rel":"self",
            "href":"https://www.example.com/ccadminui/v1/locations/CRSHome-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":[
        {
            "repositoryId":"siteGroup1"
        },
        {
            "repositoryId":"siteGroup2"
        }
    ],
    "repositoryId":"4000345",
    "name":"CRS Home - Glen Allen #187",
    "faxNumber":"(617) 386-1200",
    "startDate":"2016-04-25T00:00:00.000Z"
}
Default Response
The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |51003|The location id input is invalid.| |51002|An internal error occurred while processing the request to get location details for the given location ID.| |51005|Invalid location type.| |51004|No location details found matching the given location id input.|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "country": "USA",
  "distance": null,
  "endDate": "2017-04-25T00:00:00.000Z",
  "city": "Glen Allen",
  "latitude": 37.6659833,
  "postalCode": "23060",
  "county": "Henrico",
  "stateAddress": "VA",
  "sites": [
    {"repositoryId": "siteUS"},
    {"repositoryId": "siteCA"}
  ],
  "type": "store",
  "locationId": "CRSHome-GlenAllen187",
  "links": [{
    "rel": "self",
    "href": "https://www.example.com/ccadminui/v1/locations/CRSHome-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": [
    {"repositoryId": "siteGroup1"},
    {"repositoryId": "siteGroup2"}
  ],
  "repositoryId": "4000345",
  "name": "CRS Home - Glen Allen #187",
  "faxNumber": "(617) 386-1200",
  "startDate": "2016-04-25T00:00:00.000Z"
}