> For the complete documentation index, see [llms.txt](https://lrvdlinden.gitbook.io/myparcel-for-homey/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lrvdlinden.gitbook.io/myparcel-for-homey/en/carriers/ups.md).
# UPS
UPS shipments in Homey through your UPS account (UPS My Choice dashboard), with service, ship-from and ship-to, Access Point, delivery date and delivery window. Alternatively you can follow plain tracking numbers.
## At a glance
| | |
| ------------ | -------------------------------------------------- |
| Countries | π Worldwide (country and UPS locale configurable) |
| Connect with | Account Β· Tracking number |
| Device ID | `ups` |
| Flow cards | 5 triggers Β· 3 conditions Β· 1 action |
## Connect
1. Open Homey β **Devices** β **+** β **MyParcel** β **UPS**.
2. Choose **country** and **language**.
3. Sign in to UPS with the **UPS Token Helper**, open the UPS dashboard, wait until the helper reports that the web session is ready and paste the `web_session` pairing value into **UPS login callback**. Tap **Connect UPS**.
4. **Manual fallback:** enter tracking numbers and tap **Add tracking numbers**.
## Settings
| Group | Setting | Explanation |
| ----- | ------------------------------------ | --------------- |
| β | **Country code** | β |
| β | **UPS locale** | β |
| β | **UPS login callback** | (stored hidden) |
| β | **UPS authorization code** | (stored hidden) |
| β | **UPS OAuth state** | (stored hidden) |
| β | **UPS access/session token** | (stored hidden) |
| β | **UPS refresh token** | (stored hidden) |
| β | **Manual fallback tracking numbers** | β |
| β | **UPS web session** | (stored hidden) |
## Device values (capabilities)
Every value appears on the device in Homey. Not every field is filled for every parcel.
| ID | Type | Nederlands | English |
| --------------------- | ------ | ---------------------- | -------------------- |
| `ups_parcel_count` | number | Actieve pakketten | Active parcels |
| `ups_total_count` | number | Totaal pakketten | Total packages |
| `ups_status` | text | Status | Status |
| `ups_tracking` | text | Volgend trackingnummer | Next tracking number |
| `ups_sender` | text | Afzender | Sender |
| `ups_delivery_date` | text | Verwachte bezorging | Expected delivery |
| `ups_delivery_window` | text | Bezorgvenster | Delivery window |
| `ups_service` | text | UPS-service | UPS service |
| `ups_ship_from` | text | Verzonden vanaf | Ship from |
| `ups_ship_to` | text | Bestemming | Ship to |
| `ups_access_point` | text | UPS Access Point | UPS Access Point |
| `ups_last_event` | text | Laatste gebeurtenis | Last event |
| `ups_country` | text | UPS-land | UPS country |
| `ups_locale` | text | UPS-locale | UPS locale |
| `ups_account_status` | text | Verbindingsstatus | Connection status |
| `ups_last_update` | text | Laatste update | Last update |
## Flow cards
### When⦠(triggers)
| ID | Nederlands | English |
| ----------------------------- | --------------------------------- | ------------------------------------------------------------- |
| `ups_new_package` | Nieuw UPS-pakket | New UPS package |
| `ups_status_changed` | UPS-pakketstatus gewijzigd | UPS package status changed |
| `ups_delivered` | UPS-pakket bezorgd | UPS package delivered |
| `ups_delivery_window_changed` | Bezorgvenster bekend of gewijzigd | Delivery window available or changed |
| `connection_status_changed` | Verbindingsstatus is gewijzigd | Connection status changed *(applies to all MyParcel devices)* |
### And⦠(conditions)
| ID | Nederlands | English | Arguments |
| --------------------------- | ------------------------------- | ------------------------------ | --------- |
| `ups_packages_underway` | Er zijn UPS-pakketten onderweg | UPS packages are underway | β |
| `ups_account_connected` | UPS-account is gekoppeld | UPS account is connected | β |
| `ups_delivery_window_known` | Bezorgvenster is/is niet bekend | Delivery window is/isn't known | β |
### Then⦠(actions)
| ID | Nederlands | English | Arguments |
| ------------- | ------------ | ----------- | --------- |
| `ups_refresh` | Vernieuw UPS | Refresh UPS | β |
## Notable tokens
Tokens passed by this carrier's When cards (not every card has every token).
Show all 14 tokens
| Token | Type | Nederlands | English |
| ----------------- | ---- | ------------------- | --------------------- |
| `tracking` | text | Trackingnummer | Tracking number |
| `status` | text | Status | Status |
| `sender` | text | Afzender | Sender |
| `delivery_date` | text | Verwachte bezorging | Expected delivery |
| `delivery_window` | text | Bezorgvenster | Delivery window |
| `service` | text | UPS-service | UPS service |
| `ship_from` | text | Verzonden vanaf | Ship from |
| `ship_to` | text | Bestemming | Ship to |
| `access_point` | text | UPS Access Point | UPS Access Point |
| `last_event` | text | Laatste gebeurtenis | Last event |
| `previous_status` | text | Vorige status | Previous status |
| `carrier` | text | Vervoerder | Carrier |
| `window_start` | text | Start bezorgvenster | Delivery window start |
| `window_end` | text | Einde bezorgvenster | Delivery window end |
## Limitations and tips
* UPS has fewer Flow cards than the rebuilt carriers (for now): new parcel, status changed, delivered and delivery window.
* The UPS web session can expire; then use **Repair** with a new helper value.
[β All carriers](/myparcel-for-homey/en/carriers.md) Β· [Flow cards](/myparcel-for-homey/en/flows.md) Β· [Flow tokens](/myparcel-for-homey/en/tokens.md) Β· [Troubleshooting](/myparcel-for-homey/en/troubleshooting.md) Β· [Homey App Store](https://homey.app/en-us/app/nl.lrvdlinden.MyParcel/MyParcel/test/) Β· [Homey Community](https://community.homey.app/t/app-pro-myparcel/159800)
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://lrvdlinden.gitbook.io/myparcel-for-homey/en/carriers/ups.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.