Skip to content
merran
GitHubInstall

Merran documentation API & integrations

Search the household's Kroger store

GET
/api/stores/kroger/search
curl --request GET \
--url 'http://localhost:3000/api/stores/kroger/search?q=milk' \
--cookie merran.session_token=<merran.session_token>

Up to twenty products, with today’s prices, to pick another. With an API key, it needs the list: read permission.

q
required
string
>= 2 characters <= 100 characters

Example

milk

What the store has.

Media typeapplication/json
object
products
required
Array<object>
object
id
required
string
upc
required
string | null
name
required
string
brand
required
string | null
size
required
string | null
image
required
string | null
price
required

In the currency’s smallest unit: cents.

integer | null
salePrice
required
integer | null
saleEnds
required

The sale’s last day.

string | null
currency
required
string
aisle
required
string | null
inStock
required
boolean
url
required
string | null

Example

{
"products": [
{
"id": "0001111041700",
"upc": "0001111041700",
"name": "Kroger 2% Reduced Fat Milk",
"brand": "Kroger",
"size": "1 gal",
"image": "https://www.kroger.com/product/images/medium/front/0001111041700",
"price": 349,
"salePrice": 299,
"saleEnds": "2026-10-21",
"currency": "USD",
"aisle": "Dairy",
"inStock": true,
"url": "https://www.frysfood.com/p/milk/0001111041700"
}
]
}

Not signed in.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

Not allowed.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

Kroger isn’t set up, or the household has no store.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.