1. V2.0
HLS Open API
  • V2.0
    • Query Booking Data
      GET
    • Query Pre-Alert Documents
      GET
    • Push Pre-Alert Documents
      POST
    • Push Booking Data (Including CPA)
      POST
    • Receive Customer's Booking Confirmation (CBC)
      POST
    • Push ISF Data
      POST
  1. V2.0

Push Booking Data (Including CPA)

Developing
UAT
https://uateds.hlsholding.com/dts
UAT
https://uateds.hlsholding.com/dts
POST
https://your-api-url
Developed by customerInitiated by HLSData from HLS
HLS will actively push Booking data to our customers through this interface.
Therefore, for this solution, you are required to parse the request body and provide the corresponding API endpoint URL to us.
You may determine whether to enable authentication and specify the authentication method, and we will cooperate in the development.

Request

Body Params application/jsonRequired

Example
{
    "booking_number": "MY269A03XX",
    "cargo_ready_date": "2026-10-20T00:00:00+08:00",
    "cargo_volume": 1,
    "carrier_liner": "ZIM",
    "hbl_client": "DEMO SHIPPER",
    "hbl_consignee": "DEMO CONSIGNEE",
    "hbl_number": "MY269A03XX",
    "carrier_booking_number": "E465007XXX",
    "mbl_consignee": "DEMO CONSIGNEE",
    "mbl_number": "ZIMUE465007XXX",
    "mbl_scac": "HNLT",
    "mbl_shipper": "DEMO SHIPPER",
    "mbl_create_time": "2026-10-16T09:02:17+08:00",
    "estimated_delivery_date": "2026-12-20T00:00:00+08:00",
    "place_of_delivery_code": "USJAX",
    "place_of_delivery_date": "2026-12-20T00:00:00+08:00",
    "place_of_delivery_location": "JACKSONVILLE, FL",
    "place_of_receipt_code": "MYPEN",
    "place_of_receipt_date": "2026-10-19T22:48:00+08:00",
    "place_of_receipt_location": "PENANG, MALAYSIA",
    "port_of_discharge_code": "USJAX",
    "port_of_discharge_date": "2026-12-11T00:00:00+08:00",
    "port_of_discharge_location": "JACKSONVILLE, FL",
    "port_of_loading_code": "MYPEN",
    "port_of_loading_date": "2026-10-26T00:00:00+08:00",
    "port_of_loading_location": "PENANG, MALAYSIA",
    "shipping_ref_number": "XXX213145",
    "vessel_name": "YUAN XIANG",
    "voyage_number": "11E",
    "containers": [
        {
            "container_description": null,
            "container_number": "MAGU5684XXX",
            "container_pieces": 42,
            "container_po_number": null,
            "container_scac": null,
            "container_seal_number": "YMAR193XXX",
            "container_size": "D40H",
            "container_volume_cbm": 34.324,
            "container_weight_kgs": 24370.0
        }
    ],
    "pos": [
        {
            "po_number": "272322"
        }
    ],
    "hbl_partys": [
        {
            "party_type": "SHPR",
            "party_code": "1130251542",
            "party_name": "DEMO SHIPPER",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "KUALA KEDAH",
            "party_country": "MY"
        },
        {
            "party_type": "CNEE",
            "party_code": "0210237567",
            "party_name": "DEMO CONSIGNEE",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "RALEIGH",
            "party_country": "US"
        },
        {
            "party_type": "NTFY",
            "party_code": "0210237567",
            "party_name": "DEMO CONSIGNEE",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "RALEIGH",
            "party_country": "US"
        }
    ],
    "mbl_partys": [
        {
            "party_type": "SHPR",
            "party_code": "HLSXX",
            "party_name": "XXXXXXXXXXXXXXX",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "MYPJA",
            "party_country": "MY"
        },
        {
            "party_type": "CNEE",
            "party_code": "0110197266",
            "party_name": "DEMO CONSIGNEE",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "USTPA",
            "party_country": "US"
        },
        {
            "party_type": "NTFY",
            "party_code": "0110197266",
            "party_name": "DEMO CONSIGNEE",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "USTPA",
            "party_country": "US"
        }
    ],
    "recipient_code": "0110197266",
    "recipient_name": "XXXXXXXXXXXXXX",
    "shipment_type": "FCL",
    "freight_type": "CLL",
    "hbl_freight_type": "CLL",
    "move_type": "CY/CY",
    "hbl_move_type": "CY/CY",
    "bill_type": "S",
    "hbl_bill_type": "O",
    "cargos": [
        {
            "hs_code": "441879",
            "qty": 400,
            "unit": "PK",
            "gross_weight": 21000.0,
            "volume": 50.0,
            "commodity": "ELECTRONIC PARTS"
        }
    ],
    "cpas": [
        {
            "cpa_id": "7505622762977808386",
            "active": true,
            "carrier": "ZIM",
            "carrier_scac": "ZIMU",
            "cost": 1234.00,
            "effective_date": "2026-06-15",
            "expiry_date": "2026-06-30",
            "cy_cutoff": "2026-06-28T00:00:00+08:00",
            "si_cutoff": "2026-06-24T00:00:00+08:00",
            "etd": "2026-06-28",
            "eta": "2026-08-15",
            "vessel": "YUAN XIANG",
            "voyage": "11E",
            "remark": "ZXB (HKHKGSPOT1) SUBJ TO 20' OWS, INCL EFS"
        }
    ]
}

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 'https://your-api-url' \
--header 'Content-Type: application/json' \
--data '{
    "booking_number": "MY269A03XX",
    "cargo_ready_date": "2026-10-20T00:00:00+08:00",
    "cargo_volume": 1,
    "carrier_liner": "ZIM",
    "hbl_client": "DEMO SHIPPER",
    "hbl_consignee": "DEMO CONSIGNEE",
    "hbl_number": "MY269A03XX",
    "carrier_booking_number": "E465007XXX",
    "mbl_consignee": "DEMO CONSIGNEE",
    "mbl_number": "ZIMUE465007XXX",
    "mbl_scac": "HNLT",
    "mbl_shipper": "DEMO SHIPPER",
    "mbl_create_time": "2026-10-16T09:02:17+08:00",
    "estimated_delivery_date": "2026-12-20T00:00:00+08:00",
    "place_of_delivery_code": "USJAX",
    "place_of_delivery_date": "2026-12-20T00:00:00+08:00",
    "place_of_delivery_location": "JACKSONVILLE, FL",
    "place_of_receipt_code": "MYPEN",
    "place_of_receipt_date": "2026-10-19T22:48:00+08:00",
    "place_of_receipt_location": "PENANG, MALAYSIA",
    "port_of_discharge_code": "USJAX",
    "port_of_discharge_date": "2026-12-11T00:00:00+08:00",
    "port_of_discharge_location": "JACKSONVILLE, FL",
    "port_of_loading_code": "MYPEN",
    "port_of_loading_date": "2026-10-26T00:00:00+08:00",
    "port_of_loading_location": "PENANG, MALAYSIA",
    "shipping_ref_number": "XXX213145",
    "vessel_name": "YUAN XIANG",
    "voyage_number": "11E",
    "containers": [
        {
            "container_description": null,
            "container_number": "MAGU5684XXX",
            "container_pieces": 42,
            "container_po_number": null,
            "container_scac": null,
            "container_seal_number": "YMAR193XXX",
            "container_size": "D40H",
            "container_volume_cbm": 34.324,
            "container_weight_kgs": 24370.0
        }
    ],
    "pos": [
        {
            "po_number": "272322"
        }
    ],
    "hbl_partys": [
        {
            "party_type": "SHPR",
            "party_code": "1130251542",
            "party_name": "DEMO SHIPPER",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "KUALA KEDAH",
            "party_country": "MY"
        },
        {
            "party_type": "CNEE",
            "party_code": "0210237567",
            "party_name": "DEMO CONSIGNEE",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "RALEIGH",
            "party_country": "US"
        },
        {
            "party_type": "NTFY",
            "party_code": "0210237567",
            "party_name": "DEMO CONSIGNEE",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "RALEIGH",
            "party_country": "US"
        }
    ],
    "mbl_partys": [
        {
            "party_type": "SHPR",
            "party_code": "HLSXX",
            "party_name": "XXXXXXXXXXXXXXX",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "MYPJA",
            "party_country": "MY"
        },
        {
            "party_type": "CNEE",
            "party_code": "0110197266",
            "party_name": "DEMO CONSIGNEE",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "USTPA",
            "party_country": "US"
        },
        {
            "party_type": "NTFY",
            "party_code": "0110197266",
            "party_name": "DEMO CONSIGNEE",
            "party_address": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "party_city": "USTPA",
            "party_country": "US"
        }
    ],
    "recipient_code": "0110197266",
    "recipient_name": "XXXXXXXXXXXXXX",
    "shipment_type": "FCL",
    "freight_type": "CLL",
    "hbl_freight_type": "CLL",
    "move_type": "CY/CY",
    "hbl_move_type": "CY/CY",
    "bill_type": "S",
    "hbl_bill_type": "O",
    "cargos": [
        {
            "hs_code": "441879",
            "qty": 400,
            "unit": "PK",
            "gross_weight": 21000.0,
            "volume": 50.0,
            "commodity": "ELECTRONIC PARTS"
        }
    ],
    "cpas": [
        {
            "cpa_id": "7505622762977808386",
            "active": true,
            "carrier": "ZIM",
            "carrier_scac": "ZIMU",
            "cost": 1234.00,
            "effective_date": "2026-06-15",
            "expiry_date": "2026-06-30",
            "cy_cutoff": "2026-06-28T00:00:00+08:00",
            "si_cutoff": "2026-06-24T00:00:00+08:00",
            "etd": "2026-06-28",
            "eta": "2026-08-15",
            "vessel": "YUAN XIANG",
            "voyage": "11E",
            "remark": "ZXB (HKHKGSPOT1) SUBJ TO 20'\'' OWS, INCL EFS"
        }
    ]
}'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{
    "code": 200,
    "success": true,
    "message": "Success",
    "data": {
        "ref_number": "XXX213145"
    }
}
🟠400General Bad Request
🔴500General Server Error
Previous
Push Pre-Alert Documents
Next
Receive Customer's Booking Confirmation (CBC)
Built with