The Kroger Co.'s Public API Documentation
Product details
GET {{kroger-baseUrl}}/products/:id?filter.locationId=<string>
Provides access to the details of a specific product by either using the productId or UPC. To return the product price and aisle location, you must include the filter.locationId query parameters.
Body
PARAM
| Key | Datatype | Required | Description |
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. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"data": {
"productId": "<string>",
"aisleLocations": [
{
"bayNumber": "<string>",
"description": "<string>",
"number": "<string>",
"numberOfFacings": "<string>",
"sequenceNumber": "<string>",
"side": "<string>",
"shelfNumber": "<string>",
"shelfPositionInBay": "<string>"
},
{
"bayNumber": "<string>",
"description": "<string>",
"number": "<string>",
"numberOfFacings": "<string>",
"sequenceNumber": "<string>",
"side": "<string>",
"shelfNumber": "<string>",
"shelfPositionInBay": "<string>"
}
],
"brand": "<string>",
"categories": [
"<string>",
"<string>"
],
"countryOrigin": "<string>",
"description": "<string>",
"items": [
{
"itemId": "<string>",
"inventory": {
"stockLevel": "<string>"
},
"favorite": "<boolean>",
"fulfillment": {
"curbside": "<boolean>",
"delivery": "<boolean>"
},
"price": {
"regular": "<number>",
"promo": "<number>"
},
"size": "<string>"
}
],
"itemInformation": {
"depth": "<string>",
"height": "<string>",
"width": "<string>"
},
"temperature": {
"indicator": "<string>",
"heatSensitive": "<boolean>"
},
"images": [
{
"type": "boolean",
"default": "<boolean>"
},
{
"type": "boolean",
"default": "<boolean>"
}
],
"upc": "<string>"
},
"meta": {
"pagination": {
"total": "<number>",
"start": "<number>",
"limit": "<number>"
},
"warnings": [
"<string>",
"<string>"
]
}
} |
Curl
curl -X GET 'kroger-baseUrl/products/:id?filter.locationId=<string>?filter.locationId=<string>'