Intended Usage This API endpoint allows premium users to build custom automations to add new deliveries directly to Parcel.
Limitations of the API
• Deliveries added using this API will not receive tracking information immediately. You will see a "No data available" message for the new delivery in the app until the server first updates it.
• You can only submit one delivery per request.
• You will not be able to add tracking numbers that require additional input (e.g. email or postcode).
• When a request is submitted, the server will check if the tracking number is in a “known” format. If it is not, your request will fail with the relevant error.
Expected Poll Rate The rate limit is 20 requests per day. This includes any unsuccessful requests (e.g. submitting an invalid tracking number).
Authorization API key can be generated at web.parcelapp.net. The key should be supplied in the HTTP header "api-key".
Endpoint (POST request method expected) URL: https://api.parcel.app/external/add-delivery/
Request Schema - JSON
tracking_number (string, required). Tracking number for your delivery.
carrier_code (string, required). Carrier for a delivery, provided as an internal code. Full list (updated daily) is available here. Use "pholder" for a placeholder delivery.
description (string, required). Description for your delivery.
language (string, optional). Language to use for your delivery information. To be provided as a two letter code (ISO 639-1). Availability depends on a carrier. Default: en.
send_push_confirmation (bool, optional). Set this to true if you want to get a push notification sent to you once this delivery is added. Default: false.
Example Request
curl "https://api.parcel.app/external/add-delivery/" -H "api-key: YOUR_API_KEY" --request POST --data '{"tracking_number":"12345", "carrier_code":"pholder", "description":"Test Delivery", "send_push_confirmation":true}'
Response Schema - JSON
success (bool, always provided). Whether a request was successful.
error_message (string). Provided in case of an error.
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.