Create a Booking

Developing

Testing Env

https://demo.modaltrans.com

POST

/api/v1/bookings

Creates a Booking.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "booking": {
        "trans_mode": "sea",
        "load_type": "P",
        "in_container": "out_of_container",
        "total_pack": 10,
        "brut_wg": 8700,
        "volume": 6.4,
        "price_wg": 8700,
        "operation_code": "fb9a753c22d59af6",
        "company_no": "21321432",
        "company_name": "Demo Uk",
        "company_taxno": "UK411981167",
        "company_country_id": "UK",
        "sender_name": "Test Consignor Co",
        "sender_eori": "GB987654312000",
        "load_place_type": "other",
        "load_place_code": "2214325324",
        "load_place": "WINCHESTER ROAD ,CHANDLERS FORD",
        "dep_zipcode": "SO53 2PZ",
        "load_state_name": "Winchester",
        "load_coun": "GB",
        "consignee_name": "Test Consignee Co",
        "consignee_eori": "GB987654312000",
        "unload_place_type": "other",
        "unload_place_code": "32412321",
        "unload_place": "NO 27 XIANXING ROAD, XIANLIN",
        "arv_zipcode": "710075",
        "unload_state_name": "Nanjing",
        "unload_coun": "CN",
        "incoterm": "CPT",
        "packages_attributes": [
            {
                "total": 97021,
                "pack_code": "BI",
                "dimension1": 50,
                "dimension2": 50,
                "dimension3": 50,
                "brutwg": 124213,
                "volume": 100,
                "pack_type": "Airpods"
            }
           
        ]
       
        
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://demo.modaltrans.com/api/v1/bookings' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "booking": {
        "trans_mode": "sea",
        "load_type": "P",
        "in_container": "out_of_container",
        "total_pack": 10,
        "brut_wg": 8700,
        "volume": 6.4,
        "price_wg": 8700,
        "operation_code": "fb9a753c22d59af6",
        "company_no": "21321432",
        "company_name": "Demo Uk",
        "company_taxno": "UK411981167",
        "company_country_id": "UK",
        "sender_name": "Test Consignor Co",
        "sender_eori": "GB987654312000",
        "load_place_type": "other",
        "load_place_code": "2214325324",
        "load_place": "WINCHESTER ROAD ,CHANDLERS FORD",
        "dep_zipcode": "SO53 2PZ",
        "load_state_name": "Winchester",
        "load_coun": "GB",
        "consignee_name": "Test Consignee Co",
        "consignee_eori": "GB987654312000",
        "unload_place_type": "other",
        "unload_place_code": "32412321",
        "unload_place": "NO 27 XIANXING ROAD, XIANLIN",
        "arv_zipcode": "710075",
        "unload_state_name": "Nanjing",
        "unload_coun": "CN",
        "incoterm": "CPT",
        "packages_attributes": [
            {
                "total": 97021,
                "pack_code": "BI",
                "dimension1": 50,
                "dimension2": 50,
                "dimension3": 50,
                "brutwg": 124213,
                "volume": 100,
                "pack_type": "Airpods"
            }
           
        ]
       
        
    }
}'

Responses

🟢201Created

application/json

Body

Example

[
    {
        "transaction_id": 0,
        "uuid": "string",
        "reference": "string",
        "trans_mode": "string",
        "branch_id": 0,
        "company_uuid": "string",
        "company_name": "string",
        "customer_ref": "string",
        "agent_ref": "string",
        "consignee_name": "string",
        "consignee_email": "string",
        "sender_name": "string",
        "sender_email": "string",
        "load_place_id": 0,
        "load_city": "string",
        "load_zipcode": "string",
        "load_coun": "string",
        "load_place": "string",
        "load_date": "2019-08-24T14:15:22.123Z",
        "unload_place_id": 0,
        "unload_city": "string",
        "unload_zipcode": "string",
        "unload_coun": "string",
        "unload_place": "string",
        "unload_date": "string",
        "brut_wg": 0,
        "volume": 0,
        "ladameter": 0,
        "status": "string",
        "commodity": "string",
        "category": "string",
        "group_id": 0,
        "price_wg": 0,
        "teu": 0,
        "saler_name": "string",
        "saler_email": "string",
        "saler_office_tel": "string",
        "total_pack": 0,
        "carrier_name": "string",
        "waybill_no": "string",
        "truck_code": "string",
        "vessel_code": "string",
        "truck_type": "string",
        "export_import": "string",
        "free_time": "string",
        "notes": "string",
        "container_nos": [
            {
                "size": "string",
                "container_no": "string"
            }
        ],
        "timelines": [
            {
                "id": 0,
                "parent_type": "string",
                "parent_id": 0,
                "status_date": "2019-08-24T14:15:22.123Z",
                "status_code": "string",
                "place_id": 0,
                "city_id": 0,
                "country_id": "string",
                "notes": "string",
                "source": "string",
                "group_id": 0,
                "user_id": 0,
                "patron_id": 0,
                "customer_inform_type": true,
                "customer_inform_status": "string",
                "created_at": "2019-08-24T14:15:22.123Z",
                "updated_at": "2019-08-24T14:15:22.123Z",
                "lng": 0,
                "lat": 0,
                "place_name": "string",
                "notify_senders": true,
                "notify_consignees": true,
                "notify_companies": true,
                "tenant_id": 0,
                "icon_code": "string",
                "system_location": "string"
            }
        ]
    }
]

Modified at 2025-07-17 11:33:01

List all Bookings

Update a Booking