Product list
GET {{kroger-baseUrl}}/products?filter.term=<string>&filter.locationId=<string>&filter.productId=<string>&filter.brand=<string>&filter.fulfillment=<string>&filter.start=<string>&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 and aisle location, you must include the filter.locationId query parameters.
Note: seasonal products are returned but only have a price when available.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter.term | string | A search term to filter product results. As an example, you could input milk, bread, or salt. | |
filter.locationId | string | The locationId of the store you want results limited to. When using this filter, only products available at that location are returned. | |
filter.productId | string | The productId of the products(s) you want returned. For more than one item, the list must be comma-separated. When used, all other query parameters are ignored. | |
filter.brand | string | The brand name of the product(s) you want returned. When using this filter, only products by that brand are returned. Brand names are case-sensitive, and lists must be pipe-separated. | |
filter.fulfillment | string | The available fulfillment types of the product(s) you want returned. Fulfillment types are case-sensitive, and lists must be comma-separated. Must be one or more of the follow types: ais - Available In Store, csp - Curbside Pickup, dth - Delivery To Home, sth - Ship To Home | |
filter.start | string | The number of products you want to skip. | |
filter.limit | string | The number of products you want returned. |
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"}],"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"}],"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"}],"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"}],"upc":"\u003cstring\u003e"}],"meta":{"pagination":{"total":"\u003cnumber\u003e","start":"\u003cnumber\u003e","limit":"\u003cnumber\u003e"},"warnings":["\u003cstring\u003e","\u003cstring\u003e"]}}