LCBO API

LCBO API Version 1

Products

The product object represents a product in the LCBO catalog. It’s important to note that LCBO API maintains a history of all products, not only active ones. The is_dead flag indicates a product that is no longer in the official LCBO catalog but was at one point in the past.

Product Attributes

Attribute Description
alcohol_content

Alcohol content (Divide by 100 for decimal value)

bonus_reward_miles

Number of bonus air miles

bonus_reward_miles_ends_on

When bonus air miles are no longer valid

clearance_sale_savings_in_cents

Savings in cents if on clearance [Deprecated]

description

Product description (not available for all products)

has_bonus_reward_miles

True if the product has bonus air miles

has_clearance_sale

True if the product is currently on clearance [Deprecated]

has_limited_time_offer

True if the product is on sale

has_value_added_promotion

True if the product has a value added promotion

id

The LCBO product ID / number

inventory_count

Total units across all stores

inventory_price_in_cents

Total retail price of all units across all stores

inventory_volume_in_milliliters

Total volume of all units across all stores

is_dead

When products are removed from the LCBO catalog they are marked as “dead”

is_discontinued

True if the product has been marked as discontinued by the LCBO

is_kosher

True if the product is designated as Kosher.

is_seasonal

True if the product is designated as seasonal

is_vqa

True if the product is designated as VQA

is_ocb

True if the product is produced by a member of the Ontario Craft Brewers

limited_time_offer_ends_on

When the sale price is no longer valid

limited_time_offer_savings_in_cents

Savings in cents if on sale

name

Product name

origin

Country of origin / manufacture

package

Full package description

package_unit_type

Package unit type (bottle, can, etc.)

package_unit_volume_in_milliliters

The volume of one unit in the package

price_in_cents

Current retail price in cents

price_per_liter_in_cents

The beverage price per liter

price_per_liter_of_alcohol_in_cents

The alcohol price per liter

primary_category

Primary product category

producer_name

Name of the company that produces the product

product_no

The LCBO product ID / number [Deprecated]

regular_price_in_cents

Regular retail price in cents

released_on

Official release date (usually unspecified)

secondary_category

Secondary LCBO product category (Not available for all products)

serving_suggestion

LCBO serving suggestion (Not available for all products)

style

The LCBO’s determined style designation (Not available for most products)

tertiary_category

Tertiary LCBO product category (Not available for all products)

image_url

A URL to an image of the product (Not available for all products)

image_thumb_url

A URL to a smaller image of the product (Not available for all products)

stock_type

Either “LCBO” or “VINTAGES”

sugar_content

The product’s sweetness descriptor, is usually a designation such as extra-dry (XD), medium sweet (MS), etc. (Not available for all products)

sugar_in_grams_per_liter

The amount of sugar that is contained in the product in grams per liter. (Not available for all products)

tags

A string of tags that reflect the product

tasting_note

Professional tasting note (Not available for all products)

total_package_units

Number of units in a package

updated_at

Time that the product information was updated

value_added_promotion_description

Contents of the value added promotion offer if available

varietal

Grape varietal (or blend) designated by the LCBO (Not available for all products)

volume_in_milliliters

Total volume of all units in package

Product HTTP Endpoints

GET lcboapi.com/products

Returns a list of products that can be sorted and filtered by the described parameters.

URL Query Parameters

Param Value Description
page Page number

The page number you’d like to return.

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

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

Example
lcboapi.com/products?per_page=150
where is_dead
is_discontinued
has_value_added_promotion
has_limited_time_offer
has_bonus_reward_miles
is_seasonal
is_vqa
is_ocb
is_kosher

Return only products where the specified attributes are true.

Example
lcboapi.com/products?where=is_seasonal
Allows multiple values
Separate them with a comma like this: where=one,two,three
where_not is_dead
is_discontinued
has_value_added_promotion
has_limited_time_offer
has_bonus_reward_miles
is_seasonal
is_vqa
is_ocb
is_kosher

Return only products where the specified attributes are false.

Example
lcboapi.com/products?where_not=is_dead
Allows multiple values
Separate them with a comma like this: where_not=one,two,three
order 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

Sort the returned products 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/products?order=id.desc
Allows multiple values
Separate them with a comma like this: order=one,two,three
q URI-encoded search query

Returns all products that match the provided search query.

Example
lcboapi.com/products?q=red+wine
store_id LCBO Store ID

Returns only products that have or have had inventory at the specified store.

Example
lcboapi.com/products?store_id=511

GET lcboapi.com/products/{product_id}

Returns the specified product for product_id.