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

      Multi Label Printing By Webhook

      Developing
      POST
      {{base_url}}add-package-by-webhook/multi-label-printing/
      This API allows clients to generate shipping labels for one or multiple parcels in a single request.
      Clients can send one or more HAWB numbers (comma-separated), and the API will return a unique downloadable PDF label URL for each HAWB provided.
      This endpoint is designed for bulk label generation through webhook-based integrations, enabling external courier systems, eCommerce platforms, and logistics partners to instantly fetch label files required for dispatch.
      Key Features
      Generate single or multiple labels in one request
      Supports comma-separated HAWB numbers
      Returns individual PDF URLs for each HAWB
      Ideal for automated order processing and bulk shipment workflows
      Typical Use Cases
      Automatically generate labels when an order is created in a third-party system
      Bulk label printing during warehouse packing operations
      Integrations for eCommerce, ERP, or courier aggregators needing instant label files
      Webhook-based automated parcel creation and label generation
      Request Requirements
      Each request must include:
      X-WebHook-Secret header (shared secret token provided by HeyCouriers)
      JSON body containing the hawb field (single or multiple comma-separated values)
      Response
      The API returns a list of labels, where each entry contains:
      The provided HAWB number
      A download URL for that parcel’s PDF label

      Request

      Header Params

      Body Params application/json

      Example
      {
          "hawb": "EZShipTest1001,EZShipTest1002,EZShipTest1003"
      }

      Request Code Samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST '{{base_url}}add-package-by-webhook/multi-label-printing/' \
      --header 'X-WebHook-Secret: EZYJZesR3E82HcwFEbMjm67qKq1HYpI4' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "hawb": "EZShipTest1001,EZShipTest1002,EZShipTest1003"
      }'

      Responses

      🟢200Success
      application/json
      Body

      Example
      {
        "success": true,
        "labels": [
          {
            "hawb": "EZShipTest1001",
            "url": "https://heycouriers-dev-files.s3.ap-south-1.amazonaws.com/package_labels/23694_20251117163535_EZShipTest1001.pdf"
          },
          {
            "hawb": "EZShipTest1002",
            "url": "https://heycouriers-dev-files.s3.ap-south-1.amazonaws.com/package_labels/23695_20251117163536_EZShipTest1002.pdf"
          }
        ]
      }
      
      Modified at 2025-11-17 11:47:11
      Previous
      Package Status Update By Webhook
      Next
      Pet
      Built with