Home Assistant Home Assistant

17TRACK

The seventeentrack sensor platform allows users to get package data tied to their 17track.net account. The platform 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.

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.

Configuration

To enable the platform, add the following lines to your configuration.yaml file:

sensor:
  - platform: seventeentrack
    username: EMAIL_ADDRESS
    password: YOUR_PASSWORD

Configuration Variables

Looking for your configuration file?
username string Required

The email address associated with your 17track.net account.

password string Required

The password associated with your 17track.net account.

show_archived boolean (Optional, default: false)

Whether sensors should be created for archived packages.

show_delivered boolean (Optional, default: false)

Whether sensors should be created for delivered packages.

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
  • Pick up
  • Undelivered
  • Delivered
  • Alert

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:

type: markdown
title: Packages in transit
content: >
  {% for package in
  states.sensor.seventeentrack_packages_in_transit.attributes.packages %}

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

  {% endfor %}