Merran documentation API & integrations

The Walmart cart to look over

GET

/api/stores/walmart/basket

const url = 'http://localhost:3000/api/stores/walmart/basket?items=0199e8b0-5a10-7a01-8b00-00000000001d%2C0199e8b0-5a10-7a01-8b00-00000000001e';
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/walmart/basket?items=0199e8b0-5a10-7a01-8b00-00000000001d%2C0199e8b0-5a10-7a01-8b00-00000000001e' \
  --cookie merran.session_token=<merran.session_token>

Experimental, when the server admin has turned Walmart on. Each thing left to get (the ones asked for, which Send has going to Walmart; or without them, everything left on every list) with its product, the household’s own pick or Merran’s, how many and what it cost when last seen; and what’s still to find at Walmart, which Merran’s browser extension looks for in the person’s own Walmart tab. Merran never reaches Walmart itself. With an API key, it needs the list: read permission.

Authorizations

session
apiKey

Parameters

Query Parameters

items

Just these things on the list, by id, separated by commas: the ones Send has going to this store. Without it, everything left on every list.

string

/^[0-9a-f-]{36}(,[0-9a-f-]{36}){0,299}$/i/

Example

0199e8b0-5a10-7a01-8b00-00000000001d,0199e8b0-5a10-7a01-8b00-00000000001e

Just these things on the list, by id, separated by commas: the ones Send has going to this store. Without it, everything left on every list.

Responses

200

The cart to look over.

application/json

object

store

required

Walmart.

string

cartUrl

required

Walmart’s cart, to check out.

string

sentAt

required

string | null format: date-time

lines

required

Array<object>

object

itemId

required

string

name

required

string

amount

required

string

product

required

Any of:

object
null

object

required

string

upc

required

string | null

name

required

string

brand

required

string | null

size

required

string | null

image

required

string | null

price

required

In the currency’s smallest unit: cents.

integer | null

salePrice

required

integer | null

saleEnds

required

The sale’s last day.

string | null

currency

required

string

aisle

required

string | null

inStock

required

boolean

url

required

string | null

suggested

required

Merran’s pick, not one the household chose.

boolean

packages

required

integer

sure

required

How many is worked out from the product’s size, not a guess.

boolean

sent

required

Sent to the cart last time.

boolean

sale

required

Its sale today, if it’s on one.

object

verdict

required

How good a sale is, against what the product usually costs: the lowest in a while, a normal sale, or barely off (under a tenth).

string

Allowed values: lowest sale small

usual

required

What it usually costs, in cents: its most common price over 90 days, else its regular price.

integer | null

toFind

required

Things without a product yet, one for each food, for the extension to look for at Walmart.

Array<object>

object

itemId

required

string

words

required

What to search Walmart for: the food as it’s bought.

string

Example

{
  "store": "Walmart",
  "cartUrl": "https://www.walmart.com/cart",
  "sentAt": null,
  "lines": [
    {
      "itemId": "0199e8b0-5a10-7a01-8b00-00000000001d",
      "name": "milk",
      "amount": "1 gallon",
      "product": {
        "id": "10450114",
        "upc": null,
        "name": "Great Value 2% Reduced Fat Milk, Gallon, 128 fl oz",
        "brand": "Great Value",
        "size": "128 fl oz",
        "image": "https://i5.walmartimages.com/seo/milk.jpeg",
        "price": 327,
        "salePrice": null,
        "saleEnds": null,
        "currency": "USD",
        "aisle": null,
        "inStock": true,
        "url": "https://www.walmart.com/ip/10450114"
      },
      "suggested": true,
      "packages": 1,
      "sure": true,
      "sent": false,
      "sale": null
    },
    {
      "itemId": "0199e8b0-5a10-7a01-8b00-00000000001e",
      "name": "eggs",
      "amount": "12",
      "product": null,
      "suggested": true,
      "packages": 1,
      "sure": true,
      "sent": false,
      "sale": null
    }
  ],
  "toFind": [
    {
      "itemId": "0199e8b0-5a10-7a01-8b00-00000000001e",
      "words": "eggs"
    }
  ]
}

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

422

Walmart isn’t turned on on this server.

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