Query Booking Data

Developing

GET

https://uateds.hlsholding.com/dts/V2/GetBookingData

Initiated by customerData from HLS

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/json

Example

{
    "start_date": "2019-08-24T14:15:22.123Z",
    "end_date": "2019-08-24T14:15:22.123Z",
    "date_type": "ETD"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://uateds.hlsholding.com/dts/V2/GetBookingData' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
    "start_date": "2019-08-24T14:15:22.123Z",
    "end_date": "2019-08-24T14:15:22.123Z",
    "date_type": "ETD"
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "bookings": [
        {
            "booking_number": "T219A00001",
            "cargo_ready_date": "2019-06-18T00:00:00+00:00",
            "cargo_volume": 1,
            "carrier_liner": "COSCO",
            "container_invoice_amount": 0,
            "containers": [
                {
                    "container_description": "",
                    "container_number": "COSU1234567",
                    "container_pieces": 200,
                    "container_po_number": "4564",
                    "container_scac": "HNLT",
                    "container_seal_number": "",
                    "container_size": "40HQ",
                    "container_volume_cbm": 60.000,
                    "container_weight_kgs": 12000.000
                },
                {
                    "container_description": "",
                    "container_number": "COSU7654321",
                    "container_pieces": 200,
                    "container_po_number": "4565",
                    "container_scac": "HNLT",
                    "container_seal_number": "",
                    "container_size": "40HQ",
                    "container_volume_cbm": 60.000,
                    "container_weight_kgs": 12000.000
                }
            ],
            "hbl_number": "T219A00001",
            "hbl_partys": [
                {
                    "party_type": "SHPR",
                    "party_code": "",
                    "party_name": "DEMO SHIPPER LIMITED",
                    "party_address": "",
                    "party_city": "",
                    "party_country": ""
                },
                {
                    "party_type": "CNEE",
                    "party_code": "",
                    "party_name": "DEMO CONSIGNEE LIMITED",
                    "party_address": "",
                    "party_city": "",
                    "party_country": ""
                }
            ],
            "job_closed": false,
            "line_booking_number": "COSU13456421",
            "mbl_number": "COSU13456421",
            "mbl_partys": [
                {
                    "party_type": "SHPR",
                    "party_code": "",
                    "party_name": "HLS TESTING OFFICE",
                    "party_address": "",
                    "party_city": "",
                    "party_country": ""
                },
                {
                    "party_type": "CNEE",
                    "party_code": "",
                    "party_name": "DEMO AGENT LIMITED",
                    "party_address": "",
                    "party_city": "",
                    "party_country": ""
                }
            ],
            "mbl_scac": "COSU",
            "recipient_id": "DEMOAGT",
            "recipient_name": "DEMO AGENT",
            "milestones": [
                {
                    "code": "BKD",
                    "date": "2019-06-11T13:56:40+00:00",
                    "description": "Booked"
                },
                {
                    "code": "AED",
                    "date": "2019-06-11T13:59:26+00:00",
                    "description": "All Export Documents Received"
                }
            ],
            "place_of_delivery_code": "USNYC",
            "place_of_delivery_date": "2019-08-01T00:00:00+00:00",
            "place_of_delivery_location": "NEW YORK, NY",
            "place_of_receipt_code": "CNWUH",
            "place_of_receipt_date": "2019-06-21T00:00:00+00:00",
            "place_of_receipt_location": "WUHAN, CHINA",
            "port_of_discharge_code": "USNYC",
            "port_of_discharge_date": "2019-08-01T00:00:00+00:00",
            "port_of_discharge_location": "NEW YORK, NY",
            "port_of_loading_code": "CNWUH",
            "port_of_loading_date": "2019-06-21T00:00:00+00:00",
            "port_of_loading_location": "WUHAN, CHINA",
            "pos": [
                {
                    "po_number": "4564"
                },
                {
                    "po_number": "4565"
                }
            ],
            "shipping_ref_number": "",
            "spotting_date": "2019-06-11T13:53:13+00:00",
            "vessel_name": "",
            "voyage_number": ""
        }
    ],
    "is_success": true,
    "message": ""
}

Query Pre-Alert Documents