Returns all products that are available at the specified store along with the currenty reported inventory quantity for each.

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, is_discontinued, has_value_added_promotion, has_limited_time_offer, has_bonus_reward_miles, is_seasonal, is_vqa, is_kosher

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:

id, price_in_cents, regular_price_in_cents, limited_time_offer_savings_in_cents, limited_time_offer_ends_on, bonus_reward_miles, bonus_reward_miles_ends_on, package_unit_volume_in_milliliters, total_package_units, total_package_volume_in_milliliters, volume_in_milliliters, alcohol_content, price_per_liter_of_alcohol_in_cents, price_per_liter_in_cents, inventory_count, inventory_volume_in_milliliters, inventory_price_in_cents, released_on

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.