Full Example URL

Parameters

All parameter keys should be lowercase; parameter values should all be UTF-8 and URL-encoded.

Parameter Name

Type

Description

Required Parameters

address

String

The address where the user is. Acceptable formats include ‘Address, City, State’ and ‘Address, Zip’. We’ll validate the address for you.

latitude

String

The latitude of the search location. Only required if not sending an address.

longitude

String

The longitude of the search location. Only required if not sending an address.

order_type

string

Set the order type to either delivery or pickup.

order_time

string

Time of order. Set to ASAP for as soon as possible on demand delivery. Or, set it for a future order time. Make sure to include the timezone information otherwise it will to default UTC. We recommend ISO86012016-04-07T23:45:00-0400.

Optional Parameters

keyword

string

Search by product name. Supports fuzzy search and advanced prefix search. String must be UTF-8, URL-encoded, and less than 500 characters in length.

Filter based on price groups. This filter does not take in dynamic values.

limit

integer

Limit the number of X items to return per deepest category level.

limit_if_segmented

integer

Variation to the regular limit parameter. Results will only be limited if 2 or more categories are returned.

sort

string

Define the sort style for the products. Currently support name and price. Prefix the sort by a minus to denote descending sort. ?sort=-name searches Z to A.

merchant_ids

string

Comma separated list of all merchant ids (or merchant slugs) to search against. This will only override the default merchants ids selected by geolocation if the passed in merchants are in delivery range.

inexact

boolean

Include inexact=true to perform to search approximate addresses, such as finding all products that are available in a particular zip code, neighborhood, or point of interest.

section

optional – string
Pass in alcohol type to restrict search. Only pass in one value at a time.

Type

Identifier

All Types

all

Beer

beer

Liquor

liquor

Wine

wine

?section=wine

subsection

optional – string
Comma delimited list of subcategories to search on. The section (wine, liquor, beer) should also be passed in. The filtering system may return unexpected results without specified section (but should still work).

Lists all the product information including the picture thumbnail. The id value links to the product ids listed in the category tree and is used for internal matching only. The unique product_id is product_id (alphanumeric string).

breadcrumbs

Shows the current location of the search. Breadcrumbs will not work properly if multiple subsection values are listed.

sort

Available sort options

merchants

Fully hydrated merchant object

search_address

This is the geocoded address of your search. You might want to store it for later use in the location API. If passing inexact=true, be sure to check whether is_exact_match is true or false. This will indicate whether the address points to a real location or is just approximate. When dealing with approximate addresses, you’ll need to prompt users for their actual addresses later in the process to add items to their carts.

id – internal id used to link the product to the ids listed in the categories tree.

product_id – “liquid id” of the product. This id cannot be used for checkout as it does not specify the quantity / volume / container type. Please first do a call to products/{id} endpoint. This will return all permutations of the alcohol item.

name – product name.

type – primary alcohol type: beer, wine, or liquor.

size – default volume or pack information

price – price of the item for the default volume

size_price – all price/size options

categories – all categories that the item currently matches in the request. This will not show all categories the item is categorized under.

tags – alcohol tags

image – url of item image

description – item description

Breadcrumbs

Lists the path to the current filtering location. Useful for navigational purposes.