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

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

title	description	ha_category	ha_release	ha_iot_class	ha_domain	ha_platforms	ha_integration_type	ha_config_flow
AfterShip	Instructions on how to set up AfterShip sensors within Home Assistant.	Postal service	0.85	Cloud Polling	aftership	sensor	integration	true

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.

AfterShip recently removed the tracking API functionality from the Forever Free plan. The tracking API functionality requires at least the Essentials plan.

{% include integrations/config_flow.md %}

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

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