HomeGuidesAPI Reference
Log In
API Reference

Get Inventory

get
https://api.mealme.ai/details/inventory/v4
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
Defaults to c9f33d56-d138-4a49-9a4f-162f195c89b8

The ID of the store to retrieve inventory for.

string

The optional Subcategory ID, needed for some requests if the menu is too large.

boolean
Defaults to false

If pickup is true, pickup inventory and/or quote will be retrieved. If pickup is false, delivery inventory and/or quote will be retrieved.

boolean
Defaults to false

Whether to include the real-time delivery/pickup quote.

string
Defaults to first_available

The preferred quote for order fulfillment. Can be default, first_party, cheapest, fastest, first_available, cheapest_inventory, or cheapest_for_store.

boolean
Defaults to true

Whether to include customizations.

number
Defaults to 20

The maximum amount, in Dollars, that the user has specified they'd like to spend on an order. Used when quote_preference=cheapest.

number
Defaults to 37.7786357

The latitude of the user.

number
Defaults to -122.3918135

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

string
Defaults to 188

Street number of the user.

string
Defaults to King Street

Street name of the user.

string
Defaults to San Francisco

City of the user.

string
Defaults to CA

State abbreviation of the user.

string
Defaults to 94107

Zipcode of the user.

string
Defaults to US

Country of the user. Can be US or CA.

integer
Defaults to 300

The desired height to scale product images to. If supplied, then image_width will be ignored. The thumbnail_image property in the response will represent the scaled image URL, if supports_image_scaling=true.

integer
Defaults to 300

The desired width to scale product images to. If image_height is supplied, then image_width will be ignored. The thumbnail_image property in the response will represent the scaled image URL, if supports_image_scaling=true.

string

The ID of the menu to fetch. If supplied, the store_id and quote_preference parameters will be ignored.

boolean
Defaults to true

Whether to only retrieve currently available products.

number

The minimum timestamp for scheduled windows.

number

The maximum timestamp for scheduled windows.

boolean
Defaults to true

Whether to include real-time fees in the quote when include_quote is true.

boolean
Defaults to true

Whether to include the real-time menu. include_menu can only be false if include_quote is true.

boolean
Defaults to true

Whether store_id was retrieved from the new database. Note that if store_id was retrieved from a /store/search request made with use_new_db=true, use_new_db must also be true in this request.

integer
Defaults to 0

Specifies which page of products to retrieve. This parameter is required when querying grocery store products and must be an integer ≥ 0.

string
enum

The product property to sort by. This parameter is only applicable when querying grocery store products.

Allowed:
integer
enum

Specifies whether to sort results in ascending (1) or descending (-1) order. This parameter is only applicable when querying grocery store products.

Allowed:
Responses

Updated 12 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago