PUT api/v1/BookingRequests?id={id}
Updates the Booking identified by id.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| bookingSavingDTO |
Define this parameter in the request body. |
|
| id |
Define this parameter in the request URI. |
Request body formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"BookingID": 1,
"Source": "sample string 2",
"Status": "sample string 3",
"SendBooking": true,
"ShippingInstructionID": 1,
"Carrier": "sample string 5",
"INTTRAReferenceNo": "sample string 6",
"CarrierReferenceNo": "sample string 7",
"ContractNo": "sample string 8",
"BookingOffice": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"DistinctContNo": true,
"ManifestFiling": true,
"FilerID": "sample string 11",
"Parties": {
"Agent": {
"WinID": 1
},
"Shipper": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
},
"Forwarder": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
},
"ContractParty": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
},
"Consignee": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
},
"NotifyParty": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
},
"AddnlNotifyParty1": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
},
"AddnlNotifyParty2": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
}
},
"References": [
{
"ReferenceType": "sample string 1",
"ReferenceNo": "sample string 2"
},
{
"ReferenceType": "sample string 1",
"ReferenceNo": "sample string 2"
},
{
"ReferenceType": "sample string 1",
"ReferenceNo": "sample string 2"
}
],
"Transit": {
"MovementType": "sample string 1",
"Vessel": "sample string 2",
"Voyage": "sample string 3",
"PlaceOfReceipt": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"EstimatedTimeOfDeparture": "2025-04-24T12:09:53",
"PlaceOfDelivery": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"EstimatedTimeOfArrival": "2025-04-24T12:09:53",
"PortOfLoad": {
"Code": "sample string 1",
"Name": "sample string 2"
},
"PortOfDischarge": {
"Code": "sample string 1",
"Name": "sample string 2"
}
},
"HaulageDetails": {
"ShipFrom": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
},
"ReqstPositionDateEmptyContAtDoor": "2025-04-24T12:09:53.9718563Z",
"ReqstPickUpDateAtStopOff": "2025-04-24T12:09:53.9718563Z",
"ShipFromContactName": "sample string 1",
"ShipFromContactNumber": "sample string 2",
"ShipTo": {
"WinId": 1,
"AccountNumber": "sample string 1",
"Name": "sample string 2",
"Phone": "sample string 3",
"Fax": "sample string 4",
"Email": "sample string 5",
"Address": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Place": "sample string 3",
"City": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
},
"PostalCode": "sample string 4",
"StateProvince": "sample string 5",
"Country": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
},
"ReqstDeliveryDateFullCont": "2025-04-24T12:09:53.9718563Z",
"ShipToContactName": "sample string 3",
"ShipToContactNumber": "sample string 4"
},
"Cargos": [
{
"Description": "sample string 1",
"HSCode": {
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
"GrossWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossVolume": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Quantity": 1,
"PackageTypeCode": "sample string 2",
"HazmatDetails": {
"IMOClassCodes": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"UNDGNo": "sample string 1",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"ProperShippingName": "sample string 2",
"PackingGroupCode": "sample string 3",
"AggregationState": "sample string 4",
"EMSNo": "sample string 5",
"DangerousGoodsLimitedQuantity": true,
"PollutantStatus": "sample string 7",
"HazmatComments": "sample string 8",
"ContactName": "sample string 9",
"ContactNo": "sample string 10"
}
},
{
"Description": "sample string 1",
"HSCode": {
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
"GrossWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossVolume": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Quantity": 1,
"PackageTypeCode": "sample string 2",
"HazmatDetails": {
"IMOClassCodes": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"UNDGNo": "sample string 1",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"ProperShippingName": "sample string 2",
"PackingGroupCode": "sample string 3",
"AggregationState": "sample string 4",
"EMSNo": "sample string 5",
"DangerousGoodsLimitedQuantity": true,
"PollutantStatus": "sample string 7",
"HazmatComments": "sample string 8",
"ContactName": "sample string 9",
"ContactNo": "sample string 10"
}
},
{
"Description": "sample string 1",
"HSCode": {
"Name": "sample string 2 - sample string 1",
"Code": "sample string 2"
},
"GrossWeight": {
"Value": 1.0,
"UOM": "sample string 1"
},
"GrossVolume": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Quantity": 1,
"PackageTypeCode": "sample string 2",
"HazmatDetails": {
"IMOClassCodes": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"UNDGNo": "sample string 1",
"FlashpointTemperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"ProperShippingName": "sample string 2",
"PackingGroupCode": "sample string 3",
"AggregationState": "sample string 4",
"EMSNo": "sample string 5",
"DangerousGoodsLimitedQuantity": true,
"PollutantStatus": "sample string 7",
"HazmatComments": "sample string 8",
"ContactName": "sample string 9",
"ContactNo": "sample string 10"
}
}
],
"Containers": [
{
"ContainerType": "sample string 1",
"Quantity": 1,
"ShipperOwned": true,
"Comments": "sample string 3",
"ReeferDetails": {
"Active": true,
"Temperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"AirFlow": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Humidity": 1.0,
"VentSettings": "sample string 1",
"HumidificationRequested": true,
"GenSetRequested": true,
"ControlledAtmosphere": {
"OxygenLevel": 1.0,
"NitrogenLevel": 1.0,
"CO2Level": 1.0
},
"TemperatureControlInstructions": "sample string 4"
},
"OutOfGaugeDetails": {
"Length": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Width": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Height": {
"Value": 1.0,
"UOM": "sample string 1"
}
}
},
{
"ContainerType": "sample string 1",
"Quantity": 1,
"ShipperOwned": true,
"Comments": "sample string 3",
"ReeferDetails": {
"Active": true,
"Temperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"AirFlow": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Humidity": 1.0,
"VentSettings": "sample string 1",
"HumidificationRequested": true,
"GenSetRequested": true,
"ControlledAtmosphere": {
"OxygenLevel": 1.0,
"NitrogenLevel": 1.0,
"CO2Level": 1.0
},
"TemperatureControlInstructions": "sample string 4"
},
"OutOfGaugeDetails": {
"Length": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Width": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Height": {
"Value": 1.0,
"UOM": "sample string 1"
}
}
},
{
"ContainerType": "sample string 1",
"Quantity": 1,
"ShipperOwned": true,
"Comments": "sample string 3",
"ReeferDetails": {
"Active": true,
"Temperature": {
"Value": 1.0,
"UOM": "sample string 1"
},
"AirFlow": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Humidity": 1.0,
"VentSettings": "sample string 1",
"HumidificationRequested": true,
"GenSetRequested": true,
"ControlledAtmosphere": {
"OxygenLevel": 1.0,
"NitrogenLevel": 1.0,
"CO2Level": 1.0
},
"TemperatureControlInstructions": "sample string 4"
},
"OutOfGaugeDetails": {
"Length": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Width": {
"Value": 1.0,
"UOM": "sample string 1"
},
"Height": {
"Value": 1.0,
"UOM": "sample string 1"
}
}
}
],
"Charges": [
{
"ChargeType": "sample string 1",
"FreightTerm": "sample string 2",
"Payer": "sample string 3",
"PaymentLocation": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
},
{
"ChargeType": "sample string 1",
"FreightTerm": "sample string 2",
"Payer": "sample string 3",
"PaymentLocation": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
},
{
"ChargeType": "sample string 1",
"FreightTerm": "sample string 2",
"Payer": "sample string 3",
"PaymentLocation": {
"Name": "sample string 2 (sample string 1)",
"Code": "sample string 2"
}
}
],
"NotifyAlso": [
{
"Name": "sample string 1",
"Email": "sample string 2"
},
{
"Name": "sample string 1",
"Email": "sample string 2"
},
{
"Name": "sample string 1",
"Email": "sample string 2"
}
],
"Comments": "sample string 12",
"AmendmentJustification": "sample string 13",
"Created": null,
"Updated": {
"AgentID": 1,
"AgentIDAsText": "1",
"AgentName": null,
"ContactID": 0,
"ContactIDAsText": "0",
"ContactName": null,
"Datetime": null,
"DatetimeAsText": null
},
"CarrierComments": [
{
"Category": "sample string 1",
"Message": "sample string 2"
},
{
"Category": "sample string 1",
"Message": "sample string 2"
},
{
"Category": "sample string 1",
"Message": "sample string 2"
}
]
}
Response Information
Response body formats
application/json, text/json
Sample:
{
"TransactionID": 1,
"TransactionStatus": "sample string 2",
"BookingID": 3,
"AgentID": 4,
"BookingStatus": "sample string 5",
"Remarks": [
{
"ErrorCode": "sample string 1",
"ErrorMessage": "sample string 2"
},
{
"ErrorCode": "sample string 1",
"ErrorMessage": "sample string 2"
},
{
"ErrorCode": "sample string 1",
"ErrorMessage": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<BookingReturnObject>
<TransactionID>1</TransactionID>
<TransactionStatus>sample string 2</TransactionStatus>
<BookingID>3</BookingID>
<AgentID>4</AgentID>
<BookingStatus>sample string 5</BookingStatus>
<Remarks>
<ErrorCode>sample string 1</ErrorCode>
<ErrorMessage>sample string 2</ErrorMessage>
</Remarks>
<Remarks>
<ErrorCode>sample string 1</ErrorCode>
<ErrorMessage>sample string 2</ErrorMessage>
</Remarks>
<Remarks>
<ErrorCode>sample string 1</ErrorCode>
<ErrorMessage>sample string 2</ErrorMessage>
</Remarks>
</BookingReturnObject>