Hey Couriers
    Hey Couriers
    • Hey Couriers API Documentation
    • Hey Courier
      • APIs for Packages
        • APIs for Archive Packages
          • Restore The Package
          • Archive The Package
          • Get The Archived Package List
        • Get The Package List
        • Create Package
        • Retrieve Particular Package
        • Bulk Package Upload Using Excel
        • Bulk Package Upload Using CSV
        • Download CSV Of Selected Packages
        • Download CSV Of Company Packages of Given Status
        • Get The POD Report of Package
        • Get The POD Report for Multiple Package
        • Update Package
      • Company Pickup Package
        • Company Pickup Package Bulk Upload
        • Company Pickup Package Excel Upload
        • Company Pickup Package Create
        • Company Pickup Package Update
        • Login Company Pickup Package List
    • Package Tracking (To Track Package)
      GET
    • Multiple Package Tracking (To Track Package)
      PATCH
    • Package Status Update By Webhook
      POST
    • Multi Label Printing By Webhook
      POST
    • Schemas
      • Sample Schemas
        • Pet
        • Category
        • Tag

    Hey Couriers API Documentation

    Empower Your Dev Team with the Hey Couriers API#

    Integrate seamless Hey Couriers API tracking integration with a robust platform for managing and tracking deliveries through a RESTful API and webhooks, facilitating real-time updates.
    Companies can gain access to the Hey Couriers portal by registering themselves with heycourier by clicking Get your free API key button and redirect to the website where you click the Register Company Button after registering, company receive api key in their registered mail to manage packages, track shipments, and configure pickup points.
    image.png
    After receiving the key in respective mails company need to put the api key iniside the header of the api provided where they put their secret key inside the variable name X-Webhook-Secret Like Below Image
    image.png

    📄 Contents#

    How company can access Hey Couriers portal
    Adding the packages in Hey Couriers portal
    Tracking the packages status which are added
    Pick up point access by company.

    How Company can access Hey Couriers Portal#

    Companies interested in using HeyCourier's services should contact the HeyCourier team via Heycourier Website And Click on Register Company Button there. After registering with company details, an administrator from HeyCourier will register the company and send the api key in the respective company's mail.
    By Putting the key inside the Header of the API allows companies to access the API's and manage their packages, track shipment statuses, and configure pickup point options.
    image.png
    image.png
    Registration Process:
    1.
    Visit Register Page : https://app.heycouriers.com.au/new-company-register
    2.
    Provide your company's name, email, person name, phone, ABN No. which are mandatory fields.
    3.
    Await confirmation and credentials from HeyCourier's support team where you will get the secret key in your mail
    4.
    Use the secret key iin Header of the API to access it.

    Adding the Packages in Hey Couriers portal#

    Once registered, companies can add packages to the HeyCourier system in three ways:
    A. Uploading Excel File
    B. Manual Entry
    C. Using the Package API
    A. Uploading Excel File
    In Two Formats
    1.
    You can upload csv file
    2.
    You can upload Excel File
    Companies can bulk-upload packages by submitting an Excel file through the portal. The file should adhere to the specified format (e.g., columns for recipient address, package details, etc.).
    B. Manual Entry
    In the portal, there is an "Add Package" form where companies can manually input package details. This method is suitable for adding single packages or handling custom requirements.
    C. Using the Package API

    Create Package API (add-package-by-webhook/)#

    In addition to uploading packages manually or through Excel files, companies can automate the process by integrating the Create Package API. This API allows systems to programmatically add new packages directly into the HeyCourier platform without using the web interface.

    Purpose:#

    The Create Package API is designed to streamline logistics operations by enabling automatic package creation from external systems such as eCommerce platforms, warehouse management systems, or custom-built logistics dashboards.

    Usage:#

    Companies can make a POST request to the endpoint:
    /add-package-by-webhook/
    Each request should include the required package information in JSON format. Common fields typically include sender and receiver details, package weight and dimensions, pickup and delivery addresses, and any special instructions.
    This method is ideal for:
    Bulk or automated order processing systems.
    Businesses integrating HeyCourier into their existing order workflows.
    Reducing manual data entry errors and processing time.

    Benefits:#

    Fully automated package creation process.
    Seamless integration between HeyCourier and external systems.
    Real-time addition of packages into the tracking ecosystem.

    Example Use Case:#

    An eCommerce platform can automatically push order data to HeyCourier using the add-package-by-webhook/ endpoint whenever a new customer order is confirmed. This ensures that package details are instantly available in the courier system for pickup and tracking.
    Note:
    Before using this API, ensure your company’s API credentials are active and authorized in the HeyCourier system. Invalid tokens or missing fields in the request payload will result in an error response.

    Company Pickup Package Create (pickup-package-by-webhook/)#

    In addition to manually scheduling pickups, companies can automate the process by integrating the Company Pickup Package Create API. This API allows systems to programmatically register packages that need to be picked up from the customer’s address directly into the HeyCourier platform without using the web interface.

    Purpose:#

    The Company Pickup Package Create API is designed to streamline pickup operations by enabling automatic registration of packages from external systems such as eCommerce platforms, subscription-based services, or custom logistics dashboards.

    Usage:#

    Companies can make a POST request to the endpoint:
    /pickup-package-by-webhook/
    Each request should include the required package information in JSON format. Common fields typically include sender details, pickup address and time, package weight and dimensions, and any special instructions for the driver.
    This method is ideal for:
    eCommerce platforms arranging customer pickups.
    Subscription-based services requiring regular pickups.
    Businesses integrating pickup scheduling into existing logistics workflows.

    Benefits:#

    Fully automated pickup request process.
    Reduces manual scheduling and human error.
    Ensures real-time addition of pickup parcels into the HeyCourier system.
    Enables drivers to plan pickups efficiently.

    Example Use Case:#

    A logistics aggregator can automatically push pickup requests to HeyCourier using the pickup-package-by-webhook/ endpoint whenever a customer schedules a pickup. This ensures all parcels are registered and assigned to a driver without manual intervention, improving operational efficiency.
    Note:
    Before using this API, ensure your company’s API credentials are active and authorized in the HeyCourier system. Invalid tokens or missing fields in the request payload will result in an error response.

    Tracking Package Status#

    HeyCourier offers multiple ways to track shipments, allowing both companies and customers to easily monitor their parcels using the tracking number (HAWB). Tracking can be done either through the HeyCourier website or via API integrations for system-based tracking.
    1.
    Tracking through the HeyCourier website: Enter the HAWB tracking number in the search bar on the tracking page.
    Enter The Tracking Number and click on Track button to track the particular parcel.
    image.png
    2.
    Tracking via API
    For companies requiring automated or bulk tracking, HeyCourier provides two dedicated APIs to retrieve package status programmatically.

    A. Single Package Tracking API#

    Name in Documentation: Package Tracking (To Track Package)
    Method: GET

    Purpose:#

    Used to fetch the live tracking details of a single parcel using its unique tracking number (HAWB).
    Ideal for integrating parcel tracking directly into company dashboards or customer support systems.

    Use Case:#

    To check the current status and full event history of one specific parcel.
    To display live tracking updates to end users.

    B. Multiple Package Tracking API#

    Name in Documentation: Multiple Package Tracking (To Track Package)
    Method: PATCH

    Purpose:#

    Used to track multiple parcels at once by sending a list of HAWB tracking numbers.
    This API simplifies bulk monitoring for companies handling large shipment volumes.

    Use Case:#

    To retrieve status updates for multiple parcels simultaneously.
    To integrate bulk tracking into internal logistics or CRM systems.

    Summary#

    Website Tracking – For customers and companies who want to manually track parcels using the HeyCourier interface.
    Single Tracking API – For retrieving status updates of one parcel via system integration.
    Multiple Tracking API – For batch tracking of multiple parcels in one request.
    Each option ensures real-time visibility and transparent delivery progress, making it easier for both businesses and customers to stay informed at every stage of the shipment journey.

    Package Status Update By Webhook#

    The Package Status Update By Webhook (Webhook) is designed to keep the parcel tracking process in sync between HeyCourier and external courier or partner systems. This API allows automatic updates of package statuses in real time, ensuring both senders and recipients always have the most accurate and up-to-date tracking information.

    Purpose#

    The main purpose of this API is to provide a seamless way for third-party courier systems to push status updates (such as Received in Depot, In Transit, Delivered, etc.) directly into the HeyCourier platform. This eliminates the need for manual status updates and helps maintain transparency throughout the delivery lifecycle.

    Key Features#

    Real-time updates: Automatically updates package statuses as soon as events occur in external systems.
    Proof of Delivery support: Option to upload a POD file (image or document) for completed deliveries.
    Flexible integration: Accepts data in form-data format, making it easy to connect with multiple logistics platforms.
    Error-free tracking: Reduces manual errors and ensures accurate status reflection for every parcel.

    Status Flow#

    1.
    Not Scanned – Default status for newly added parcels before depot scanning.
    2.
    Received in Depo – Updated when the parcel is scanned and received at the depot.
    3.
    Loaded by Driver – Set when the driver scans the parcel during loading for dispatch.
    4.
    In Transit – Indicates the driver has started the route and the parcel is en route.
    5.
    Delivered – Updated when the driver successfully delivers the parcel and marks it as delivered.
    6.
    Failed Delivery – Updated when the delivery attempt is unsuccessful (e.g., customer unavailable).
    7.
    RTS- Return to Sender – Used when the parcel is being returned to the sender due to issues like damage or incorrect details.
    8.
    RD- Return to depo – Updated when an undelivered parcel is returned and scanned back into the depot.

    When to Use This API#

    When you need to push live tracking updates from your courier or warehouse system to HeyCourier.
    When your system needs to sync status changes automatically without manual portal entry.
    When a Proof of Delivery document or image needs to be attached to a parcel record.

    Get The POD Report for Multiple Package#

    The Get The POD Report for Multiple Package API enables users to download the Proof of Delivery (POD) reports for multiple packages in a single request. This feature is particularly useful for logistics teams and integrated systems that need to retrieve delivery confirmations at scale without manually downloading each POD individually.

    Purpose:#

    This API provides an efficient way to fetch the POD reports for multiple packages by passing an array of tracking numbers (HAWB numbers). It is ideal for businesses that handle bulk shipments and require automated access to delivery proof for record-keeping or customer communication.

    Usage:#

    Make a PATCH request to the following endpoint:
    /add-package-by-webhook/pod-download-by-package-hawb/
    Each request must include the list of HAWB numbers (tracking numbers) in the request body. The endpoint processes the list and returns the POD reports corresponding to each HAWB provided.

    Benefits:#

    Download multiple POD reports in a single call.
    Reduces manual effort and repetitive requests.
    Ideal for bulk or batch shipment verification.
    Ensures seamless integration with third-party logistics systems.

    Example Use Case:#

    A courier aggregator platform or ERP system can automatically call this API after delivery completion to retrieve PODs for all shipments made in a specific batch or day. This ensures delivery records are instantly available for compliance, billing, or customer service purposes.
    Endpoint:
    PATCH https://devservices.heycouriers.com.au/add-package-by-webhook/pod-download-by-package-hawb/
    Headers:
    Key Type Description
    X-WebHook-Secret string API key provided by HeyCourier for authentication.
    Request Body (JSON):
    {
    "hawb": ["NEXAU1022601722YQ", "NEXAU1022660372YQ"]
    }
    Response:
    Returns the downloadable POD report(s) associated with the provided HAWB numbers in the requested format.

    Note:#

    Ensure your API credentials (X-WebHook-Secret) are valid and active. Invalid or expired credentials, or missing/incorrect HAWB numbers, will result in an error response.
    Modified at 2025-10-08 08:44:30
    Next
    Restore The Package
    Built with