Merran documentation API & integrations

What's bought every week

GET

/api/list/every-week

const url = 'http://localhost:3000/api/list/every-week';
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/list/every-week \
  --cookie merran.session_token=<merran.session_token>

Bought whatever’s planned (bananas, milk). Adding from the plan puts those not on the list on it. With an API key, it needs the list: read permission.

Authorizations

session
apiKey

Responses

200

The every-week items.

application/json

object

items

required

Array<object>

object

required

string

name

required

string

amount

required

string | null

aisle

required

string | null

Example

{
  "items": [
    {
      "id": "0199e8b0-5a10-7a01-8b00-000000000023",
      "name": "Bananas",
      "amount": "1 bunch",
      "aisle": "0199e8b0-5a10-7a01-8b00-000000000020"
    }
  ]
}

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