home-assistant.io/source/_integrations/shopping_list.markdown

title, description, ha_category, ha_release, ha_config_flow, ha_quality_scale, ha_iot_class, ha_domain

title	description	ha_category	ha_release	ha_config_flow	ha_quality_scale	ha_iot_class	ha_domain
Shopping List	Instructions on how to integrate a Shopping list into Home Assistant using Intent.	Intent	0.50	true	internal	Local Push	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 Lovelace dashboard. With the Conversation integration you can add items to your shopping list using voice commands like "Add eggs to my shopping list."

Configuration - GUI

From the Home Assistant front page go to Configuration and then select Integrations from the list.

Use the plus button in the bottom right to add a new integration called Shopping List.

Configuration - Manual

# Example configuration.yaml entry
shopping_list:

Services

You can add or remove items from your shopping list by using the following services.

Service shopping_list.add_item

Service data attribute	Optional	Description
name	no	Name of the item to add. Example: "Milk"

Service shopping_list.complete_item

Service data attribute	Optional	Description
name	no	Name of the item to mark as completed. Example: "Milk"

Using in Automations

The simplest way use 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. This is tested to work with the Android companion app.

{% raw %}

service: notify.notify
title: "Time to shop?"
message: 'Click to open the shopping list'
data:
  clickAction: '/shopping-list'
  url: '/shopping-list'

{% endraw %}