Returns stores.

Formats

Parameters

where, where_not

where filters products where the supplied fields are true. where_not filters products where the supplied fields are false. The two parameters can be used together. Multiple fields can be specified by joining them with a comma: where=field1,field2. The fields below may be specified:

is_dead, has_wheelchair_accessability, has_bilingual_services, has_product_consultant, has_tasting_bar, has_beer_cold_room, has_special_occasion_permits, has_vintages_corner, has_parking, has_transit_access

order

Orders the results by the specified fields in ascending (asc) or descending (desc) order. Multiple fields can be specified by joining them with a comma: order=field1.desc,field2.asc. The fields below may be specified:

distance_in_meters, inventory_volume_in_milliliters, id, products_count, inventory_count, inventory_price_in_cents

limit

Only used for CSV and TSV responses, specifies the number of rows to return. The default value is 50, and the maximum value is 200.

page

The page number to return. Consult the API conventions documentation for more information about pagination.

per_page

The number of objects to include per page. The default value is 20, and the maximum value is 100.

q

Full text search query, should be URI encoded.

geo

NOTE: Can not be used when lat and lon parameters are specified. A URI encoded query (address, intersection, landmark, postal code) that is to be translated into a coordinate. Subject to rate-limiting; because of this it is recommended that your application performs geocoding itself and uses the lat and lon parameters for spatial searching instead.

lat and lon

NOTE: Can not be used when geo parameter is specified. Specifies a latitude (lat) and longitude (lon) coordinate and performs a spatial search on stores indicating estimated distance from the coordinate in meters for each store.