Add a package

The Add a package action adds a package to your 17Track account by its tracking number, so 17Track starts following it for you.

This is handy when you want to start tracking a shipment straight from Home Assistant, for example from an automation that reads tracking numbers out of your order confirmation emails.

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 add a package 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. From the search box, search for and select 17TRACK: Add a package.
6. Select the 17Track service, then enter the Package tracking number to add and a Package friendly name.
7. Select Save.

This action does not support targets. In the UI, you select the 17Track service through the 17Track service field instead of choosing an area, device, entity, or label.

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

action: seventeentrack.add_package
data:
  config_entry_id: 2b4be47a1fa7c3764f14cf756dc98991
  package_tracking_number: RU0103445624A
  package_friendly_name: "Example package"

This adds the package to 17Track under the given friendly name.

Options in YAML

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: track a package when a tracking number arrives

When a helper that holds a new tracking number changes, add that package to 17Track.

• Trigger: A text helper with a tracking number changes
• Action: 17TRACK: Add a package

alias: "Track new package"
triggers:
  - trigger: state
    entity_id: input_text.tracking_number
actions:
  - action: seventeentrack.add_package
    data:
      config_entry_id: 2b4be47a1fa7c3764f14cf756dc98991
      package_tracking_number: "{{ states('input_text.tracking_number') }}"
      package_friendly_name: "New order"

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:

• Get packages: Queries the 17Track API for the latest package data.

• Archive package: Archives a package in 17Track by tracking number.