Cancel One to Many Ocean Bookings
Cancel a single booking or all bookings for a shipment.
Cancel an Ocean Booking
Change a booking's status to CANCELLED. You may cancel a booking at any time.
Requirements
At a minimum, have the following information
- Booking ID (The
idreturned in the Book a Shipment response, or thebooking.idreturned in the Create a Shipment with a Booking Request response.)
Workflow
Complete these steps:
- Prepare a
POSTrequest to /services/booking/v1/bookings/{bookingId}/cancellations. Please, connect with your project44 Technical Contact for the Booking API Reference Documentation. - Add the Booking ID.
- Send the request.
Expected System Responses
The request is successfully submitted and confirmed when a 200 response is received.
JSON
{ "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf", "attributes": [ { "name": "string", "values": [ "string" ] } ], "capacityProviderIdentifier": { "type": "SCAC", "value": "string" }, "carrierContacts": [ { "companyName": "string", "givenName": "string", "familyName": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "email": "user@example.com" } ], "totalRate": { "currency": "USD", "amount": 0 }, "rateIdentifiers": [ { "source": "SYSTEM", "type": "SPOT_QUOTE", "value": "string" } ], "expirationDateTime": "2019-08-24T14:15:22Z", "routeSegmentIds": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "notes": "string", "shipmentDetails": [ { "pickupStopId": "eff50f2a-8964-41f9-b45d-0a4f6f94e159", "deliveryStopId": "2ca57692-0523-4424-a638-167e5e26f7d3", "handlingUnits": { "details": [ { "monetaryValue": { "currency": "USD", "amount": 0 }, "quantity": 0, "handlingUnitType": "BAG", "stackable": false, "dimensions": { "length": 0, "width": 0, "height": 0, "unit": "FT" }, "weight": { "value": 0, "unit": "LB" } } ] }, "items": [ { "description": "string", "identifiers": [ { "type": "CONTAINER_NUMBER", "value": "string" } ], "unitQuantity": 0, "unitType": "BAG" } ], "description": "string", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "accessorials": [ { "code": "REFRIGERATED", "details": { "min": 0, "max": 0, "unit": "CELSIUS" } } ], "loadId": "9fa4c9ea-0db7-4bb2-8f50-086d18a90403" } ], "apiConfiguration": { "bookingWebhookName": "string" }, "shipperContactInfo": { "companyName": "string", "givenName": "string", "familyName": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "email": "user@example.com" }, "shippingDetails": { "loadPreference": "FULL", "trailerType": "FLATBED", "trailerLength": { "value": 0, "unit": "FT" }, "trailerVolume": { "value": 0, "unit": "CUBIC_FT" }, "flatbedType": "CONESTOGA", "accessorials": [ { "code": "REFRIGERATED", "details": { "min": 0, "max": 0, "unit": "CELSIUS" } } ] }, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "PROCESSING", "shipmentIdentifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "routeSegments": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fromStop": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "PICKUP", "arrivalDate": "2019-08-24", "arrivalAppointmentWindow": { "startTime": "14:15:22Z", "endTime": "14:15:22Z" }, "contacts": [ { "companyName": "string", "givenName": "string", "familyName": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "email": "user@example.com" } ], "accessorials": [ { "code": "REFRIGERATED", "details": { "min": 0, "max": 0, "unit": "CELSIUS" } } ], "location": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "addressLines": [ "string" ], "postalCode": "string", "city": "string", "state": "string", "country": "US" }, "geoCoordinates": { "latitude": -90, "longitude": -180 } } }, "toStop": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "PICKUP", "arrivalDate": "2019-08-24", "arrivalAppointmentWindow": { "startTime": "14:15:22Z", "endTime": "14:15:22Z" }, "contacts": [ { "companyName": "string", "givenName": "string", "familyName": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "email": "user@example.com" } ], "accessorials": [ { "code": "REFRIGERATED", "details": { "min": 0, "max": 0, "unit": "CELSIUS" } } ], "location": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "addressLines": [ "string" ], "postalCode": "string", "city": "string", "state": "string", "country": "US" }, "geoCoordinates": { "latitude": -90, "longitude": -180 } } } } ], "rejectionReason": "COST_NOT_AGREED", "carrierResponseMethod": "EMAIL", "automatedFailureReason": "ERROR_CREDENTIALS", "bookingSourceMethod": "API", "carrierRejectionNotes": "string", "transportationMode": "OCEAN", "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "carrierProvidedIdentifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ] }
This is an example of what could be returned in the response. Please, refer to the Booking API Reference Documentation from your project44 Technical Contact for more information on the fields and data that can be returned in this response.
Errors
If there was a problem with your request, you will receive one of the following error codes:
400 Bad Request401 Unauthorized404 Not Found
See Error Response Codes in the Appendix for more information on the meaning of these error codes.
Fields and Objects
The table below describes only the minimum relevant fields of the API Request to cancel a single Ocean booking. For more information on all fields, please, connect with your project44 Technical Contact for the Booking API Reference Documentation.
| Field | Description |
|---|---|
bookingId | The id returned in the Book a Shipment response, or the booking.id returned in the Create a Shipment with a Booking Request response.. |
Cancel All Ocean Bookings for a Multi-modal Shipment
Change the status of all related and eligible Ocean bookings for a shipment to CANCELLED.
Requirements
At a minimum, have the following information
- Shipment ID (The project44-generated shipment identifier (
id) returned in the response for Create a Shipment Containing an Ocean Booking.)
Workflow
Complete these steps:
- Prepare a
POSTrequest to /services/booking/v1/shipments/{shipmentId}/bookings/cancellations. Please, connect with your project44 Technical Contact for the Booking API Reference Documentation. - Add the Shipment ID.
- Send the request.
Expected System Responses
The request is successfully submitted and confirmed when a 200 response is received.
JSON
{ "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "routeInfo": { "stops": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "PICKUP", "arrivalDate": "2019-08-24", "arrivalAppointmentWindow": { "startTime": "14:15:22Z", "endTime": "14:15:22Z" }, "contacts": [ { "companyName": "string", "givenName": "string", "familyName": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "email": "user@example.com" } ], "accessorials": [ { "code": "REFRIGERATED", "details": { "min": 0, "max": 0, "unit": "CELSIUS" } } ], "location": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "addressLines": [ "string" ], "postalCode": "string", "city": "string", "state": "string", "country": "US" }, "geoCoordinates": { "latitude": -90, "longitude": -180 } } }, { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "PICKUP", "arrivalDate": "2019-08-24", "arrivalAppointmentWindow": { "startTime": "14:15:22Z", "endTime": "14:15:22Z" }, "contacts": [ { "companyName": "string", "givenName": "string", "familyName": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "email": "user@example.com" } ], "accessorials": [ { "code": "REFRIGERATED", "details": { "min": 0, "max": 0, "unit": "CELSIUS" } } ], "location": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "identifiers": [ { "type": "AIRPORT_IATA", "value": "string" } ], "address": { "addressLines": [ "string" ], "postalCode": "string", "city": "string", "state": "string", "country": "US" }, "geoCoordinates": { "latitude": -90, "longitude": -180 } } } ], "routeSegments": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fromStopId": "257296aa-4e11-4168-b6a7-981b8b94815b", "toStopId": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56" } ] }, "attributes": [ { "name": "string", "values": [ "string" ] } ], "name": "string", "notes": "string", "bookings": [ { "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf", "attributes": [ { "name": "string", "values": [ "string" ] } ], "capacityProviderIdentifier": { "type": "SCAC", "value": "string" }, "carrierContacts": [ { "companyName": "string", "givenName": "string", "familyName": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "email": "user@example.com" } ], "totalRate": { "currency": "USD", "amount": 0 }, "rateIdentifiers": [ { "source": "SYSTEM", "type": "SPOT_QUOTE", "value": "string" } ], "expirationDateTime": "2019-08-24T14:15:22Z", "routeSegmentIds": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "notes": "string", "shipmentDetails": [ { "pickupStopId": "eff50f2a-8964-41f9-b45d-0a4f6f94e159", "deliveryStopId": "2ca57692-0523-4424-a638-167e5e26f7d3", "handlingUnits": { "details": [ { "monetaryValue": null, "quantity": null, "handlingUnitType": null, "stackable": null, "dimensions": null, "weight": null } ] }, "items": [ { "description": "string", "identifiers": [ null ], "unitQuantity": 0, "unitType": "BAG" } ], "description": "string", "identifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "accessorials": [ { "code": "REFRIGERATED", "details": { "min": null, "max": null, "unit": null } } ], "loadId": "9fa4c9ea-0db7-4bb2-8f50-086d18a90403" } ], "apiConfiguration": { "bookingWebhookName": "string" }, "shipperContactInfo": { "companyName": "string", "givenName": "string", "familyName": "string", "phoneNumber": "string", "mobilePhoneNumber": "string", "email": "user@example.com" }, "shippingDetails": { "loadPreference": "FULL", "trailerType": "FLATBED", "trailerLength": { "value": 0, "unit": "FT" }, "trailerVolume": { "value": 0, "unit": "CUBIC_FT" }, "flatbedType": "CONESTOGA", "accessorials": [ { "code": "REFRIGERATED", "details": { "min": 0, "max": 0, "unit": "CELSIUS" } } ] }, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "PROCESSING", "shipmentIdentifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ], "routeSegments": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fromStop": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "PICKUP", "arrivalDate": "2019-08-24", "arrivalAppointmentWindow": { "startTime": "14:15:22Z", "endTime": "14:15:22Z" }, "contacts": [ { "companyName": null, "givenName": null, "familyName": null, "phoneNumber": null, "mobilePhoneNumber": null, "email": null } ], "accessorials": [ { "code": null, "details": null } ], "location": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "identifiers": [ null ], "address": { "addressLines": [], "postalCode": null, "city": null, "state": null, "country": null }, "geoCoordinates": { "latitude": null, "longitude": null } } }, "toStop": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "PICKUP", "arrivalDate": "2019-08-24", "arrivalAppointmentWindow": { "startTime": "14:15:22Z", "endTime": "14:15:22Z" }, "contacts": [ { "companyName": null, "givenName": null, "familyName": null, "phoneNumber": null, "mobilePhoneNumber": null, "email": null } ], "accessorials": [ { "code": null, "details": null } ], "location": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "identifiers": [ null ], "address": { "addressLines": [], "postalCode": null, "city": null, "state": null, "country": null }, "geoCoordinates": { "latitude": null, "longitude": null } } } } ], "rejectionReason": "COST_NOT_AGREED", "carrierResponseMethod": "EMAIL", "automatedFailureReason": "ERROR_CREDENTIALS", "bookingSourceMethod": "API", "carrierRejectionNotes": "string", "transportationMode": "OCEAN", "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa", "carrierProvidedIdentifiers": [ { "type": "AIR_WAYBILL", "value": "string" } ] } ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }
This is an example of what could be returned in the response. Please, refer to the Booking API Reference Documentation from your project44 Technical Contact for more information on the fields and data that can be returned in this response.
Errors
If there was a problem with your request, you will receive one of the following error codes:
400 Bad Request401 Unauthorized404 Not Found
See Error Response Codes in the Appendix for more information on the meaning of these error codes.
Fields and Objects
The table below describes only the minimum relevant fields of the API Request to cancel all bookings for a shipment. For more information on all fields, please, connect with your project44 Technical Contact for the Booking API Reference Documentation.
| Field | Description |
|---|---|
shipmentId | The project44-generated shipment identifier (id) returned in the response for Create a Shipment response. |