Overview
Use this endpoint to retrieve detailed information about Booking linked with shipment based on its unique shipment number.
Endpoint
HTTP Method: GET
Endpoint URL: https://coreapi.impexdocs.com/api/v1/shipment/{shipmentdocs_id}/booking
Authentication: Required
Response Format (Successfully Retrieved)
A successful retrieval will yield a JSON response containing the following details like:
- Booking Id
- Booking number
- Shipment Folder Details Id
- Shipment number
- Booking status
- and more...
Request Parameters
To fetch a shipment, provide the required field, which is the "Shipment Number" {shipment_no}. Alternatively, users can also pass the Shipment Docs Id {shipmentdocs_id} in place of the Shipment Number for retrieval.
Example
Request
GET https://coreapi.impexdocs.com/api/v1/shipment/{shipmentdocs_id}/booking
Response
{
"booking_id": "0d0de4b2-c0e0-42d8-96ba-3a5b431ac788",
"booking_number": "FRE256453400_2",
"shipment_folderdetail_id": "c2b9fdf0-4235-4deb-9yt9-e3141f80260a",
"shipment_no": "Impx-Demo",
"booking_status": "Created",
"transport_mode": "Sea",
"shipment_type": "AllocationTypeFCL",
"your_ref": "S",
"no_of_containers": "4",
"container_type": "40HCR",
"cont_type_desc": "40HCR",
"container_description": "",
"shipper_code": "PRIME",
"shipper_desc": "PRIME INTERNATIONAL, INC.",
"freight_forwarder_code": "PRIME",
"freight_forwarder_desc": "PRIME INTERNATIONAL, INC.",
"release_number": "76346",
"place_of_origin_code": "USSAV",
"place_of_origin_desc": "SAVANNAH, GA",
"loading_port": "MEL",
"loading_port_desc": "MELBOURNE",
"transhipment_port": "SGP",
"transhipment_port_desc": "SINGAPORE",
"discharge_port": "ALSAR",
"discharge_port_desc": "SARANDE",
"final_destination": "SINGAPORE",
"final_destination_code": "SINGAPORE",
"shipping_line": "7061580",
"shipping_line_desc": "PACIFIC INTERNATIONAL LINES (PTE) LTD",
"vessel": "KOTA LARIS",
"voyage": "061N",
"lloyds": "",
//Additional Booking Details
}
This example demonstrates a request to fetch the booking details of a shipment with the provided shipment number. The response includes details such as the shipment number, shipment status, shipment folder details ID, and booking information.