Jump to

• Request
• Response

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: string
  The ID of the requested location.

Query Parameters

• type(optional): string
  The type of location, either 'location' (default) or 'store'.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getLocation_response

Type: object

Show Source

• 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'.

{
    "properties":{
        "country":{
            "description":"The country of the location.",
            "type":"string"
        },
        "distance":{
            "description":"A session-scoped property that contains the distance when searching for location items. Not applicable.",
            "type":"number"
        },
        "endDate":{
            "description":"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.",
            "type":"string"
        },
        "city":{
            "description":"The city of the location.",
            "type":"string"
        },
        "latitude":{
            "description":"The latitude of the location.",
            "type":"number"
        },
        "postalCode":{
            "description":"The postal code of the location.",
            "type":"string"
        },
        "county":{
            "description":"The county of the location.",
            "type":"string"
        },
        "stateAddress":{
            "description":"The state of the location.",
            "type":"string"
        },
        "pickUp":{
            "description":"Indicates that the location allows customers to collect their items.",
            "type":"boolean"
        },
        "sites":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The site repositoryId associated with this location.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The site ID associated with this location.",
                        "type":"string"
                    }
                }
            }
        },
        "inventory":{
            "description":"Indicates that location has it's own inventory.",
            "type":"boolean"
        },
        "type":{
            "description":"The type of location, either 'location' or 'store'.",
            "type":"string"
        },
        "locationId":{
            "description":"The ID of the location. This ID will be generated if none is provided.",
            "type":"string"
        },
        "email":{
            "description":"The email address of the location.",
            "type":"string"
        },
        "longitude":{
            "description":"The longitude of the location.",
            "type":"number"
        },
        "hours":{
            "description":"The store opening hours. Only applicable to location type 'store'.",
            "type":"string"
        },
        "address3":{
            "description":"The third address field of the location.",
            "type":"string"
        },
        "address2":{
            "description":"The second address field of the location.",
            "type":"string"
        },
        "address1":{
            "description":"The first address field of the location.",
            "type":"string"
        },
        "externalLocationId":{
            "description":"An optional additional location ID, such as the merchant store ID. Use this if you have extra parameters for identifying your stores or locations.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"The phone number of the location.",
            "type":"string"
        },
        "siteGroups":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The site group ID associated with this location.",
                        "type":"string"
                    }
                }
            }
        },
        "repositoryId":{
            "description":"The ID of the location repository item.",
            "type":"string"
        },
        "name":{
            "description":"The name of the location.",
            "type":"string"
        },
        "faxNumber":{
            "description":"The fax number of the location.",
            "type":"string"
        },
        "startDate":{
            "description":"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.",
            "type":"string"
        }
    }
}

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

• Array of: object items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The site group ID associated with this location.",
                "type":"string"
            }
        }
    }
}

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

• Array of: object items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The site repositoryId associated with this location.",
                "type":"string"
            },
            "id":{
                "description":"The site ID associated with this location.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  The site group ID associated with this location.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The site group ID associated with this location.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The site ID associated with this location.
• repositoryId(optional): string
  The site repositoryId associated with this location.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The site repositoryId associated with this location.",
            "type":"string"
        },
        "id":{
            "description":"The site ID associated with this location.",
            "type":"string"
        }
    }
}

Example Response (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",
    "pickUp":false,
    "sites":[
        {
            "repositoryId":"siteUS",
            "id":"siteUS"
        },
        {
            "repositoryId":"siteCA",
            "id":"siteCA"
        }
    ],
    "inventory":false,
    "type":"store",
    "locationId":"CRSHome-GlenAllen187",
    "links":[
        {
            "rel":"self",
            "href":"https://www.example.com/ccadminui/v1/locations/CRSHome-GlenAllen187"
        }
    ],
    "email":"[e-mail]",
    "longitude":-77.5063697,
    "hours":"9:00am - 5:00pm",
    "address3":null,
    "address2":"Suite 101",
    "address1":"4870 Sadler Rd.",
    "externalLocationId":"187",
    "phoneNumber":"[phone]",
    "siteGroups":[
        {
            "repositoryId":"siteGroup1",
            "id":"siteUS"
        },
        {
            "repositoryId":"siteGroup2"
        }
    ],
    "repositoryId":"4000345",
    "name":"CRS Home - Glen Allen #187",
    "faxNumber":"[phone]",
    "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

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top