PRproject44
Multi-Modal: Booking

Cancel Booking

As a shipper, change a booking's status to CANCELLED. A shipper may cancel a booking at any time.

post/services/booking/v1/bookings/{bookingId}/cancellations

Request

Path parameters

bookingIdstring uuid required

The project44-generated booking identifier

Response

Successful Response

automatedFailureReason'ERROR_CREDENTIALS' | 'NO_RESPONSE_CARRIER' | 'INTERNAL_ERROR_CARRIER' | 'UNKNOWN_ERROR_CARRIER' | 'INTERNAL_ERROR_VCS' | 'UNKNOWN_ERROR_VCS' | 'UNSUPPORTED_EQUIPMENT_TYPE' | 'UNSUPPORTED_MODE' | 'UNSUPPORTED_COUNTRY' | 'UNSUPPORTED_STOP_TYPE' | 'MISSING_DATA' | 'INVALID_DATA'

An enumeration.

bookingSourceMethod'API' | 'WEBAPP'

Method by which a shipper initiates a request for a booking.

carrierResponseMethod'API' | 'EDI' | 'EMAIL'

Method by which a carrier responds to bookings.

carrierRejectionNotesstring

A free-text space for the carrier to provide extra information as to why they may reject the booking request.

createdDateTimestring date-time

The datetime when the booking was created.

expirationDateTimestring date-time

The datetime of expiration for this request from the shipper to the carrier. A timezone offset is required.

idstring uuid

The project44-generated identifier for the booking.

lastModifiedDateTimestring date-time

The datetime when the booking was last updated.

lastAcceptedDateTimestring date-time

The datetime when the booking was last accepted.

masterShipmentIdstring uuid

Once BOOKED, the booking initiates a tracked shipment within project44. With this identifier, the shipper may seek the trackable shipment through the rest of the project44 platform.

notesstring

An optional, shipper-provided free-text space for notes on the shipment.

routeSegmentIdsstring[]

List of route-segment ids which apply to the booking.

rateRequestIdstring uuid

Optional Project44 generated UUID identifier of the rate request from the Rating API related to the booking.

rejectionReason'COST_NOT_AGREED' | 'SHORT_ON_STAFF' | 'NOT_WITHIN_SCOPE' | 'TRANSIT_TIME_TOO_SHORT' | 'REQUESTED_EQUIPMENT_NOT_AVAILABLE' | 'OTHER'

The reason a carrier may opt not to accept a booking from a shipper.

shipmentIdstring uuid

The project44-generated identifier for the shipment which parents the booking. Optional when created with a Shipment in one request. Required when creating a booking separately.

status'PROCESSING' | 'UNDER_REVIEW' | 'BOOKED' | 'REJECTED' | 'CANCELLED' | 'EXPIRED'

A descriptive state for a booking. Bookings start out in a PROCESSING state, only to be BOOKED or REJECTED by a carrier. A booking may enter the UNDER_REVIEW state after PROCESSING if the response must be polled after request. The state may shift to CANCELLED due to actions caused by either party in any state. A booking is EXPIRED if it sits in the PROCESSING or UNDER_REVIEW status upon the time which it is set to expire.

transportationMode'OCEAN' | 'AIR' | 'RAIL' | 'TRUCKLOAD' | 'LTL' | 'VOLUME_LTL'

An enumeration.

Changes

No recorded changes to this operation across all 1 revision of this API.