My Project
  1. Package Model
My Project
  • 🐶 Walk through Apidog
  • hey couriers
    • Web
      • Hey Courier
        • Auth
          • Forget Password
          • Reset Password
          • Change Password
          • Password Change With Email
          • Get Login Token
          • Get Web Login Token
          • Logout
        • Group Permission
          • Get Group Permission
          • Create Group Permission
          • Retrieve Group Permission
          • Update Group Permission
          • Delete Group Permission
        • Webhook Secret Key
          • Generate Key
        • Profile Update
          • Package Column Update
          • Get User
          • Setting Update
          • User Update
          • Profile Image Delete
          • User Password Change
        • Common
          • Country
            • Archive
              • Get Archive List
              • Archive
              • Restore
            • Get
            • Get Currency
            • Create
            • Retrieve
            • Update
            • Delete
          • States
            • Archive
              • Archive List
              • Archive
              • Restore
            • Get
            • Create
            • Retrieve
            • Update
            • Delete
          • City
            • Archive
              • Archive List
              • Archive
              • New Request
            • Get
            • Create
            • Retrieve
            • Update
            • Delete
          • Suburb
            • Archive
              • Archive List
              • Archive List Copy
              • Archive List Copy
            • Get
            • Create
            • Assign Multiple Sub. to Zone
            • Retrieve
            • Update
            • Delete
          • Zone
            • Archive
              • Archive List
              • Archive
              • Restore
            • Zone by Suburb Filter
            • Get
            • Zone by Pincode Filter
            • Create
            • Retrieve
            • Update
            • Delete
          • Area
            • Archive
              • Archive List
              • Archive
              • Restore
            • Zone by Suburb Filter
            • Get
            • Create
            • Retrieve
            • Update
            • Delete
          • Street
            • Archive
              • Archive List
              • Archive
              • Archive Copy
            • Get
            • Create
            • Retrieve
            • Update
            • Delete
          • Pincode
            • Archive
              • Archive List
              • Archive
              • Restore
            • Get
            • Pincode by Suburb Filter
            • Create
            • Retrieve
            • Update
            • Delete
            • Bulk Upload
        • Employee
          • Archive
            • Get Archive
            • Archive
            • Restore
          • Image Delete
            • Driving License Image Delete
            • Police Check Image Delete
            • Passport Image Delete
            • Visa Image Delete
          • Company Driver
          • Get
          • Exclude Drivers
          • Create
          • Retrieve
          • Update
          • Delete
          • Status Change
          • Driver List
        • Package Model
          • Archive
            • Get Archive
            • Archive
            • Restore
          • Package CSV Download
            PATCH
          • Create Package by Company
            POST
          • Area by Postcode
            GET
          • Get Package by ID
            POST
          • Update Package by Company
            PATCH
          • Get
            GET
          • Get Price
            GET
          • Create
            POST
          • Retrieve
            GET
          • Update
            PATCH
          • Delete
            DELETE
          • Bulk Upload
            POST
          • Excel Upload
            POST
          • Status Change
            PATCH
          • Multiple Zone Filter
            PATCH
          • Package by Driver and Unassign
            PATCH
        • Assign Package To Driver
          • Get
          • Unassign Package
          • Unassign Single Package
          • Assign Driver
          • Assign Single Package Driver
          • Testing
          • Dash Board Count
          • Scan Package
        • Photo Upload in Assign Package
          • Photo Upload Delete
            • Photo One
            • Photo Two
            • Photo Three
            • Photo Four
            • Photo Five
            • Signature
          • Failed Delivery Status
            • List
            • Create
            • Retrieve
            • Update
            • Delete
          • List
          • Create
          • Retrieve
          • Update
          • Delete
        • Route
          • Route CSV Download
          • Get
          • Create
          • Retrieve
          • Update
          • Delete
          • Optimize Route
          • Assign Route To Other Driver
          • Assign Route to Driver
        • Delivery Rates
          • Unit Of Measurement
            • Get
            • Create
            • Retrieve
            • Update
            • Delete
          • Package Type
            • Archive
              • Archive List
              • Archive
              • Restore
            • Get
            • Create
            • Retrieve
            • Update
            • Delete
          • Rate Card by Company
          • Get
          • Create
          • Retrieve
          • Update
          • Delete
          • Delivery Rate Filters
        • Driver Delivery Rates
          • Get
          • Create
          • Retrieve
          • Update
          • Delete
        • Dashboard API
          • Driver History
          • Dashboard Count
          • Pending Delivery List
          • Assigned Delivery List
          • Optimize Route Package List
          • Sequence Wise Route
        • Optimize Route List of Package
          • POD
          • Route Package List
          • Package By Driver Route
          • Route Name by Driver
          • Dashboard count
          • Dashboard Map API
        • Return Report
          • Delivery Report
            • Excel Download
            • Delivery Failed Report
          • Driver Report
            • Excel Download
            • Driver Delivery Report
          • Driver Kpi Report
          • Kpi Report CSV
        • Delivery Attempt
          • Get
          • Create
        • Company
          • Depo Address
            • List
            • Create
            • Retrieve
            • Update
            • Delete
          • Archive
            • Get Archive List
            • Archive
            • Restore
          • Company Report
            • Company Excel Download
            • Company Report
            • Company KPI Report
            • Company KPI Excel
            • Login Company Package List
            • Company Package Excel Download
            • Company POD Report
          • Get
          • Create
          • Register Company Without Auth
          • Retrieve
          • Update
          • Status Change
          • Delete
        • Delivery Status Manage Model
          • List
          • Package Tracking
        • Warehouse
          • Archive
            • Archive List
            • Archive
            • Restore
          • Status Change
          • Get
          • Create
          • Retrieve
          • Update
          • Delete
        • Pickup Point
          • Archive
            • Archive List
            • Archive
            • Restore
          • Get
          • QR Code
          • Retrieve
          • Delete
          • Update
          • Status Change
          • Create
        • Driver Lat-Long Manage
          • Get
        • Company Package Upload
          • Company CSV Upload
          • Company Excel Upload
        • Package by Company Key
          • Get Package
        • Driver Support
          • Get
          • Create
          • Retrieve
          • Update
          • Delete
        • Pickup Package
          • Pickup Package Bulk Upload
          • Pickup Package Excel Upload
          • Company Pickup Package Bulk Upload
          • Company Pickup Package Excel Upload
          • Unassign Single Package
          • Assign Single Package Driver
          • Assign Driver
          • Unassign Package
          • Get
        • Wallet
          • Get Wallet
          • PrePaid Recharge Wallet
          • Create
          • PostPaid Recharge Wallet
          • Get Wallet Transaction
          • Get Login Company Transaction
          • PostPaid Recharge by Company
          • PrePaid Recharge by Company
          • Invoice by Transaction
          • Wallet Balance Check
          • Login Company Wallet Details
          • Get Wallet Transaction Copy
        • Pickup Route
          • Create Route
          • Create
        • Pickup Package by Webhook
          • Login Company Pickup Package List
          • Create Pickup Package by Webhook
          • Update Pickup Package by Webhook
        • Wallet Adjustment
          • Login Company Invoice CSV Download
          • Adjustment Invoice List
          • Invoice Status Change
          • Invoice CSV Download
          • Create Wallet Adjustment
        • Invoice
          • Generate Invoice
          • Get Invoice Details
          • Prepaid Recharge
          • Get
    • App
      • Mobile App
        • Login/ Logout
          • Get Login Token
          • Logout
          • Forget Password
          • Reset Password
        • Profile
          • Image Delete
            • Driving License Image Delete
            • Police Check Image Delete
            • Passport Image Delete
            • Visa Image Delete
          • Get
          • Driver Update
        • History
          • Driver Package History Filter
          • History
          • History Detail
        • Assign Route
          • Assinged Routes List by driver
          • Package by Route Sequence
          • Route Status Change
        • Package Delivered
          • Photo Upload Delete
            • Photo One
            • Photo Two
            • Photo Three
            • Photo Four
            • Photo Five
            • Signature
          • Failed Delivery Status
            • Get
            • Create
            • Retrieve
            • Update
            • Delete
          • List
          • Package Deliverd Photo Upload
          • Package Force Delivery
          • Retrieve
          • Update
          • Fail Delivery
          • Force Fully Fail Package
          • Fail Delivery Upload Photo
        • Failed Delivery
          • Deliver status update
        • Dashboard
          • Driver Route List
          • Driver Route Packages
          • Assigned Routes Count Copy
          • Assigned Routes Count
          • Pending Delivery List
          • Complated Delivery List
          • Route List
          • Driver Earning
          • Route Wise Earning
          • Tracking
          • Driver Deliverd Company
        • Scan API
          • Scan Package and Assign Zone
          • Inbound Scan(Scan by Driver)
          • Reset Scanned Parcel by Driver
          • Scan by Super Admin
          • Scan Input / No Parcel
          • Scan and Deliverd
          • Package Delivered by Tracking No
          • Scan By Supervisor
          • Supervisor Scan Package List
          • Remaining Packages List
          • Scanned Packages List
        • Pickup Point QR Scan
          • Pickup Point QR Scan
          • Pickup Point Package Scan
          • Package by Pickup Point
          • Status Change
        • Route status change
          • Status Change
        • Scan Return Parcel
          • Return Scan
          • Returned Packages List
          • Return Parcel by Depo Manager
          • Returned Packages Info
          • Returned Packages Full Details
        • Login Driver Pickup Driver Package
        • Package By Current Date
  • Untitled Endpoint
    GET
  • Untitled Endpoint
    GET
  • Untitled Endpoint
    POST
  1. Package Model

