Check Out a Carpool Booking
POST/carpool/bookings/:booking_id/check-out
Hands the vehicle of an approved booking to its driver and starts the booking now. This operation is available to the main account only. The request has no body.
| Current status | Result |
|---|---|
APPROVED | The booking becomes ACTIVE. |
APPROVED, vehicle starts its bookings when the key is collected, and the account uses key collection | 409 with CARPOOL_BOOKING_METHOD_CONFLICT. Nothing is changed. |
| Any other status | 409 with CARPOOL_BOOKING_STATE_CONFLICT. Nothing is changed. |
No completed driver checklist is required. A vehicle whose bookings start when the driver completes the pre-trip checklist can still be checked out manually.
No notification is sent.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 422
- 429
- 500
- 503
The checked out booking.
Unauthorized access. Authentication is required.
The operation requires main account credentials. Valid subusers receive this response.
The requested resource was not found.
The booking cannot take this step. Either its current status does not permit it, or its vehicle starts or ends bookings on its own through the vehicle's booking start and stop method. Nothing was changed.
Validation failed for the input parameters.
Too Many Requests - the endpoint's rate limit has been exceeded. Retry after the number of seconds in the Retry-After header.
Response Headers
Seconds to wait before retrying. The same value as X-RateLimit-Retry-After-Seconds when that wait is non-negative. If the computed wait is negative, Retry-After is floored at 0.
Unix timestamp of the next earliest successful request.
Seconds until the next earliest successful request.
Internal server error.
Service temporarily unavailable. The request did not complete and can be retried after the number of seconds in the Retry-After header, when one is sent.
Response Headers
Seconds to wait before retrying. Sent with db_busy and db_pool_timeout.