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 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."

    配置

    此集成可通过 UI 配置。前往 设置 > 设备与服务 添加。

    Actions

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

    Action: Add item

    The shopping_list.add_item action adds an item to the shopping list.

    Data attributeOptionalDescription
    namenoName of the item to add. Example: "Milk"

    Action: Remove item

    The shopping_list.remove_item action removes the first item with matching name from the shopping list.

    Data attributeOptionalDescription
    namenoName of the item to remove. Example: "Milk"

    Action: Complete item

    The shopping_list.complete_item action marks the first item with matching name as completed in the shopping list. It does not remove the item.

    Data attributeOptionalDescription
    namenoName of the item to mark as completed. Example: "Milk"

    Action: Incomplete item

    The shopping_list.incomplete_item action marks the first item with matching name as incomplete in the shopping list.

    Data attributeOptionalDescription
    namenoName of the item to mark as incomplete. Example: "Milk"

    Action: Complete all

    The shopping_list.complete_all action marks all items as completed in the shopping list (without removing them from the list).

    Action: Incomplete all

    The shopping_list.incomplete_all action marks all items as incomplete in the shopping list.

    Action: Clear completed items

    The shopping_list.clear_completed_items action clears completed items from the shopping list.

    Action: Sort

    The shopping_list.sort action sorts all items by name in the shopping list.

    Data attributeOptionalDescription
    reverseyesWhether 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 attributeDescription
    actionWhat 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.
    itemA dictionary containing details of the item that was updated.
    item.idA unique ID for this item
    item.nameThe text attached to the item, for example Milk
    item.completeA boolean indicated whether the item has been marked as complete.
    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"

    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.