getLocation

get

/ccstore/v1/locations/{id}

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

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getLocation_response
Type: object
Show Source
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: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "country":"USA",
    "distance":null,
    "endDate":null,
    "city":"Glen Allen",
    "postalCode":"23060",
    "latitude":37.6659833,
    "stateAddress":"VA",
    "county":null,
    "pickUp":false,
    "sites":[
    ],
    "inventory":false,
    "type":"store",
    "locationId":"GlenAllen187",
    "links":[
        {
            "rel":"self",
            "href":"/locations/GlenAllen187"
        }
    ],
    "email":"store187@example.com",
    "longitude":-77.5063697,
    "address3":null,
    "address2":"Suite 101",
    "address1":"4870 Sadler Rd.",
    "externalLocationId":"187",
    "phoneNumber":"(617) 386-1200",
    "siteGroups":[
    ],
    "name":"Glen Allen #187",
    "repositoryId":"GlenAllen187",
    "faxNumber":"(617) 386-1200"
}

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.| |51004|No location details found matching the given location id input.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top