2026.6.3
Home ▸ Actions

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

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

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more] 
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.

Tip

You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.

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: You leave the supermarket zone
  • Action: Clear completed shopping list items
Show example YAML
AutomationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] 
alias: "Tidy shopping list after shopping"
triggers:
  - trigger: zone
    entity_id: person.me
    zone: zone.supermarket
    event: leave
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?

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.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: