Mark a reservation as ready for pick-up

Flags an open reservation as prepared for pick-up. The status stays open; the reservation gets ready_for_pick_up = true, and the API user and the current time are saved as ready_for_pick_up_approval_user_id and ready_for_pick_up_at. Any other status returns a business error.

Unlike the other status endpoints, the response is the full reservation overview, the same shape as GET /car-rental/reservations/{reservation_id} without vehicles, replacements, extensions and signature_pages.

Responses

🟢200OK

application/json

The reservation overview, or a business error with success: false when the reservation is not open. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorBusinessRule (status_code 410) or an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": false,
    "status_code": 410,
    "errors": {
        "error_message": "Ready for pickup not allowed"
    },
    "data": {
        "reservation": {
            "id": 1052,
            "prefixed_id": "MIA1052",
            "status": "rental"
        }
    }
}

🟠404Record Not Found

Mark a reservation as ready for pick-up

Request

Responses