Merran documentation API & integrations

Where each thing on a list can go

GET

/api/stores/send-plan

const url = 'http://localhost:3000/api/stores/send-plan?list=0199e8b0-5a10-7a01-8b00-00000000001c';
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/stores/send-plan?list=0199e8b0-5a10-7a01-8b00-00000000001c' \
  --cookie merran.session_token=<merran.session_token>

For Send: the stores Merran can send to, and each thing left on the list with the stores the household picked a product at for it, newest first, which is where it goes (asking when there’s more than one), and where it’s been sent already. Each store’s part is then reviewed and sent with its basket’s items. With an API key, it needs the list: read permission.

Authorizations

session
apiKey

Parameters

Query Parameters

list

required

The list being sent: the one the person’s looking at.

string format: uuid

Example

0199e8b0-5a10-7a01-8b00-00000000001c

The list being sent: the one the person’s looking at.

Responses

200

Where each thing can go.

application/json

object

stores

required

The stores Merran can send to.

Array<object>

object

key

required

string

name

required

string

items

required

Array<object>

object

itemId

required

string

name

required

string

amount

required

string | null

picked

required

The stores the household picked a product at for its food (someone picked it, or it was sent there before; Merran’s own picks don’t count), newest first.

Array<string>

sent

required

The stores it’s been sent to while it’s on the list.

Array<string>

Example

{
  "stores": [
    {
      "key": "kroger",
      "name": "Fry's"
    },
    {
      "key": "walmart",
      "name": "Walmart"
    }
  ],
  "items": [
    {
      "itemId": "0199e8b0-5a10-7a01-8b00-00000000001d",
      "name": "milk",
      "amount": "1 gallon",
      "picked": [
        "walmart",
        "kroger"
      ],
      "sent": []
    },
    {
      "itemId": "0199e8b0-5a10-7a01-8b00-00000000001e",
      "name": "eggs",
      "amount": "12",
      "picked": [],
      "sent": []
    }
  ]
}

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

There’s no such list.

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