Skip to content
merran
GitHubInstall

Merran documentation API & integrations

The stores the household shops at

GET
/api/stores/yours
curl --request GET \
--url http://localhost:3000/api/stores/yours \
--cookie merran.session_token=<merran.session_token>

For Find on the list: its Kroger store when it has one and Walmart when the server has it on, which Merran can find products at and send to, then the stores it picked in Settings (stores.yours), whose sites can be searched. With an API key, it needs the list: read permission.

The household’s stores.

Media typeapplication/json
object
stores
required
Array<object>
object
key
required

The store’s key: “kroger”.

string
name
required

As the household knows it: Fry’s.

string
connected
required

Merran can find its products and send to its cart: the household’s Kroger store, and Walmart when the server has it on.

boolean
searchable
required

Its site can be searched, in the household’s country.

boolean

Example

{
"stores": [
{
"key": "kroger",
"name": "Fry's",
"connected": true,
"searchable": true
},
{
"key": "costco",
"name": "Costco",
"connected": false,
"searchable": true
}
]
}

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."
}
}
}

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