REST API for Oracle Commerce Cloud 21C

getLocation

get

/ccagent/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, for example: store.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : getLocation_response

Type: object

Show Source

address1(optional): string

The first line in the address of the location.
address2(optional): string

The second line in the address of the location.
address3(optional): string

The third line in the address 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): string

The distance parameter.
email(optional): string

The email id parameter.
externalLocationId(optional): string

The merchant store id.
faxNumber(optional): string

The fax number of the location.
hours(optional): string

The store opening hours, for a store item descriptor.
inventory(optional): boolean

Indicates that location has it's own inventory.
latitude(optional): string

The slatitude of the location.
longitude(optional): string

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.
sites(optional): array sites

List of sites.
stateAddress(optional): string

The state address of the location.
type(optional): string

Representation of the location type (location or store).

{
    "properties":{
        "country":{
            "description":"The country of the location.",
            "type":"string"
        },
        "hours":{
            "description":"The store opening hours, for a store item descriptor.",
            "type":"string"
        },
        "address3":{
            "description":"The third line in the address of the location.",
            "type":"string"
        },
        "distance":{
            "description":"The distance parameter.",
            "type":"string"
        },
        "address2":{
            "description":"The second line in the address of the location.",
            "type":"string"
        },
        "city":{
            "description":"The city of the location.",
            "type":"string"
        },
        "address1":{
            "description":"The first line in the address of the location.",
            "type":"string"
        },
        "postalCode":{
            "description":"The postal code of the location.",
            "type":"string"
        },
        "latitude":{
            "description":"The slatitude of the location.",
            "type":"string"
        },
        "stateAddress":{
            "description":"The state address of the location.",
            "type":"string"
        },
        "county":{
            "description":"The county of the location.",
            "type":"string"
        },
        "pickUp":{
            "description":"Indicates that the location allows customers to collect their items.",
            "type":"boolean"
        },
        "sites":{
            "description":"List of sites.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The site repositoryId.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The site id.",
                        "type":"string"
                    }
                }
            }
        },
        "inventory":{
            "description":"Indicates that location has it's own inventory.",
            "type":"boolean"
        },
        "type":{
            "description":"Representation of the location type (location or store).",
            "type":"string"
        },
        "externalLocationId":{
            "description":"The merchant store id.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"The phone number of the location.",
            "type":"string"
        },
        "siteGroups":{
            "description":"List of site groups.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sites":{
                        "description":"List of sites.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"The site id.",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "id":{
                        "description":"The site group id.",
                        "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"
        },
        "email":{
            "description":"The email id parameter.",
            "type":"string"
        },
        "longitude":{
            "description":"The longitude of the location.",
            "type":"string"
        }
    }
}

Nested Schema : siteGroups

Type: array

List of site groups.

Show Source

Array of: object items

{
    "description":"List of site groups.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sites":{
                "description":"List of sites.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"The site id.",
                            "type":"string"
                        }
                    }
                }
            },
            "id":{
                "description":"The site group id.",
                "type":"string"
            }
        }
    }
}

Nested Schema : sites

Type: array

List of sites.

Show Source

Array of: object items

{
    "description":"List of sites.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The site repositoryId.",
                "type":"string"
            },
            "id":{
                "description":"The site id.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

id(optional): string

The site group id.
sites(optional): array sites

List of sites.

{
    "type":"object",
    "properties":{
        "sites":{
            "description":"List of sites.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The site id.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"The site group id.",
            "type":"string"
        }
    }
}

Nested Schema : sites

Type: array

List of sites.

Show Source

Array of: object items

{
    "description":"List of sites.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The site id.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

id(optional): string

The site id.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The site id.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

id(optional): string

The site id.
repositoryId(optional): string

The site repositoryId.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The site repositoryId.",
            "type":"string"
        },
        "id":{
            "description":"The site id.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "country":"USA",
    "address3":null,
    "distance":null,
    "address2":"Suite 101",
    "endDate":null,
    "city":"Glen Allen",
    "address1":"4870 Sadler Rd.",
    "postalCode":"23060",
    "latitude":37.6659833,
    "stateAddress":"VA",
    "county":null,
    "pickUp":false,
    "sites":[
    ],
    "inventory":false,
    "type":"store",
    "externalLocationId":"187",
    "phoneNumber":"(617) 386-1200",
    "locationId":"GlenAllen187",
    "name":"Glen Allen #187",
    "repositoryId":"GlenAllen187",
    "faxNumber":"(617) 386-1200",
    "links":[
        {
            "rel":"self",
            "href":"https://www.example.com/ccagent/v1/locations/GlenAllen187"
        }
    ],
    "email":"store187@example.com",
    "longitude":-77.5063697
}

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

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"
        }
    }
}