The Products API allows you to search the Kroger product catalog.
The Public Products API has a 10,000 call per day rate limit.
For all Public APIs, we enforce the rate limit by the number of calls the client makes to the endpoint, not individual API operations. This means you can distribute the 10,000 calls across all API operations using the /products endpoint as you see fit.
The Product Search operation supports pagination with a default value of 10 results per page. Using the following parameters, you can extend and skip results in the response:
filter.limit
- Sets a limit on the number of products returned.filter.start
- Sets a number of results to skip in the response.
Note: Since searching by a term acts as a fuzzy search, the order of the results can change with each new request.
The Products API supports the following operations:
Name | Method | Description |
---|---|---|
Product search | GET | Allows you to find products by passing in either a search term or product Id. |
Product details | GET | Returns product details for a specific product. |
To return the following data from the /products endpoint, you must include a locationId in the request. All operations for the products endpoint accept the filter.locationId query parameter.
Returns the following price objects:
price - Includes both the regular price of the item and the promo price of the item. nationalPrice - Includes both the regular national price of the item and the national promo price of the item.
Note: Seasonal products only return a price when available. Some items may not have a national prices available.
Returns the following boolean objects to indicate an item's fulfillment availability:
instore - The item is sold in store at the given location. shiptohome - The item is available to be shipped to home. delivery - The item is available for delivery from the given location. curbside - The item is available for curbside pickup from the given location.
Note: The instore fulfillment type only indicated that the item is sold by the given location, not that it is in stock.
Returns the aisle locations of the item for the given location.
Returns the stockLevel of the item. This property is omitted when unavailable:
HIGH - The stock level is high. LOW - The stock level is low. TEMPORARILY_OUT_OF_STOCK - The item is temporarily out of stock.
curl -X GET \ 'https://api.kroger.com/v1/products?filter.brand={{BRAND}}&filter.term={{TERM}}&filter.locationId={{LOCATION_ID}}' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {{TOKEN}}'
{ "data": [ { "productId": "0001111041700", "productPageURI": "/p/kroger-2-reduced-fat-milk/0001111041700?cid=dis.api.tpi_products-api_20240521_b:all_c:p_t:", "aisleLocations": [ { "bayNumber": "13", "description": "Aisle 35", "number": "35", "numberOfFacings": "5", "sequenceNumber": "3", "side": "L", "shelfNumber": "2", "shelfPositionInBay": "1" } ], "brand": "Kroger", "categories": ["Dairy"], "countryOrigin": "United States", "description": "Kroger 2% Reduced Fat Milk", "items": [ { "itemId": "0001111041700", "inventory": { "stockLevel": "HIGH" }, "favorite": true, "fulfillment": { "curbside": true, "delivery": true, "instore": true, "shiptohome": true }, "price": { "regular": 1.99, "promo": 1.59, "regularPerUnitEstimate": 1.99, "promoPerUnitEstimate": 1.59 }, "nationalPrice": { "regular": 1.99, "promo": 1.59, "regularPerUnitEstimate": 1.99, "promoPerUnitEstimate": 1.59 }, "size": "1 gal", "soldBy": "unit" } ], "itemInformation": { "depth": "3.5", "height": "2.0", "width": "4.75" }, "temperature": { "indicator": "Refrigerated", "heatSensitive": true }, "images": [ { "id": "string", "perspective": "front", "default": true, "sizes": [ { "id": "7df2d0a3-8349-44d4-9512-1dab89e675a9", "size": "medium", "url": "https://www.kroger.com/product/images/medium/front/0001111041700" } ] } ], "upc": "0001111041700" } ], "meta": {} }
curl -X GET \ 'https://api.kroger.com/v1/products/{{ID}}?filter.locationId={{LOCATION_ID}}' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {{TOKEN}}'
{ "data": { "productId": "0001111041700", "productPageURI": "/p/kroger-2-reduced-fat-milk/0001111041700?cid=dis.api.tpi_products-api_20240521_b:all_c:p_t:", "aisleLocations": [ { "bayNumber": "13", "description": "Aisle 35", "number": "35", "numberOfFacings": "5", "sequenceNumber": "3", "side": "L", "shelfNumber": "2", "shelfPositionInBay": "1" } ], "brand": "Kroger", "categories": ["Dairy"], "countryOrigin": "United States", "description": "Kroger 2% Reduced Fat Milk", "items": [ { "itemId": "0001111041700", "inventory": { "stockLevel": "HIGH" }, "favorite": true, "fulfillment": { "curbside": true, "delivery": true, "instore": true, "shiptohome": true }, "price": { "regular": 1.99, "promo": 1.59, "regularPerUnitEstimate": 1.99, "promoPerUnitEstimate": 1.59 }, "nationalPrice": { "regular": 1.99, "promo": 1.59, "regularPerUnitEstimate": 1.99, "promoPerUnitEstimate": 1.59 }, "size": "1 gal", "soldBy": "unit" } ], "itemInformation": { "depth": "3.5", "height": "2.0", "width": "4.75" }, "temperature": { "indicator": "Refrigerated", "heatSensitive": true }, "images": [ { "id": "string", "perspective": "front", "default": true, "sizes": [ { "id": "7df2d0a3-8349-44d4-9512-1dab89e675a9", "size": "medium", "url": "https://www.kroger.com/product/images/medium/front/0001111041700" } ] } ], "upc": "0001111041700" }, "meta": {} }