API Reference

A modern, RESTful API for integrating with Caradise’s vehicle-rental operations.

Caradise Broker REST API

The Caradise Broker REST API replaces legacy SOAP services, providing greater efficiency, scalability, and ease of integration.

Key Features

Reservation Management: create, modify, retrieve, and cancel reservations.
Vehicle Availability: check real-time prices and availability by location, date, and driver age.
Location Services: list rental stations and available extras/insurance options.
Pricing and Rates: obtain detailed rate information for rentals.

Security

Access is secured with bearer authentication. Need an API key? Contact it@surpricemobility.com.

Integration & Usage

The API’s flexible design lets brokers integrate seamlessly, enabling smooth booking management from availability checks through confirmations, amendments, and cancellations.

Default Workflow

Check availability — POST /v1/availability
Returns vehicle groups their prices, and their vendorRateId for the search criteria.
Create reservation — POST /v1/reservation
Submit the chosen vehicle group and vendorRateId; initial status is confirmed.
Amend / Cancel
POST /v1/reservation/{orderId}/amend (amend) or POST /v1/reservation/{orderId}/cancel (cancel) — an amended reservation enters the pending state if critical information have changed.
Confirm / Ignore
POST /v1/reservation/{orderId}/commit (confirm) or POST /v1/reservation/{orderId}/ignore (ignore)

Notes

Ignoring will automatically return the reservation to its previous state.
Committed reservations stay active unless later amended or canceled.
Amendments with critical changes must be confirmed with commit.
“Corporate Order ID” is always the CRXXXXXXXXX value that uniquely identifies a Caradise order.

Last modified: 07 August 2025