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, ha_integration_type, ha_platforms

title	description	ha_category	ha_release	ha_config_flow	ha_quality_scale	ha_iot_class	ha_domain	ha_integration_type	ha_platforms
Shopping list	Instructions on how to integrate a Shopping list into Home Assistant using Intent.	Intent To-do list	0.50	true	internal	Local Push	shopping_list	integration	todo

The Shopping list {% term 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 To-do 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."

{% include integrations/config_flow.md %}

Actions

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

Action shopping_list.add_item

Add an item to the shopping list.

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

Action shopping_list.remove_item

Remove the first item with matching name from the shopping list.

Data attribute	Optional	Description
name	no	Name of the item to remove. Example: "Milk"

Action shopping_list.complete_item

Mark the first item with matching name as completed in the shopping list. It does not remove the item.

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

Action shopping_list.incomplete_item

Mark the first item with matching name as incomplete in the shopping list.

Data attribute	Optional	Description
name	no	Name of the item to mark as incomplete. Example: "Milk"

Action shopping_list.complete_all

Mark all items as completed in the shopping list (without removing them from the list).

Action shopping_list.incomplete_all

Mark all items as incomplete in the shopping list.

Action shopping_list.clear_completed_items

Clear completed items from the shopping list.

Action shopping_list.sort

Sort all items by name in the shopping list.

Data attribute	Optional	Description
reverse	yes	Whether to sort in reverse (descending) order. (default: False)

Using in automations

A shopping_list_updated event is triggered when items in the list are modified, with the following data payload attached to it. This can be used to trigger automations such as sending a push notification when someone adds an item to the shopping list, which when clicked, will open the list.

Data payload attribute	Description
action	What action was taken on the item. Either add for a new item being added, update for an item being updated, or remove for an item being removed.
item	A dictionary containing details of the item that was updated.
item.id	A unique ID for this item
item.name	The text attached to the item, for example Milk
item.complete	A boolean indicated whether the item has been marked as complete.

{% raw %}

alias: "Notify on new shopping list item"
triggers:
  - trigger: event
    event_type: shopping_list_updated
    event_data:
      action: "add"
actions:
  - action: notify.notify
    data:
      message: "{{ trigger.event.data.item.name }} has been added to the shopping list"
      data:
        clickAction: "/shopping-list"
        url: "/shopping-list"

{% endraw %}

You can also trigger an automation when a shopping_list_updated event was triggered by any of the following actions:

• clear: A completed item was cleared from the list.
• sorted: The items in the list were sorted by name.
• reorder: An item has been reordered in the list.
• update_list: All items have been updated.

In these cases, the event does not return a list item.