Location list
GET {{kroger-baseUrl}}/locations?filter.zipCode.near=<string>&filter.latLong.near=<string>&filter.lat.near=<string>&filter.lon.near=<string>&filter.radiusInMiles=10&filter.limit=10&filter.chain=<string>&filter.department=<string>
Provides access to a list of locations matching a given criteria. If the parameter filter.chain
is not provided, the results include all locations and chains owned by The Kroger Co.
Starting Point Required
You must include one of the following parameters as a starting point to narrow search results:-
filter.zipCode.near
-
filter.latLong.near
-
filter.lat.near
andfilter.lon.near
If you do not provide a starting point or provide more than one starting point, an error is returned. By default, the results are limited to 10 locations within a 10-mile radius of the provided starting point. If you would like to extend the search results, you can use the parameter
filter.radiusInMiles
to set a new mile radius or filter.limit
to set the number of results returned.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter.zipCode.near | string | ||
filter.latLong.near | string | ||
filter.lat.near | string | ||
filter.lon.near | string | ||
filter.radiusInMiles | number | ||
filter.limit | number | ||
filter.chain | string | ||
filter.department | string |
RESPONSES
status: OK
{"data":[{"address":{"addressLine1":"\u003cstring\u003e","addressLine2":"\u003cstring\u003e","city":"\u003cstring\u003e","county":"\u003cstring\u003e","state":"\u003cstring\u003e","zipCode":"\u003cstring\u003e"},"chain":"\u003cstring\u003e","phone":"\u003cstring\u003e","departments":[{"departmentId":"\u003cstring\u003e","name":"\u003cstring\u003e","phone":"\u003cstring\u003e","hours":{"Open24":"\u003cboolean\u003e","monday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"tuesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"wednesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"thursday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"friday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"saturday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"sunday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"}}},{"departmentId":"\u003cstring\u003e","name":"\u003cstring\u003e","phone":"\u003cstring\u003e","hours":{"Open24":"\u003cboolean\u003e","monday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"tuesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"wednesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"thursday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"friday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"saturday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"sunday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"}}}],"geolocation":{"latLng":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e"},"hours":{"Open24":"\u003cboolean\u003e","gmtOffset":"\u003cstring\u003e","timezone":"\u003cstring\u003e","friday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"monday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"saturday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"sunday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"thursday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"tuesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"wednesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"}},"locationId":"\u003cstring\u003e","storeNumber":"\u003cstring\u003e","divisionNumber":"\u003cstring\u003e","name":"\u003cstring\u003e"},{"address":{"addressLine1":"\u003cstring\u003e","addressLine2":"\u003cstring\u003e","city":"\u003cstring\u003e","county":"\u003cstring\u003e","state":"\u003cstring\u003e","zipCode":"\u003cstring\u003e"},"chain":"\u003cstring\u003e","phone":"\u003cstring\u003e","departments":[{"departmentId":"\u003cstring\u003e","name":"\u003cstring\u003e","phone":"\u003cstring\u003e","hours":{"Open24":"\u003cboolean\u003e","monday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"tuesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"wednesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"thursday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"friday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"saturday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"sunday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"}}},{"departmentId":"\u003cstring\u003e","name":"\u003cstring\u003e","phone":"\u003cstring\u003e","hours":{"Open24":"\u003cboolean\u003e","monday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"tuesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"wednesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"thursday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"friday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"saturday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"sunday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"}}}],"geolocation":{"latLng":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e"},"hours":{"Open24":"\u003cboolean\u003e","gmtOffset":"\u003cstring\u003e","timezone":"\u003cstring\u003e","friday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"monday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"saturday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"sunday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"thursday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"tuesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"},"wednesday":{"open":"\u003cstring\u003e","close":"\u003cstring\u003e","open24":"\u003cboolean\u003e"}},"locationId":"\u003cstring\u003e","name":"\u003cstring\u003e"}],"meta":{"pagination":{"total":"\u003cnumber\u003e","start":"\u003cnumber\u003e","limit":"\u003cnumber\u003e"},"warnings":["\u003cstring\u003e","\u003cstring\u003e"]}}