Merran documentation API & integrations
Change something at home
PATCH
/api/pantry/items/{itemId}
const url = 'http://localhost:3000/api/pantry/items/0199e8b0-5a10-7a01-8b00-000000000026';const options = { method: 'PATCH', headers: { cookie: 'merran.session_token=<merran.session_token>', 'Content-Type': 'application/json' }, body: '{"storedIn":"freezer"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url http://localhost:3000/api/pantry/items/0199e8b0-5a10-7a01-8b00-000000000026 \ --header 'Content-Type: application/json' \ --cookie merran.session_token=<merran.session_token> \ --data '{ "storedIn": "freezer" }'Rename it, change how much, where it’s kept, its use-by date or its aisle. Moving it to the freezer takes its use-by date off, unless one’s given. With an API key, it needs the pantry: write permission.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”itemId
required
string
Example
0199e8b0-5a10-7a01-8b00-000000000026Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
string
amount
“2 lb”, “half a bag”, or empty for just “have it”.
string
storedIn
Where it’s kept.
string | null
useBy
string | null
Example
2026-10-20aisle
string | null
Example
{ "storedIn": "freezer"}Responses
Section titled “Responses”Changed.
Media typeapplication/json
object
id
required
string
name
required
string
amount
required
How much, as it shows: “2 lb”, “half a bag”, or empty for just “have it”.
string
quantity
required
number | null
unit
required
string | null
amountText
required
string | null
storedIn
required
Where it’s kept.
string | null
aisle
required
string | null
useBy
required
string | null
meals
required
The planned meals it’s set aside for.
Array<object>
object
id
required
string
name
required
string
date
required
string
status
required
string
useSoon
required
createdAt
required
string format: date-time
Example
{ "id": "0199e8b0-5a10-7a01-8b00-000000000026", "name": "chicken thighs", "amount": "2 lb", "quantity": 2, "unit": "pound", "amountText": null, "storedIn": "fridge", "aisle": "0199e8b0-5a10-7a01-8b00-000000000021", "useBy": "2026-10-18", "meals": [ { "id": "0199e8b0-5a10-7a01-8b00-00000000001b", "name": "Lemon Chicken", "date": "2026-10-17", "status": "planned" } ], "useSoon": { "kind": "soon", "date": "2026-10-18" }, "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." } }}Not in the pantry, or no such aisle.
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.