PUT api/BookingSync?TPID={TPID}&TPID_ItemUniqueSystemReference={TPID_ItemUniqueSystemReference}&Timestamp={Timestamp}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| TPID | string |
Required |
|
| TPID_ItemUniqueSystemReference | string |
Required |
|
| Timestamp | string |
Required |
Body Parameters
TBookingItem| Name | Description | Type | Additional information |
|---|---|---|---|
| TPID_ItemUniqueSystemReference |
Reference to the booked unit assigned and mantained in Customer system - Mandatory | Read Only for Grimaldi |
string |
Required Max length: 18 |
| VehicleType |
Vehicle type for Shortsea shipping CARTRANS_E = CarTransporter-Empty CARTRANS_F = CarTransporter-Full JUMBO_E = Jumbo-Empty JUMBO_F = Jumbo-Full LORRY_E = Tir-Empty LORRY_F = Tir-Full TRAILER_E = Trailer-Empty TRAILER_F = Trailer-Full TRUCK_E = Truck – Empty TRUCK_F = Truck – Full |
string |
Max length: 15 |
| VehicleRegistrationNo |
Registration number (ie TRAILER or LORRY plate/license registration number) |
string |
Max length: 21 |
| TruckOfTrailerRegistrationNo |
Truck place/license registration number - Required only in case of Truck+Trailer bookings |
string |
Max length: 10 |
| LengthUOM |
Length Unit of Measure: CM=Centimeters, IN=Inches - Required only in case of RORO bookings |
string |
Max length: 2 |
| Length |
Vehicle length (ie if LengthUOM = CM then length can be 1360 cm) - Required only in case of RORO bookings Length expected no longer than 30 meters |
decimal number |
None. |
| HeightUOM |
Height Unit of Measure: CM=Centimeters, IN=Inches - Required only in case of RORO bookings (Used and New Vehicles) |
string |
Max length: 2 |
| Height |
Vehicle Height - Required only in case of RORO booking (Used and New Vehicles) |
decimal number |
None. |
| WidthUOM |
Width Unit of Measure: CM=Centimeters, IN=Inches - Required only in case of RORO bookings (Used and New Vehicles) |
string |
Max length: 2 |
| Width |
Vehicle Width - Required only in case of RORO booking (Used and New Vehicles) |
decimal number |
None. |
| WeightUOM |
Weight Unit of Measure: KG=Kilograms; LB=Pounds - Required |
string |
Max length: 2 |
| Weight |
Cargo weight (ie if WeightUOM=KG then weight can be 10000Kg) - Required Weight expected no heavier than 50000Kg |
decimal number |
None. |
| MeasuredLength | decimal number |
None. |
|
| MeasuredHeight | decimal number |
None. |
|
| MeasuredWidth | decimal number |
None. |
|
| MeasuredWeight | decimal number |
None. |
|
| MeasuredDate | date |
None. |
|
| IsHazardous |
In case of Hazardous cargo - PLEASE NOTE THAT EXTRA DOCUMENTS WILL BE REQUIRED BY THE AGENCY |
boolean |
None. |
| ReeferTemp |
Reefer Temperature |
integer |
None. |
| DriverNames |
Name of the drivers separated by semicolon ; ie: Name;Name2 |
string |
Max length: 80 |
| Remarks |
Optional Comments |
string |
Max length: 31 |
| VRID |
Optional Shipper Reference Number |
string |
Max length: 35 |
| VIN |
VIN - Required only for RORO bookings (Used and New Vehicles) |
string |
Max length: 21 |
| MakeModelCode |
Make and Model code - Required only for RORO bookings (Used and New Vehicles) |
string |
Max length: 7 |
| Priority |
Priority: "U" (Used), "N" (New Private), "F" (Facory New Vehicle), "V" (To be handled as new/VIP-Shipment), "P" Priority - Required only for RORO bookings (Used and New Vehicles) |
string |
Max length: 1 |
| ModelYear |
Car Model Built Year - Required only for RORO bookings (Used and New Vehicles) from US POLs |
integer |
None. |
| LoadMode |
Load Mode (F=Forklift, T=Towable) - Optional only for RORO bookings (Used and New Vehicles) |
string |
Max length: 1 |
| WaiverNumber |
Waiver Number |
string |
Max length: 20 |
| CTN |
Cargo Tracking Number |
string |
Max length: 8 |
| CustomsDocumentType |
Customs Document Type |
string |
Max length: 4 |
| CustomsDocumentNumber |
Customs Document Number |
string |
Max length: 20 |
| CustomsDocumentDate |
Customs Document Date |
date |
None. |
| CustomsDocumentClearanceDate |
Customs Document Clearance Date |
date |
None. |
| CustomsCleared |
Customs Clearance |
boolean |
None. |
| Tracked |
Tracked |
boolean |
None. |
| MainUnitID |
Base Unit ID: to use only in case of bookings with PiggyBack or Attached Trailer units. If you want to to book a unit as Piggyback or Attached Trailer, you need to populate this attribute with the TPID_ItemUniqueSystemReference relating to the Main Unit |
string |
Max length: 18 |
| CommodityCode |
Grimaldi Code of the commodity inside the equipment - Required for Container bookings |
string |
Max length: 15 |
| PackageType |
Package Type - Optional only for Container bookings |
string |
Max length: 10 |
| BLIssuanceOption |
B/L Issuance options ( 0 - Do not print, 1 - Print at destination, 2 - Print at origin, 3 - Telex Release, 4 - Sea Waybill) |
string |
Max length: 1 |
| ShipperEmail |
Shipper Email |
string |
Max length: 50 |
| ClearingAgent |
Clearing Agent Name |
string |
Max length: 50 |
| AdditionalShipperEmail |
Additional Shipper Email |
string |
Max length: 50 |
| DescriptionOfGoods |
Description of Goods as needed to be printed on the Bill of Lading. The maximum number of lines is 22 for the RoRo business. Each row can contains 26 characters. |
Collection of TBookingDoG |
None. |
| Tracking |
Tracking event associated to the equipment |
Collection of TBookingItemEvent |
None. |
| LastAPIResultCode |
READ ONLY - Latest result of data exchanged. 100 means "Success" anythings else would mean the last exchange failed |
string |
None. |
| LastAPIResultMessage |
READ ONLY - Description of latest data exchange result |
string |
None. |
| RoRoUnitStatus | BookingItemRoRoStatus |
None. |
Request Formats
application/json, text/json
{
"TPID_ItemUniqueSystemReference": "sample string 1",
"VehicleType": "sample string 3",
"VehicleRegistrationNo": "sample string 4",
"TruckOfTrailerRegistrationNo": "sample string 5",
"LengthUOM": "sample string 6",
"Length": 7.1,
"HeightUOM": "sample string 8",
"Height": 9.1,
"WidthUOM": "sample string 10",
"Width": 11.1,
"WeightUOM": "sample string 12",
"Weight": 13.1,
"MeasuredLength": 1.1,
"MeasuredHeight": 1.1,
"MeasuredWidth": 1.1,
"MeasuredWeight": 1.1,
"MeasuredDate": "2026-04-04T01:17:31.2455228+02:00",
"IsHazardous": true,
"ReeferTemp": 1,
"DriverNames": "sample string 15",
"Remarks": "sample string 16",
"VRID": "sample string 17",
"VIN": "sample string 18",
"MakeModelCode": "sample string 19",
"Priority": "sample string 20",
"ModelYear": 1,
"LoadMode": "sample string 21",
"WaiverNumber": "sample string 22",
"CTN": "sample string 23",
"CustomsDocumentType": "sample string 24",
"CustomsDocumentNumber": "sample string 25",
"CustomsDocumentDate": "2026-04-04T01:17:31.2455228+02:00",
"CustomsDocumentClearanceDate": "2026-04-04T01:17:31.2455228+02:00",
"CustomsCleared": true,
"Tracked": true,
"MainUnitID": "sample string 28",
"CommodityCode": "sample string 29",
"PackageType": "sample string 30",
"BLIssuanceOption": "sample string 31",
"ShipperEmail": "sample string 32",
"ClearingAgent": "sample string 33",
"AdditionalShipperEmail": "sample string 34",
"DescriptionOfGoods": [
{
"TextRow": "sample string 1"
},
{
"TextRow": "sample string 1"
}
],
"Tracking": [
{
"Event": 0,
"DateTime": "2026-04-04T01:17:31.2455228+02:00"
},
{
"Event": 0,
"DateTime": "2026-04-04T01:17:31.2455228+02:00"
}
],
"LastAPIResultCode": "sample string 35",
"LastAPIResultMessage": "sample string 36",
"RoRoUnitStatus": 0
}
application/xml, text/xml
<TBookingItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EServiceAPI.Models">
<AdditionalShipperEmail>sample string 34</AdditionalShipperEmail>
<BLIssuanceOption>sample string 31</BLIssuanceOption>
<CTN>sample string 23</CTN>
<ClearingAgent>sample string 33</ClearingAgent>
<CommodityCode>sample string 29</CommodityCode>
<CustomsCleared>true</CustomsCleared>
<CustomsDocumentClearanceDate>2026-04-04T01:17:31.2455228+02:00</CustomsDocumentClearanceDate>
<CustomsDocumentDate>2026-04-04T01:17:31.2455228+02:00</CustomsDocumentDate>
<CustomsDocumentNumber>sample string 25</CustomsDocumentNumber>
<CustomsDocumentType>sample string 24</CustomsDocumentType>
<DescriptionOfGoods>
<TBookingDoG>
<TextRow>sample string 1</TextRow>
</TBookingDoG>
<TBookingDoG>
<TextRow>sample string 1</TextRow>
</TBookingDoG>
</DescriptionOfGoods>
<DriverNames>sample string 15</DriverNames>
<Height>9.1</Height>
<HeightUOM>sample string 8</HeightUOM>
<IsHazardous>true</IsHazardous>
<LastAPIResultCode>sample string 35</LastAPIResultCode>
<LastAPIResultMessage>sample string 36</LastAPIResultMessage>
<Length>7.1</Length>
<LengthUOM>sample string 6</LengthUOM>
<LoadMode>sample string 21</LoadMode>
<MainUnitID>sample string 28</MainUnitID>
<MakeModelCode>sample string 19</MakeModelCode>
<MeasuredDate>2026-04-04T01:17:31.2455228+02:00</MeasuredDate>
<MeasuredHeight>1.1</MeasuredHeight>
<MeasuredLength>1.1</MeasuredLength>
<MeasuredWeight>1.1</MeasuredWeight>
<MeasuredWidth>1.1</MeasuredWidth>
<ModelYear>1</ModelYear>
<PackageType>sample string 30</PackageType>
<Priority>sample string 20</Priority>
<ReeferTemp>1</ReeferTemp>
<Remarks>sample string 16</Remarks>
<RoRoUnitStatus>Booked</RoRoUnitStatus>
<ShipperEmail>sample string 32</ShipperEmail>
<TPID_ItemUniqueSystemReference>sample string 1</TPID_ItemUniqueSystemReference>
<Tracked>true</Tracked>
<Tracking>
<TBookingItemEvent>
<DateTime>2026-04-04T01:17:31.2455228+02:00</DateTime>
<Event>Booked</Event>
</TBookingItemEvent>
<TBookingItemEvent>
<DateTime>2026-04-04T01:17:31.2455228+02:00</DateTime>
<Event>Booked</Event>
</TBookingItemEvent>
</Tracking>
<TruckOfTrailerRegistrationNo>sample string 5</TruckOfTrailerRegistrationNo>
<VIN>sample string 18</VIN>
<VRID>sample string 17</VRID>
<VehicleRegistrationNo>sample string 4</VehicleRegistrationNo>
<VehicleType>sample string 3</VehicleType>
<WaiverNumber>sample string 22</WaiverNumber>
<Weight>13.1</Weight>
<WeightUOM>sample string 12</WeightUOM>
<Width>11.1</Width>
<WidthUOM>sample string 10</WidthUOM>
</TBookingItem>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |