home-assistant.io/source/_integrations/seventeentrack.markdown

title, description, ha_category, ha_release, ha_config_flow, ha_iot_class, ha_codeowners, ha_domain, ha_platforms, ha_integration_type

title	description	ha_category	ha_release	ha_config_flow	ha_iot_class	ha_codeowners	ha_domain	ha_platforms	ha_integration_type
17TRACK	Instructions on how to use 17track.net data within Home Assistant	Postal Service	0.83	true	Cloud Polling	@shaiu	seventeentrack	sensor	service

The seventeentrack {% term integration %} allows users to get package data tied to their 17track.net account. The integration creates both summary sensors, which show the number of packages in a current state (e.g., "In Transit"), as well as individual sensors for each package within the account.

{% important %} Although the 17track.net website states that account passwords cannot be longer than 16 characters, users can technically set longer-than-16-character passwords. These passwords will not work with the used API. Therefore, please ensure that your 17track.net password does not exceed 16 characters. {% endimportant %}

{% include integrations/config_flow.md %}

Package statuses

17track's API provides the following tracking statuses. The integration creates a sensor for each status, which contains the packages in that status. The sensor's displayed value is the number of packages in that status.

• Not found
• In transit
• Expired
• Ready to be picked up
• Undelivered
• Delivered
• Returned

Package-level attributes

Each package entry (for example, within a status sensor) contains the following attributes.

• package.friendly_name
• package.status
• package.destination_country
• package.info_text
• package.timestamp
• package.location
• package.origin_country
• package.package_type
• package.tracking_info_language
• package.tracking_number

Examples

Dashboard summary card

Use the following templated Markdown card to list all packages in transit along with their status:

{% raw %}

type: markdown
title: Packages in transit
content: >
  {% for package in
  states.sensor['17track_in_transit'].attributes.packages %}

  >- **{{ package.friendly_name }} ({{ package.tracking_number }}):** {{
  package.info_text }}

  {% endfor %}

{% endraw %}

Actions

Action seventeentrack.get_packages

The seventeentrack.get_packages action allows you to query the 17track API for the latest package data.

Data attribute	Optional	Description
config_entry_id	No	The ID of the 17Track service config entry.
package_state	yes	A list of the package states.

# Example automation action to retrieve packages with specific states from 17Track
- action: seventeentrack.get_packages
  data:
    config_entry_id: 2b4be47a1fa7c3764f14cf756dc98991
    package_state: ["Delivered", "In transit"]

Action seventeentrack.archive_package

The seventeentrack.archive_package action allows you to archive a package using the 17track API.

Data attribute	Optional	Description
config_entry_id	No	The ID of the 17Track service config entry.
package_tracking_number	No	The package tracking number.

# Example automation action to archive a package with a tracking number
- action: seventeentrack.archive_package
  data:
    config_entry_id: 2b4be47a1fa7c3764f14cf756dc98991
    package_tracking_number: RU0103445624A

Action seventeentrack.add_package

The seventeentrack.add_package action allows you to add a package using the 17track API.

Data attribute	Optional	Description
config_entry_id	No	The selected service to add the package to.
package_tracking_number	No	The package tracking number to add.
package_friendly_name	No	The friendly name of the package to be added.

# Example automation action to add a package with tracking number and its friendly name
- action: seventeentrack.add_package
  data:
    config_entry_id: 2b4be47a1fa7c3764f14cf756dc98991
    package_tracking_number: RU0103445624A
    package_friendly_name: "Example Package"