Create Package by Company

POST
{{base_url}}add-package-by-webhook/

Request

Authorization
Add parameter in header
Example:
X-Token: ********************
Header Params
X-Webhook-Secret
string 
optional
Example:
q1QyXKNj5D4ukdAk9QGna5DtUvketegM
Body Params application/json
hawb
string 
required
customer_code
string 
required
customer_name
string 
required
customer_address
string 
required
postcode
integer 
required
description_of_goods
string 
required
count
integer 
required
landed
boolean 
required
weight
integer 
required
shipper_code
null 
required
shipper_name
string 
required
shipper_address
string 
required
shipper_city
string 
required
shipper_state
string 
required
shipper_postcode
string 
required
shipper_country
string 
required
origin
string 
required
port
null 
required
total_value
integer 
required
goods_currency
string 
required
sac
boolean 
required
fr_reference
null 
required
sub_master
null 
required
pkg_type
null 
required
country_of_origin
null 
required
cyber_vendor_account
null 
required
customs_code
null 
required
cyber_importer_account
null 
required
importer_abn
null 
required
importer_cac
null 
required
cyber_supplier_account
null 
required
supplier_customs_code
null 
required
is_scanned
boolean 
required
zone
integer 
required
suburb
integer 
required
state
integer 
required
country
integer 
required
height
number 
required
length
number 
required
volume_weighted
number 
required
delivery_date
null 
required
price
null 
required
Example
{
    "hawb": "HAWB56209",
    "customer_code": "",
    "customer_name": "Maahi Shah",
    "customer_address": "Patel's Cafe, Road, Gota, Ahmedabad, Gujarat 382481",
    "customer_phone": null,
    "customer_email": null,
    "postcode": null,
    "description_of_goods": "",
    "company": 1,
    "count": null,
    "landed": false,
    "weight": null,
    "shipper_code": "",
    "shipper_name": "",
    "shipper_address": "",
    "shipper_city": "",
    "shipper_state": "",
    "shipper_postcode": "",
    "shipper_country": "",
    "origin": "",
    "port": "",
    "total_value": null,
    "goods_currency": "",
    "sac": false,
    "fr_reference": "",
    "sub_master": "",
    "pkg_type": "",
    "country_of_origin": "",
    "cyber_vendor_account": "",
    "customs_code": "",
    "cyber_importer_account": "",
    "importer_abn": "",
    "importer_cac": "",
    "cyber_supplier_account": "",
    "supplier_customs_code": "",
    "is_scanned": false,
    "zone": 20,
    "suburb": 2,
    "state": 6,
    "country": 2,
    "height": null,
    "length": null,
    "volume_weighted": null,
    "delivery_date": null,
    "price": null,
    "coordinates": {
        "latitude": -33.89376300000001,
        "longitude": 151.2281313
    }
}

