Create Package

POST

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

Used when a package is already physically with the courier (received at warehouse/counter)

Request

Header Params

Body Params application/json

Example

{
    "hawb": "HYC34GY3434J",
    "customer_code": "",
    "customer_name": "Joseph",
    "customer_address": "15 Dobell Street",
    "customer_phone": null,
    "customer_email": null,
    "postcode": "6110",
    "description_of_goods": "",
    "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,
    "height": null,
    "length": null,
    "width": null,
    "volume_weighted": null,
    "delivery_date": null,
    "order_no": "",
    "special_instructions": "Customer is not available between 3pm to 5pm",
    "delivery_instructions": "Please leave the parcel at door",
    "piece_no": 4,
    "total_pieces": 5
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '{{base_url}}add-package-by-webhook/' \
--header 'X-WebHook-Secret: r3WExcdfdfwe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hawb": "HYC34GY3434J",
    "customer_code": "",
    "customer_name": "Joseph",
    "customer_address": "15 Dobell Street",
    "customer_phone": null,
    "customer_email": null,
    "postcode": "6110",
    "description_of_goods": "",
    "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,
    "height": null,
    "length": null,
    "width": null,
    "volume_weighted": null,
    "delivery_date": null,
    "order_no": "",
    "special_instructions": "Customer is not available between 3pm to 5pm",
    "delivery_instructions": "Please leave the parcel at door",
    "piece_no": 4,
    "total_pieces": 5
}'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": {
        "id": 37975,
        "hawb": "HYC34GY3434J",
        "customer_code": "",
        "customer_name": "Joseph",
        "customer_address": "15 Dobell Street",
        "customer_phone": null,
        "customer_email": null,
        "postcode": 20904,
        "postcode_name": "6110",
        "description_of_goods": null,
        "count": null,
        "landed": false,
        "company": 25,
        "company_name": "EZShip",
        "weight": 0.0,
        "price": 0.0,
        "shipper_code": null,
        "shipper_name": null,
        "shipper_address": null,
        "shipper_city": null,
        "shipper_state": null,
        "shipper_postcode": null,
        "shipper_country": null,
        "origin": null,
        "port": null,
        "total_value": null,
        "goods_currency": null,
        "sac": false,
        "fr_reference": null,
        "sub_master": null,
        "pkg_type": null,
        "country_of_origin": null,
        "cyber_vendor_account": null,
        "customs_code": null,
        "cyber_importer_account": null,
        "importer_abn": null,
        "importer_cac": null,
        "cyber_supplier_account": null,
        "supplier_customs_code": null,
        "is_scanned": false,
        "is_picked_up": false,
        "parcel_no": 0,
        "sequence_no": null,
        "status": "Not Scanned",
        "zone": 593,
        "zone_name": "PER1901",
        "suburb": 20733,
        "suburb_name": "HUNTINGDALE",
        "customer_zone": 231,
        "customer_zone_name": "P19",
        "state": 5,
        "state_name": "Western Australia",
        "country": 1,
        "country_name": "Australia",
        "height": 0.0,
        "length": 0.0,
        "volume_weighted": 0.0,
        "assigned_to_id": null,
        "assigned_to": {
            "id": null,
            "name": null
        },
        "assigned_to_pickup_driver_id": null,
        "assigned_to_pickup_driver": {
            "id": null,
            "name": null
        },
        "route_id": null,
        "route_name": null,
        "delivery_date": null,
        "coordinates": {
            "latitude": -32.0770713,
            "longitude": 115.9762016
        },
        "unrouted": false,
        "created_at": "20-11-2025 11:36",
        "package_failed_delivery_status": [],
        "pickup_point": null,
        "warehouse": null,
        "scan_by_driver": false,
        "order_no": null,
        "supervisor_scan_received_in_depo_location": null,
        "driver_scan_and_loaded_location": null,
        "depo_manager_scan_and_return_to_depo_location": null,
        "driver_scan_and_deliverd_location": null,
        "driver_scan_and_failed_delivery_location": null,
        "signature": null,
        "signature_person_name": null,
        "pod": null,
        "width": 32.0,
        "special_instructions": "Customer is not available between 3pm to 5pm",
        "delivery_instructions": "Please leave the parcel at door",
        "piece_no": 4,
        "total_pieces": 5
    }
}

Modified at 2025-12-04 11:20:25

Get The Package List

Retrieve Particular Package