LCBO API

LCBO API Version 1

Datasets

Datasets represent snapshots of all stores, products, and inventories at a given time. They are created once per day and contain information such as the IDs of stores and products that were added and removed since the previous dataset.

Dataset Attributes

Attribute Description
id

Dataset identifier

total_products

Total unique retail products across all stores

total_stores

Total stores

total_inventories

Total inventory items across all stores

total_product_inventory_count

Total product units across all stores

total_product_inventory_volume_in_milliliters

Total volume of all product units across all stores

total_product_inventory_price_in_cents

Total retail value of all product units across all stores

created_at

The time the dataset was created

product_ids

List of all active product IDs at the time the dataset was created

store_ids

List of all active store IDs at the time the dataset was created

added_product_ids

List of product IDs that were added since the previous update

added_store_ids

List of store IDs that were added since the previous update

removed_product_ids

List of product IDs that were removed since the previous update

removed_store_ids

List of store IDs that were removed since the previous update

csv_dump

Contains a path to a ZIP archive of CSV files for stores, products, and inventories.

Dataset HTTP Endpoints

GET lcboapi.com/datasets

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/datasets?page=3
per_page Page size

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

Example
lcboapi.com/datasets?per_page=50
order id
created_at
total_products
total_stores
total_inventories
total_product_inventory_count
total_product_inventory_volume_in_milliliters
total_product_inventory_price_in_cents

Sort the returned datasets 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/datasets?order=created_at.asc
Allows multiple values
Separate them with a comma like this: order=one,two,three

GET lcboapi.com/datasets/{dataset_id}

Returns an inventory for the specified dataset dataset_id.

You can get the latest dataset by specifying latest as the ID.

Datasets are also available as ZIP files containing CSV dumps of all stores, products, and inventories. Just add .zip to the end of the URL.