Sort shopping list items

Use this action to sort every item on your shopping list by name. A common use is to keep a long list tidy and predictable, so related items end up next to each other and are easier to find while you shop.

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 sort the list 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 Sort shopping list.
6. To sort from Z to A instead of A to Z, turn on Sort reverse.
7. Select Save.

Options in the UI

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.sort. A basic example looks like this:

action: shopping_list.sort

Options in YAML

Good to know

• Sorting orders items by name. It does not separate completed items from items you still need.

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.

Related actions

These actions work well alongside this one:

• Add shopping list item: Adds an item to the shopping list.

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