Logo
The Kroger Co.'s Public API Documentation

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 and filter.lon.near

If you do not provide a starting point or provide more than one starting point, an error warning 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.

 

Body PARAM

Key Datatype Required Description 
filter.zipCode.near
string The zip code you want to use as a starting point for results.
filter.latLong.near
string The latitude and longitude you want to use as a starting point for results.
filter.lat.near
string The latitude you want to use as a starting point for results.
filter.lon.near
string The longitude you want to use as a starting point for results.
filter.radiusInMiles
number The mile radius you want results limited to.
filter.limit
number The number of results you want returned.
filter.chain
string The chain name of the chain you want results limited to. When using this filter, only stores matching the provided chain name are returned.
filter.department
string The departmentId of the department you want results limited to. Lists must be comma-separated. When using this filter, only stores who have all of the departments provided are returned.



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "data": [ { "address": { "addressLine1": "<string>", "addressLine2": "<string>", "city": "<string>", "county": "<string>", "state": "<string>", "zipCode": "<string>" }, "chain": "<string>", "phone": "<string>", "departments": [ { "departmentId": "<string>", "name": "<string>", "phone": "<string>", "hours": { "Open24": "<boolean>", "monday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "tuesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "wednesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "thursday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "friday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "saturday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "sunday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" } } }, { "departmentId": "<string>", "name": "<string>", "phone": "<string>", "hours": { "Open24": "<boolean>", "monday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "tuesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "wednesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "thursday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "friday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "saturday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "sunday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" } } } ], "geolocation": { "latLng": "<string>", "latitude": "<number>", "longitude": "<number>" }, "hours": { "Open24": "<boolean>", "gmtOffset": "<string>", "timezone": "<string>", "friday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "monday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "saturday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "sunday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "thursday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "tuesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "wednesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" } }, "locationId": "<string>", "storeNumber": "<string>", "divisionNumber": "<string>", "name": "<string>" }, { "address": { "addressLine1": "<string>", "addressLine2": "<string>", "city": "<string>", "county": "<string>", "state": "<string>", "zipCode": "<string>" }, "chain": "<string>", "phone": "<string>", "departments": [ { "departmentId": "<string>", "name": "<string>", "phone": "<string>", "hours": { "Open24": "<boolean>", "monday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "tuesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "wednesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "thursday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "friday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "saturday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "sunday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" } } }, { "departmentId": "<string>", "name": "<string>", "phone": "<string>", "hours": { "Open24": "<boolean>", "monday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "tuesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "wednesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "thursday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "friday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "saturday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "sunday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" } } } ], "geolocation": { "latLng": "<string>", "latitude": "<number>", "longitude": "<number>" }, "hours": { "Open24": "<boolean>", "gmtOffset": "<string>", "timezone": "<string>", "friday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "monday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "saturday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "sunday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "thursday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "tuesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" }, "wednesday": { "open": "<string>", "close": "<string>", "open24": "<boolean>" } }, "locationId": "<string>", "storeNumber": "<string>", "divisionNumber": "<string>", "name": "<string>" } ], "meta": { "pagination": { "total": "<number>", "start": "<number>", "limit": "<number>" }, "warnings": [ "<string>", "<string>" ] } }



Curl
curl -X 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>?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>'

ENDPOINTS