Skip to content
merran
GitHubInstall

Merran documentation API & integrations

Receipts waiting for a look

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

Scanned, shared or sent to the assistant, and not added or discarded yet, newest first. Each is forgotten after a day. With an API key, it needs the pantry: read permission.

The receipts.

Media typeapplication/json
object
receipts
required
Array<object>
object
id
required
string
store
required
string | null
date
required

The day on it.

string | null
total
required
number | null
lines
required
Array<object>
object
id
required
string
text
required

As printed.

string
name
required

What it is, plainly.

string
amount
required
string | null
price
required
number | null
kind
required

Food goes in the pantry; household things and the rest don’t, unless they’re picked.

string
Allowed values: food household other
listItem
required

The shopping list item it was bought for, taken off the list when it’s added.

object
id
required
string
name
required
string
files
required

The receipt’s photos or PDF, to compare with.

Array<object>
object
url
required
string
mediaType
required
string
Allowed values: image/jpeg application/pdf
createdAt
required
string format: date-time

Example

{
"receipts": [
{
"id": "0199e8b0-5a10-7a01-8b00-00000000002e",
"store": "Walmart",
"date": "2026-10-14",
"total": 48.12,
"lines": [
{
"id": "0d1b5c2a9e44",
"text": "GV WHL MLK 1GAL",
"name": "whole milk",
"amount": "1 gal",
"price": 3.48,
"kind": "food",
"listItem": {
"id": "0199e8b0-5a10-7a01-8b00-00000000001d",
"name": "milk"
}
}
],
"files": [
{
"url": "/api/pantry/receipts/0199e8b0-5a10-7a01-8b00-00000000002e/files/0",
"mediaType": "image/jpeg"
}
],
"createdAt": "2026-10-15T18:30:00.000Z"
}
]
}

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.