Shopping List
The shopping_list integration allows you to keep track of shopping list items.
Your shopping list will be accessible from the sidebar, and you can optionally add the Shopping List card to your dashboard. With the Conversation integration you can add items to your shopping list using voice commands like “Add eggs to my shopping list.”
Configuration
Adding Shopping List to your Home Assistant instance can be done via the user interface, by using this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the sidebar click on Settings.
-
From the configuration menu select: Devices & Services.
-
In the bottom right, click on the Add Integration button.
-
From the list, search and select “Shopping List”.
-
Follow the instruction on screen to complete the set up.
Services
You can add or remove items from your shopping list by using the following services.
Service shopping_list.add_item
Adds an item to the shopping list.
| Service data attribute | Optional | Description |
|---|---|---|
name |
no | Name of the item to add. Example: “Milk” |
Service shopping_list.complete_item
Marks an item as completed in the shopping list. It does not remove the item.
| Service data attribute | Optional | Description |
|---|---|---|
name |
no | Name of the item to mark as completed. Example: “Milk” |
Service shopping_list.incomplete_item
Marks an item as incomplete in the shopping list.
| Service data attribute | Optional | Description |
|---|---|---|
name |
no | Name of the item to mark as incomplete. Example: “Milk” |
Service shopping_list.complete_all
Marks all items as completed in the shopping list. It does not remove the items.
Service shopping_list.incomplete_all
Marks all items as incomplete in the shopping list.
Service shopping_list.clear_completed_items
Clear completed items from the shopping list.
Using in Automations
The simplest way to use the shopping list with automations (e.g., when entering a zone with shops) is to create a notification that can be clicked to open the shopping list.
- service: notify.notify
data:
title: "Time to shop?"
message: "Click to open the shopping list"
data:
clickAction: "/shopping-list"
url: "/shopping-list"