Clear completed shopping list items

Use this action to remove all completed items from your shopping list, leaving only the items you still need. A common use is to tidy up the list automatically after a shopping trip.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To clear completed items from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Search for and select Shopping list: Clear completed shopping list items.
6. Select Save.

Options in the UI

This action has no options.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required. For how an automation or a script is built in YAML, refer to Automations in YAML and Scripts.

In YAML, refer to this action as shopping_list.clear_completed_items. It takes no options:

action: shopping_list.clear_completed_items

Options in YAML

This action has no options.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup. In the visual editor, select the UI options listed in the example or paste the YAML code.

Automation: clean up the list when you leave the store

Clear the items you ticked off as soon as you leave the supermarket, so your list is ready for next time.

• Trigger: Zone left
  • Target: Me
  • Zone: Supermarket
• Action: Shopping list: Clear completed shopping list items

alias: "Tidy shopping list after shopping"
triggers:
  - trigger: zone.left
    target:
      entity_id: person.me
    options:
      zone: zone.supermarket
actions:
  - action: shopping_list.clear_completed_items

Good to know

• Only completed items are removed. Items you have not ticked off stay on the list.

Still stuck?

To test the action on its own, run it in the automation editor with Run action, and check the message that it shows. To see what the action did when the automation ran, open the trace of that run. For details, refer to Testing automations. For common problems and their solutions, refer to Troubleshooting automations.

If that doesn’t help, the Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

Explore related actions:

• Complete shopping list item: Marks every incomplete item with matching name as completed in the shopping list.

• Complete all shopping list items: Marks all items as completed in the shopping list.