Product list
GET {{kroger-baseUrl}}/products?filter.term=<string>&filter.locationId=<string>&filter.productId=<string>&filter.brand=<string>&filter.fulfillment=<string>&filter.start=<integer>&filter.limit=<integer>
Provides access to a list of products. If no query parameters are provided, a list of all products is returned. To return the product price, availability, and aisle location, you must include the filter.locationId
query parameter.
Note: seasonal products are returned but only have a price when available.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter.term | string | ||
filter.locationId | string | ||
filter.productId | string | ||
filter.brand | string | ||
filter.fulfillment | string | ||
filter.start | string | ||
filter.limit | string |
RESPONSES
status: OK
{"data":[{"productId":"\u003cstring\u003e","aisleLocations":[{"bayNumber":"\u003cstring\u003e","description":"\u003cstring\u003e","number":"\u003cstring\u003e","numberOfFacings":"\u003cstring\u003e","sequenceNumber":"\u003cstring\u003e","side":"\u003cstring\u003e","shelfNumber":"\u003cstring\u003e","shelfPositionInBay":"\u003cstring\u003e"},{"bayNumber":"\u003cstring\u003e","description":"\u003cstring\u003e","number":"\u003cstring\u003e","numberOfFacings":"\u003cstring\u003e","sequenceNumber":"\u003cstring\u003e","side":"\u003cstring\u003e","shelfNumber":"\u003cstring\u003e","shelfPositionInBay":"\u003cstring\u003e"}],"brand":"\u003cstring\u003e","categories":["\u003cstring\u003e","\u003cstring\u003e"],"countryOrigin":"\u003cstring\u003e","description":"\u003cstring\u003e","items":[[{"itemId":"\u003cstring\u003e","inventory":{"stockLevel":"\u003cstring\u003e"},"favorite":"\u003cboolean\u003e","fulfillment":{"curbside":"\u003cboolean\u003e","delivery":"\u003cboolean\u003e"},"price":{"regular":"\u003cnumber\u003e","promo":"\u003cnumber\u003e"},"size":"\u003cstring\u003e"},{"itemId":"\u003cstring\u003e","inventory":{"stockLevel":"\u003cstring\u003e"},"favorite":"\u003cboolean\u003e","fulfillment":{"curbside":"\u003cboolean\u003e","delivery":"\u003cboolean\u003e"},"price":{"regular":"\u003cnumber\u003e","promo":"\u003cnumber\u003e"},"size":"\u003cstring\u003e"}],[{"itemId":"\u003cstring\u003e","inventory":{"stockLevel":"\u003cstring\u003e"},"favorite":"\u003cboolean\u003e","fulfillment":{"curbside":"\u003cboolean\u003e","delivery":"\u003cboolean\u003e"},"price":{"regular":"\u003cnumber\u003e","promo":"\u003cnumber\u003e"},"size":"\u003cstring\u003e"},{"itemId":"\u003cstring\u003e","inventory":{"stockLevel":"\u003cstring\u003e"},"favorite":"\u003cboolean\u003e","fulfillment":{"curbside":"\u003cboolean\u003e","delivery":"\u003cboolean\u003e"},"price":{"regular":"\u003cnumber\u003e","promo":"\u003cnumber\u003e"},"size":"\u003cstring\u003e"}]],"itemInformation":{"depth":"\u003cstring\u003e","height":"\u003cstring\u003e","width":"\u003cstring\u003e"},"temperature":{"indicator":"\u003cstring\u003e","heatSensitive":"\u003cboolean\u003e"},"images":[{"type":"boolean","default":"\u003cboolean\u003e"},{"type":"boolean","default":"\u003cboolean\u003e"}],"taxonomies":[{"department":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"commodity":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"subCommodity":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"department":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"commodity":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"subCommodity":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"}}],"upc":"\u003cstring\u003e"},{"productId":"\u003cstring\u003e","aisleLocations":[{"bayNumber":"\u003cstring\u003e","description":"\u003cstring\u003e","number":"\u003cstring\u003e","numberOfFacings":"\u003cstring\u003e","sequenceNumber":"\u003cstring\u003e","side":"\u003cstring\u003e","shelfNumber":"\u003cstring\u003e","shelfPositionInBay":"\u003cstring\u003e"},{"bayNumber":"\u003cstring\u003e","description":"\u003cstring\u003e","number":"\u003cstring\u003e","numberOfFacings":"\u003cstring\u003e","sequenceNumber":"\u003cstring\u003e","side":"\u003cstring\u003e","shelfNumber":"\u003cstring\u003e","shelfPositionInBay":"\u003cstring\u003e"}],"brand":"\u003cstring\u003e","categories":["\u003cstring\u003e","\u003cstring\u003e"],"countryOrigin":"\u003cstring\u003e","description":"\u003cstring\u003e","items":[[{"itemId":"\u003cstring\u003e","inventory":{"stockLevel":"\u003cstring\u003e"},"favorite":"\u003cboolean\u003e","fulfillment":{"curbside":"\u003cboolean\u003e","delivery":"\u003cboolean\u003e"},"price":{"regular":"\u003cnumber\u003e","promo":"\u003cnumber\u003e"},"size":"\u003cstring\u003e"},{"itemId":"\u003cstring\u003e","inventory":{"stockLevel":"\u003cstring\u003e"},"favorite":"\u003cboolean\u003e","fulfillment":{"curbside":"\u003cboolean\u003e","delivery":"\u003cboolean\u003e"},"price":{"regular":"\u003cnumber\u003e","promo":"\u003cnumber\u003e"},"size":"\u003cstring\u003e"}],[{"itemId":"\u003cstring\u003e","inventory":{"stockLevel":"\u003cstring\u003e"},"favorite":"\u003cboolean\u003e","fulfillment":{"curbside":"\u003cboolean\u003e","delivery":"\u003cboolean\u003e"},"price":{"regular":"\u003cnumber\u003e","promo":"\u003cnumber\u003e"},"size":"\u003cstring\u003e"},{"itemId":"\u003cstring\u003e","inventory":{"stockLevel":"\u003cstring\u003e"},"favorite":"\u003cboolean\u003e","fulfillment":{"curbside":"\u003cboolean\u003e","delivery":"\u003cboolean\u003e"},"price":{"regular":"\u003cnumber\u003e","promo":"\u003cnumber\u003e"},"size":"\u003cstring\u003e"}]],"itemInformation":{"depth":"\u003cstring\u003e","height":"\u003cstring\u003e","width":"\u003cstring\u003e"},"temperature":{"indicator":"\u003cstring\u003e","heatSensitive":"\u003cboolean\u003e"},"images":[{"type":"boolean","default":"\u003cboolean\u003e"},{"type":"boolean","default":"\u003cboolean\u003e"}],"taxonomies":[{"department":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"commodity":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"subCommodity":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"}},{"department":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"commodity":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"subCommodity":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"}}],"upc":"\u003cstring\u003e"}],"meta":{}}