LCBO API

LCBO API Version 1

Inventories

An inventory represents the presence of a product at an LCBO store.

Inventory Attributes

Attribute Description
product_id

Product ID

store_id

Store ID

is_dead

True if this inventory refers to a dead store and/or product

quantity

Reported quantity on hand of the product ID at store ID

updated_on

Reported date that quantity was updated

updated_at

Time that this inventory item was updated

product_no

Product ID [Deprecated]

store_no

Store ID [Deprecated]

Inventory HTTP Endpoints

GET lcboapi.com/inventories

Returns a list of inventories that can be filtered and ordered by parameters.

URL Query Parameters

Param Value Description
page Page number

The page number you’d like to return.

Example
lcboapi.com/inventories?page=3
per_page Page size

The number of objects to include per page. The defaults is 50, and the maximum is 100.

Example
lcboapi.com/inventories?per_page=100
where is_dead
Example
lcboapi.com/inventories?where=is_dead
Allows multiple values
Separate them with a comma like this: where=one,two,three
where_not is_dead
Example
lcboapi.com/inventories?where_not=is_dead
Allows multiple values
Separate them with a comma like this: where_not=one,two,three
order quantity
updated_on

Sort the returned inventories by one or more of the listed attributes. Ascending or descending order is specified by adding .asc or .desc to the end of the attribute name.

Example
lcboapi.com/inventories?order=quantity.desc
Allows multiple values
Separate them with a comma like this: order=one,two,three
store_id LCBO Store ID

Returns only inventories that are associated with the specified store.

Example
lcboapi.com/inventories?store_id=511
product_id LCBO Product ID

Returns only inventories that are associated with the specified product.

Example
lcboapi.com/inventories?product_id=18

GET lcboapi.com/stores/{store_id}/products/{product_id}/inventory

Returns an inventory for the specified store store_id and product product_id.