DCSA Standards Public Reference / Standards / Releases / Booking / Archive / Booking v2.0.4
DCSA BKG 2.0.4 - Endpoint Overview
Archived release: Booking v2.0.4 has been superseded. View the current v2 documentation.
This table maps each Booking use case to the operation that initiates or communicates it. The Carrier implements the Booking resource endpoints. A Shipper that subscribes to notifications implements the Booking Notifications endpoint; notification subscription and registration are outside the API contract.
| Use case | Initiated by | Carrier endpoint | Shipper notification endpoint |
|---|---|---|---|
| UC1: Submit Booking request | Shipper | POST /v2/bookings | POST /v2/booking-notifications after asynchronous processing, when notifications are supported |
| UC2: Request to update Booking request | Carrier | Carrier-side business action | POST /v2/booking-notifications |
| UC3: Submit updated Booking request | Shipper | PUT /v2/bookings/{bookingReference} | POST /v2/booking-notifications after asynchronous processing, when notifications are supported |
| UC4: Reject Booking request | Carrier | Carrier-side business action | POST /v2/booking-notifications |
| UC5: Confirm Booking request | Carrier | Carrier-side business action | POST /v2/booking-notifications |
| UC6: Request to amend confirmed Booking | Carrier | Carrier-side business action | POST /v2/booking-notifications |
| UC7: Request amendment to confirmed Booking | Shipper, Consignee, or Endorsee | PUT /v2/bookings/{bookingReference} | POST /v2/booking-notifications after asynchronous processing, when notifications are supported |
| UC8: Process amendment to confirmed Booking | Carrier | Carrier-side business action | POST /v2/booking-notifications |
| UC9: Cancel amendment to confirmed Booking | Shipper, Consignee, or Endorsee | PATCH /v2/bookings/{bookingReference} | POST /v2/booking-notifications after asynchronous processing, when notifications are supported |
| UC10: Decline Booking by Carrier | Carrier | Carrier-side business action | POST /v2/booking-notifications |
| UC11: Cancel Booking request by Shipper | Shipper | PATCH /v2/bookings/{bookingReference} | POST /v2/booking-notifications after asynchronous processing, when notifications are supported |
| UC12: Confirm Booking completed | Carrier | Carrier-side business action | POST /v2/booking-notifications |
| UC13: Cancel confirmed Booking by Shipper | Shipper | PATCH /v2/bookings/{bookingReference} | POST /v2/booking-notifications after asynchronous processing, when notifications are supported |
| UC14: Process Booking cancellation | Carrier | Carrier-side business action | POST /v2/booking-notifications |
GET /v2/bookings/{bookingReference} retrieves the latest Booking content and state by Carrier Booking Request Reference or Carrier Booking Reference. It supports the use cases throughout the lifecycle but does not itself initiate a use case.
See the OpenAPI specification for parameters, request and response schemas, and HTTP response behavior.