> 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/royal-mail.md).
# Royal Mail
Royal Mail orders from your **Click & Drop** account (for senders). MyParcel retrieves recent orders automatically; you do not enter tracking numbers.
## At a glance
| | |
| ------------ | ----------------------------------- |
| Countries | 🇬🇧 United Kingdom |
| Connect with | API key |
| Device ID | `royal-mail` |
| Flow cards | 3 triggers · 1 condition · 1 action |
## Connect
1. In Royal Mail Click & Drop, create an API integration under **Settings → Integrations → Click & Drop API** and copy its authorisation key.
2. Open Homey → **Devices** → **+** → **MyParcel** → **Royal Mail**.
3. Paste the **Click & Drop API key** and tap **Connect Royal Mail**.
## Settings
| Group | Setting | Explanation |
| ----- | ------------------------ | --------------- |
| — | **Click & Drop API key** | (stored hidden) |
| — | **Order history (days)** | (default: 30) |
## Device values (capabilities)
Every value appears on the device in Homey. Not every field is filled for every parcel.
| ID | Type | Nederlands | English |
| ---------------------------- | ------ | ----------------- | ----------------- |
| `royal_mail_parcel_count` | number | Actieve pakketten | Active parcels |
| `royal_mail_status` | text | Status | Status |
| `myparcel_connection_status` | text | Verbindingsstatus | Connection status |
| `royal_mail_last_update` | text | Laatste update | Last update |
## Flow cards
### When… (triggers)
| ID | Nederlands | English |
| --------------------------- | --------------------------------- | ------------------------------------------------------------- |
| `royal_mail_new_package` | Nieuw Royal Mail-pakket | New Royal Mail package |
| `royal_mail_status_changed` | Royal Mail-pakketstatus gewijzigd | Royal Mail package status changed |
| `connection_status_changed` | Verbindingsstatus is gewijzigd | Connection status changed *(applies to all MyParcel devices)* |
### And… (conditions)
| ID | Nederlands | English | Arguments |
| ------------------------------ | ------------------------------------- | -------------------------------- | --------- |
| `royal_mail_packages_underway` | Er zijn Royal Mail-pakketten onderweg | Royal Mail packages are underway | — |
### Then… (actions)
| ID | Nederlands | English | Arguments |
| -------------------- | ------------------- | ------------------ | --------- |
| `royal_mail_refresh` | Vernieuw Royal Mail | Refresh Royal Mail | — |
## Notable tokens
Tokens passed by this carrier's When cards (not every card has every token).
Show all 3 tokens
| Token | Type | Nederlands | English |
| ----------------- | ---- | -------------- | --------------- |
| `tracking` | text | Trackingnummer | Tracking number |
| `status` | text | Status | Status |
| `previous_status` | text | Vorige status | Previous status |
## Limitations and tips
* Only for Click & Drop accounts (senders); incoming Royal Mail parcels without Click & Drop are not supported.
* Limited data: parcel count, status and last update.
[← 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/royal-mail.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.