From 3f58cb64971f2749e91219eec2815ded0f926ab4 Mon Sep 17 00:00:00 2001
From: Kelly Atkinson <8167044+kellyatkinson@users.noreply.github.com>
Date: Mon, 23 May 2022 19:54:50 +1200
Subject: [PATCH] Adds detail of package statuses and attributes (#22855)

---
 source/_integrations/seventeentrack.markdown | 27 ++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/source/_integrations/seventeentrack.markdown b/source/_integrations/seventeentrack.markdown
index 5f1ca986cda..cae454ce22e 100644
--- a/source/_integrations/seventeentrack.markdown
+++ b/source/_integrations/seventeentrack.markdown
@@ -52,6 +52,33 @@ show_delivered:
   default: false
 {% endconfiguration %}
 
+## Package statuses
+
+[17track's API](https://api.17track.net/en/doc) provides the following tracking statuses. The integration creates a sensor for each status, which contains the packages in that status. The sensor's displayed value is the number of packages in that status.
+
+- Not found
+- In transit
+- Expired
+- Pick up
+- Undelivered
+- Delivered
+- Alert
+
+## Package-level attributes
+
+Each package entry (for example, within a status sensor) contains the following attributes.
+
+- package.friendly_name
+- package.status
+- package.destination_country
+- package.info_text
+- package.timestamp
+- package.location
+- package.origin_country
+- package.package_type
+- package.tracking_info_language
+- package.tracking_number
+
 ## Examples
 
 ### Dashboard summary card