Get Booking by ID
Note: View the Field Description section for
additional information on the attributes that are present in the JSON.
| Attribute Name | Description |
|---|---|
| booking-id | A booking ID refers to a unique identifier assigned to a specific booking or reservation. The booking ID is used to track and manage the booking throughout the booking process, from the initial request to the final confirmation or completion of the reservation. |
Sample Response to Get Booking by ID
{
"acknowledgementStatus": "string",
"allowedRequesterActions": [
"string"
],
"allowedServiceProviderActions": [
"string"
],
"availableBookings": [
{
"equipmentType": "string",
"linkedShipmentsCount": 0,
"totalEquipmentQuantity": 0
}
],
"billingType": "string",
"bookingAttachments": [
{
"attachmentDesc": "string",
"attachmentSource": "string",
"attachmentTitle": "string",
"createDttm": "2022-12-19T04:10:16.855Z",
"docTypeCode": "string",
"filePath": "string",
"fileSize": 0,
"filename": "string",
"id": 0,
"updatedBy": "string",
"updatedDttm": "2022-12-19T04:10:16.855Z",
"updatedOn": "2022-12-19T04:10:16.855Z",
"uploadedBy": "string",
"uploadedOn": "2022-12-19T04:10:16.855Z"
}
],
"bookingCharges": [
{
"basis": "string",
"bookingChargeId": 0,
"chargeCode": "string",
"chargeName": "string",
"currencyCode": "string",
"destination": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"origin": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"rate": 0,
"seqNo": 0,
"type": "string"
}
],
"bookingComments": [
{
"comment": "string",
"createdBy": "string",
"createdOn": "2022-12-19T04:10:16.855Z",
"id": 0,
"type": "string",
"updatedOn": "2022-12-19T04:10:16.855Z"
}
],
"bookingDatetime": "2022-12-19T04:10:16.855Z",
"bookingDetails": [
{
"bookingDetailId": 0,
"commodityClass": "string",
"commodityType": "string",
"containerNumber": "string",
"containerSize": "string",
"containerType": "string",
"createdBy": "string",
"createdOn": "2022-12-19T04:10:16.855Z",
"description": "string",
"dimHeight": 0,
"dimLength": 0,
"dimUoM": "string",
"dimWidth": 0,
"harmonizedCode": "string",
"hazmat": true,
"hazmatDetails": [
{
"bookingDetailHazmatId": 0,
"contactName": "string",
"contactPhone": "string",
"emsCode": "string",
"flashPointUnit": "string",
"flashPointValue": 0,
"hazardousClassification": "string",
"hazardousComment": "string",
"hazardousCommodityDescription": "string",
"hazardousQualifier": "string",
"hazardousSubClassification": "string",
"isLimitedQuantity": true,
"isMarinePollutant": true,
"isResidue": true,
"mfaCode": "string",
"netExplosiveContent": "string",
"nosName": "string",
"outerPackageDescription": "string",
"outerPackageQuantity": 0,
"outerPackageQuantityUom": "string",
"packageGroupCode": "string",
"primaryPlacardCode": "string",
"properShippingName": "string",
"reportableQuantity": true,
"secondaryPlacardCode": "string",
"technicalName": "string",
"unHazmatNumber": "string",
"weight": 0,
"weightUom": "string"
}
],
"marksAndNumbers": "string",
"numberOfPackages": 0,
"packageType": "string",
"packagingForm": "string",
"quantity": 0,
"reeferDetail": {
"additionalServices": "string",
"airExchange": 0,
"atmosphere": "string",
"bookingDetailReeferId": 0,
"co2Level": 0,
"genSet": true,
"humidity": 0,
"maxTemp": 0,
"minTemp": 0,
"nitrogenLevel": 0,
"oxygenLevel": 0,
"tempUnit": "string",
"ventSetting": "string"
},
"refrigerated": true,
"status": "string",
"updatedBy": "string",
"updatedOn": "2022-12-19T04:10:16.855Z",
"volume": 0,
"volumeUoM": "string",
"weight": 0,
"weightType": "string",
"weightUoM": "string"
}
],
"bookingId": 0,
"bookingNumber": "string",
"bookingParties": [
{
"bookingPartyId": 0,
"individual": {
"addressLine1": "string",
"addressLine2": "string",
"addressType": "string",
"city": "string",
"contactType": "string",
"country": "string",
"createdBy": "string",
"createdOn": "2022-12-19T04:10:16.855Z",
"email": "string",
"extension": "string",
"fax": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"postalCode": "string",
"referenceNumber": "string",
"signatureName": "string",
"state": "string",
"updatedBy": "string",
"updatedOn": "2022-12-19T04:10:16.855Z"
},
"organization": {
"addressLine1": "string",
"addressLine2": "string",
"addressType": "string",
"city": "string",
"contactType": "string",
"country": "string",
"createdBy": "string",
"createdOn": "2022-12-19T04:10:16.855Z",
"email": "string",
"extension": "string",
"fax": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"orgCode": "string",
"orgName": "string",
"parentOrgCode": "string",
"phone": "string",
"postalCode": "string",
"referenceNumber": "string",
"signatureName": "string",
"state": "string",
"updatedBy": "string",
"updatedOn": "2022-12-19T04:10:16.855Z"
},
"party": "string"
}
],
"bookingReferences": [
{
"group": "string",
"id": 0,
"name": "string",
"type": "string",
"value": "string"
}
],
"bookingShipments": [
{
"bookingId": 0,
"bookingShipmentId": 0,
"equipmentNumber": "string",
"equipmentType": "string",
"isE2E": true,
"shipmentId": 0,
"shipmentNumber": "string"
}
],
"cancelledDatetime": "2022-12-19T04:10:16.855Z",
"cargoDescription": "string",
"cargoType": "string",
"carrierBookingOffice": "string",
"changedInConfirmation": true,
"changesList": [
{
"field": "string",
"message": "string",
"modifiedBy": "string",
"modifiedOn": "2022-12-19T04:10:16.855Z",
"newValue": "string",
"oldValue": "string",
"section": "string"
}
],
"confirmationChangeAcknowledged": true,
"confirmedDatetime": "2022-12-19T04:10:16.855Z",
"contractNumber": "string",
"createdBy": "string",
"createdOn": "2022-12-19T04:10:16.855Z",
"customAttributes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"customer": {
"code": "string",
"id": "string",
"name": "string"
},
"cutoffDate": "2022-12-19T04:10:16.855Z",
"deliveryDate": "2022-12-19T04:10:16.855Z",
"destination": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"destinationZone": "string",
"direct": true,
"documentationCutoffDate": "2022-12-19T04:10:16.855Z",
"earliestReceiptDate": "2022-12-19T04:10:16.855Z",
"houseBooking": true,
"houseWaybillNumber": "string",
"incoterm": "string",
"isFeederVesselFirst": true,
"masterWaybillNumber": "string",
"mode": "string",
"moveType": "string",
"origin": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"originZone": "string",
"originator": {
"code": "string",
"id": "string",
"name": "string"
},
"paymentTerm": "string",
"pickupDate": "2022-12-19T04:10:16.855Z",
"placeOfDelivery": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"placeOfReceipt": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"portOfDischarge": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"portOfLoading": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"priority": "string",
"receiver": {
"code": "string",
"id": "string",
"name": "string"
},
"rejectedDatetime": "2022-12-19T04:10:16.855Z",
"requestNumber": "string",
"sailDate": "2022-12-19T04:10:16.855Z",
"serviceCode": "string",
"serviceProvider": {
"code": "string",
"id": "string",
"name": "string"
},
"serviceType": "string",
"source": "string",
"status": "string",
"stringifiedCustomAttributes": "string",
"supplier": {
"code": "string",
"id": "string",
"name": "string"
},
"template": true,
"templateName": "string",
"transitDate": "2022-12-19T04:10:16.855Z",
"transitPort": {
"address1": "string",
"address2": "string",
"city": "string",
"code": "string",
"country": "string",
"name": "string",
"plusCode": "string",
"postalCode": "string",
"state": "string",
"timezone": "string",
"type": "string",
"unloccode": "string",
"uuid": "string"
},
"transitServiceCode": "string",
"transitVesselCode": "string",
"transitVesselName": "string",
"transitVoyageNumber": "string",
"updatedBy": "string",
"updatedOn": "2022-12-19T04:10:16.855Z",
"vesselCode": "string",
"vesselName": "string",
"vgmCutoffDate": "2022-12-19T04:10:16.855Z",
"voyageNumber": "string"
}