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.
Body
PARAM
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 | Curl curl -X 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>?filter.term=<string>&filter.locationId=<string>&filter.productId=<string>&filter.brand=<string>&filter.fulfillment=<string>&filter.start=<string>&filter.limit=<integer>' ENDPOINTS |