---
title: AfterShip
description: Instructions on how to set up AfterShip sensors within Home Assistant.
ha_category:
  - Postal Service
ha_release: 0.85
ha_iot_class: Cloud Polling
ha_domain: aftership
---

The `aftership` platform allows one to track deliveries by [AfterShip](https://www.aftership.com), a service that supports 490+ couriers worldwide. There is a 'Forever Free' tier which allows tracking of up to 50 packages 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](https://accounts.aftership.com/register) and set up an API Key. To set up an API Key go to [AfterShip API](https://admin.aftership.com/settings/api-keys) page, and copy existing key or generate a new one.

<div class='note info'>
AfterShip recently started requiring having a credit card on file even if you are only using the free plan. That does not change the functionality of the platform, just something to be aware of.
</div>

## Configuration

To enable this sensor, add the following lines to your `configuration.yaml`:

```yaml
sensor:
  - platform: aftership
    api_key: AFTERSHIP_APIKEY
```

{% configuration %}
name:
  description: The sensor name to use in the frontend.
  required: false
  default: "aftership"
  type: string
api_key:
  description: The API key for AfterShip.
  required: true
  type: string
{% endconfiguration %}

## 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`

<div class='note info'>
This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.
</div>
