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
        • Update Package
      • APIs for Pickup Point
        • Archive
          • Get Archived Pickup Point Manager
          • Archive The Pickup Point Manager
          • Restore The Pick Point Manager
        • Get Pickup Point Manager List
        • Download QR Code of Pickup Point Manager
        • Retrieve Particular Pickup Point Manager Detail
        • Update The Pickup Point Manager
        • Status Change Of Pickup Point Manager
        • Create Pickup Point Manager
      • 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

    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
    Companies can also add packages programmatically by making a POST request to the add Package API endpoint.

    Tracking Package Status#

    HeyCourier provides a tracking page where companies and customers can check the status of a shipment using the tracking number (HAWB).
    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 through the API: Use the following API endpoint to retrieve package status by providing the hawb number in query params.

    Pick Up Point#

    In cases where a recipient is unavailable, packages send to a nearby pickup point by driver.
    One Can Add the Pick Point Manager In two ways:
    1.
    By Admin Portal
    Click on Add Pickup Point to register the Pickup Point Manager
    And then Active the Pickup Point Manager after that reset password link gets shared on the Pickup point Manager Email On clicking the link reset password page open where you reset the password and then Login with the credential of email and password manager sets.
    In cases where a recipient is unavailable, driver takes the package to nearby pick point and then driver scan the package at pickup point, manager receive the scanned package and then the status for that package changed to received at pickup point.
    Next
    Restore The Package
    Built with