Hey Couriers
  1. APIs for Packages
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
        GET
      • Create Package
        POST
      • Retrieve Particular Package
        GET
      • Bulk Package Upload Using Excel
        POST
      • Bulk Package Upload Using CSV
        POST
      • Download CSV Of Selected Packages
        PATCH
      • Download CSV Of Company Packages of Given Status
        PATCH
      • Get The POD Report of Package
        GET
      • Update Package
        PATCH
    • 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
  1. APIs for Packages

Update Package

PATCH
{{base_url}}add-package-by-webhook/2/
This API endpoint used to add packages in the system

Request

Header Params
X-WebHook-Secret
string 
optional
API Key To Access this API
Example:
r3WExcdfdfwe
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
height
number 
required
length
number 
required
volume_weighted
number 
required
delivery_date
null 
required
price
null 
required
Example
{
    "hawb": "HAWB59624YT09",
    "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
}

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 PATCH '{{base_url}}add-package-by-webhook/2/' \
--header 'X-WebHook-Secret: r3WExcdfdfwe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hawb": "HAWB59624YT09",
    "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
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Previous
Get The POD Report of Package
Next
Get Archived Pickup Point Manager
Built with