AfterShip
The aftership
platform allows one to track deliveries by AfterShip, a service that supports 490+ couriers worldwide. To use the tracking API functionality, the Essentials plan is required. This plan includes 100 shipments per month. There are various paid-for tiers after that.
The sensor value shows the number of packages that are not in Delivered
state. As attributes are the number of packages per status.
Setup
To use this sensor, you need an AfterShip Account and set up an API Key. To set up an API Key go to AfterShip API page, and copy existing key or generate a new one.
Configuration
To add the AfterShip integration to your Home Assistant instance, use this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the Add Integration button.
-
From the list, select AfterShip.
-
Follow the instructions on screen to complete the setup.
Service add_tracking
You can use the service aftership.add_tracking
to add trackings to AfterShip.
Service data attribute | Required | Type | Description |
---|---|---|---|
tracking_number |
True |
string | Tracking number |
slug |
False |
string | Carrier e.g., fedex
|
title |
False |
string | Friendly name of package |
Service remove_tracking
You can use the service aftership.remove_tracking
to remove trackings from AfterShip.
Service data attribute | Required | Type | Description |
---|---|---|---|
tracking_number |
True |
string | Tracking number |
slug |
True |
string | Carrier e.g., fedex
|