Request 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/' \
--header 'X-Webhook-Secret: q1QyXKNj5D4ukdAk9QGna5DtUvketegM' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hawb": "HAWB56209",
    "customer_code": "",
    "customer_name": "Maahi Shah",
    "customer_address": "Patel'\''s Cafe, Road, Gota, Ahmedabad, Gujarat 382481",
    "customer_phone": null,
    "customer_email": null,
    "postcode": null,
    "description_of_goods": "",
    "company": 1,
    "count": null,
    "landed": false,
    "weight": null,
    "shipper_code": "",
    "shipper_name": "",
    "shipper_address": "",
    "shipper_city": "",
    "shipper_state": "",
    "shipper_postcode": "",
    "shipper_country": "",
    "origin": "",
    "port": "",
    "total_value": null,
    "goods_currency": "",
    "sac": false,
    "fr_reference": "",
    "sub_master": "",
    "pkg_type": "",
    "country_of_origin": "",
    "cyber_vendor_account": "",
    "customs_code": "",
    "cyber_importer_account": "",
    "importer_abn": "",
    "importer_cac": "",
    "cyber_supplier_account": "",
    "supplier_customs_code": "",
    "is_scanned": false,
    "zone": 20,
    "suburb": 2,
    "state": 6,
    "country": 2,
    "height": null,
    "length": null,
    "volume_weighted": null,
    "delivery_date": null,
    "price": null,
    "coordinates": {
        "latitude": -33.89376300000001,
        "longitude": 151.2281313
    }
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-04-18 10:23:48
Previous
Package CSV Download
Next
Area by Postcode
Built with