A Home Assistant integration for ParcelsApp.com, a universal parcel tracking service.
| Sensor | Description |
|---|---|
| Parcels App Status | Monitors the availability of the ParcelsApp.com website |
| Button | Description |
|---|---|
| Update Parcels App Tracking | Updates all parcels not marked as delivered or archived |
The integration provides the following services:
- Arguments:
tracking_id(Required): The parcel's tracking ID provided by your parcel/delivery company.name(Optional): An optional name for your parcel (used as the sensor name).
- Arguments:
tracking_id(Required): The tracking ID of the package you wish to stop tracking.
Use the parcelsapp.remove_package service to remove a package from tracking. This will delete the associated sensor and stop any further updates for that package.
The track_package service creates a sensor for each tracked package with the following attributes:
| Attribute | Description |
|---|---|
| status | Current state (archived, delivered, transit, arrived, pickup) |
| uuid | UUID used by the ParcelsApp API |
| uuid_timestamp | Timestamp when the UUID was obtained |
| message | Latest update message from the delivery company |
| location | Latest known location of the parcel |
| origin | Country of departure |
| destination | Destination country or address |
| carrier | Delivery company name |
| days_in_transit | Number of days the parcel has been in transit |
| last_updated | Timestamp of the latest check by the integration |
| name | Name given to the parcel (from the name parameter) |
| tracking_id | The tracking ID of the parcel |
- Add this GitHub repository to HACS as a custom repository, or click the badge above.
- Install the "Parcels App" integration via HACS.
- Restart Home Assistant.
- Add the integration via the Home Assistant UI (Configuration > Integrations > Add Integration > Parcels App).
During setup, you'll need to provide:
- Your ParcelsApp API key (obtainable from parcelsapp.com/dashboard)
- Your destination country (the name of your country in your native language)
- If you are getting errors, make sure you have answered the email sent from parcelsapp to confirm your account. It may have gone to spam.
After configuration, you can use the parcelsapp.track_package service to add new packages for tracking. Each tracked package will create a new sensor entity in Home Assistant.
To remove a tracked package, use the parcelsapp.remove_package service with the tracking_id of the package you wish to remove.
Contributions to this integration are welcome! Please follow these guidelines:
- Use descriptive commit messages and add context to your changes.
- Test your changes thoroughly before submitting a pull request.
- Update documentation (including this README) if your changes affect user-facing features or setup.
If you find this integration valuable and want to support it in other ways, you can buy me a coffee.