Merran documentation API & integrations
Put the shopping away
POST
/api/list/put-away
const url = 'http://localhost:3000/api/list/put-away';const options = { method: 'POST', headers: { cookie: 'merran.session_token=<merran.session_token>', 'Content-Type': 'application/json' }, body: '{}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:3000/api/list/put-away \ --header 'Content-Type: application/json' \ --cookie merran.session_token=<merran.session_token> \ --data '{}'What’s checked off (on a list, or all of them) goes in the pantry: set aside for the meals it was bought for, in the fridge, freezer or cupboard, with a use-by guess for fresh food. Household things and what’s always on hand are cleared without going in. Everything bought goes in the purchase history. With an API key, it needs the list: write permission.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
list
A list’s id: only what’s checked off on it. Every list when left out.
string | null
Example
{}Responses
Section titled “Responses”Put away.
Media typeapplication/json
object
stored
required
Things now at home.
integer
cleared
required
Things cleared without going in: household things and what’s always on hand.
integer
Example
{ "stored": 12, "cleared": 2}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." } }}No such list.
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.