Search For A Product

get

https://api.mealme.ai/search/product/v4

Use this API to search for products from over half a billion total products from grocery stores, electronic stores, etc. in the US and Canada.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query

string

The product search query. Required if upc_codes and product_id aren't provided.

product_id

string

If provided, query will be ignored, and this endpoint will search for all matching products close to the user's location within the maximum_miles radius. A matching product is one that perfectly matches the same brand (i.e. Safeway) and product (i.e. Almond Breeze Unsweetened Original Almondmilk). Note that product_id can retrieved from Get Inventory, Search For A Product, and Search For A Cart. Required if query and upc_codes aren't provided.

store_name

string

The store from which to search for products within.

menu_id

string

The ID of the menu from which to search for products within. The menu ID is provided by Get Inventory.

user_latitude

number

required

Defaults to 37.7786357

The latitude of the user.

user_longitude

number

required

Defaults to -122.3918135

The longitude of the user. In the US, this value is negative.

pickup

boolean

Defaults to false

If true, filter stores to only those that offer pickup. If false, filter to only stores with delivery.

upc_codes

string

Example: 66538783,031146250103. The comma-delimited list of UPC codes to search for. Takes precedence over the other ways you can search, query and product_id. Required if query and product_id aren't provided.

cuisine

string

The cuisine to filter products by.

user_street_num

string

Defaults to 188

Street number of the user. Required if fetch_quotes is true and pickup is false.

user_street_name

string

Defaults to King Street

Street name of the user. Required if fetch_quotes is true and pickup is false.

user_city

string

Defaults to San Francisco

City of the user. Required if fetch_quotes is true and pickup is false.

user_state

string

Defaults to CA

State abbreviation of the user. Required if fetch_quotes is true and pickup is false.

user_zipcode

string

Defaults to 94107

Zipcode of the user. Required if fetch_quotes is true and pickup is false.

user_country

string

Defaults to US

Country of the user. Can be US or CA. Required if fetch_quotes is true and pickup is false.

fetch_quotes

boolean

Defaults to false

Whether to fetch realtime delivery/pickup quotes. Note that this being true greatly increases response time. Note that if this is true and the query is also empty then store hours will not be in the response.

sort

string

Defaults to relevance

The sort type. Can be cheapest, fastest, rating, distance or the default relevance.

fuzzy_search

boolean

Defaults to false

Whether to perform a lenient search that returns relevant products that may not exactly match the query provided.

open

boolean

Defaults to false

Whether to return only open restaurants.

maximum_miles

number

Defaults to 1.5

ex: 1.5. The maximum distance allowed, in miles.

min_lat

number

The minimum latitude for a "Search In This Area".

max_lat

number

The maximum latitude for a "Search In This Area".

min_lon

number

The minimum longitude for a "Search In This Area".

max_lon

number

The maximum longitude for a "Search In This Area".

dollar_signs

integer

ex: 2 (which would signal $$). Cost for the average meal. This can represent 1 ($) for the cheapest stores or 4 ($$$$) for the most expensive stores.

minimum_rating

number

ex: 4.6. The minimum rating allowed.

sale

boolean

Defaults to false

Whether to search for products that are currently on sale.

search_in_category

string

The category of the menu to search for products within. The list of a menu's categories are provided by Get Inventory.

page

integer

ex: 0. The page to fetch

use_new_db

boolean

Defaults to true

Whether to perform the product search among a new database. Note that if use_new_db is true, use_new_db must also be true when making a request to Get Inventory or Get MealMe Store with any store _id returned from this request.

Responses

200Success

400Input Validation Error

401Missing Authorization

429Too Many Requests