2024.11.3
Home ▸ Integrations ▸

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 Pro plan is required.

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.

Important

AfterShip removed the Tracking API functionality from the Forever Free plan, and also no longer offers it in the Essentials plan. Using this integration now requires at least the Pro plan.

Configuration

To add the AfterShip integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select AfterShip.

  • Follow the instructions on screen to complete the setup.

Action add_tracking

You can use the aftership.add_tracking action to add trackings to AfterShip.

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

Action remove_tracking

You can use the aftership.remove_tracking action to remove trackings from AfterShip.

Data attribute Required Type Description
tracking_number True string Tracking number
slug True string Carrier e.g., fedex

Note

This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.