Merran documentation API & integrations

A receipt waiting for a look

GET

/api/pantry/receipts/{receiptId}

const url = 'http://localhost:3000/api/pantry/receipts/0199e8b0-5a10-7a01-8b00-00000000002e';
const options = {
  method: 'GET',
  headers: {cookie: 'merran.session_token=<merran.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/pantry/receipts/0199e8b0-5a10-7a01-8b00-00000000002e \
  --cookie merran.session_token=<merran.session_token>

One scanned, shared or sent to the assistant, and not added or discarded yet. With an API key, it needs the pantry: read permission.

Authorizations

session
apiKey

Parameters

Path Parameters

receiptId

required

string

Example

0199e8b0-5a10-7a01-8b00-00000000002e

Responses

200

The receipt.

application/json

object

required

string

store

required

string | null

date

required

The day on it.

string | null

total

required

number | null

lines

required

Array<object>

object

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

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

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

401

Not signed in.

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

403

Not allowed.

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

404

No such receipt waiting: added, discarded, or a day old.

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