Intended Usage This API endpoint was developed to allow premium users to see their upcoming and active deliveries on other devices and platforms (e.g. Home Assistant). It was not designed to serve as a full replacement of the app, hence its limited functionality.
Expected Poll Rate Calling this endpoint does not trigger an update to your deliveries, you always get a cached response from the app server with this API. The rate limit is 20 requests per hour.
Authorization API key can be generated at web.parcelapp.net. The key should be supplied in the HTTP header "api-key".
Endpoint URL: https://api.parcel.app/external/deliveries/
Path Parameters
filter_mode (optional).
Possible values: "active", "recent". Default": "recent".
Example Request curl "https://api.parcel.app/external/deliveries/?filter_mode=active" -H "api-key: YOUR_API_KEY"
Response Schema - JSON
success (bool, always provided). Whether a request was successful.
error_message (string). Provided in case of an error.
deliveries (array). Requested deliveries.
Response Schema for Deliveries
carrier_code (string, always provided). Carrier for a delivery, provided as an internal code. Full list (updated daily) is available here.
description (string, always provided). Description that was provided for a delivery when it was created.
status_code (int, always provided). See the "Delivery Status Codes" paragraph below.
tracking_number (string, always provided). Tracking number for a delivery.
events (array, always provided). Delivery events. Empty if no data is available.
extra_information (string). It could be a postcode or an email. Something extra that was required by a carrier to track a delivery.
date_expected (string). Expected delivery date/time without specific timezone information.
date_expected_end (string). If provided, that means that a has delivery window for package and this is the end date/time.
timestamp_expected (int). Epoch time for expected delivery date. Available only when a carrier provides full date/time/timezone for an expected delivery date.
timestamp_expected_end (int). Similar to date_expected_end, used to indicate the end time for a delivery window.
Response Schema for Delivery Events
event (string, always provided). Description of the delivery event.
date (string, always provided). Delivery date/time info.
location (string). Location of the delivery event.
additional (string). Additional information from the carrier related to the delivery event.
Delivery Status Codes
0 - completed delivery.
1 - frozen delivery. There were no updates for a long time or something else makes the app believe that it will never be updated in the future.
2 - delivery in transit.
3 - delivery expecting a pickup by the recipient.
4 - out for delivery.
5 - delivery not found.
6 - failed delivery attempt.
7 - delivery exception, something is wrong and requires your attention.
8 - carrier has received information about a package, but has not physically received it yet.
Support Articles Click here to read other support articles related to Parcel.
Contact Us Please feel free to contact us in case if you have any questions.