You can explore the OpenAPI specification in the API Reference.
Available routes could be either already known by the client or fetched via GET /search/routes
endpoint.
To get list of journey offers (generalized name for any kind of journey offer like a ferry or flight, fare etc.) for a route, client should call POST /search/offers
endpoint with route, basic passenger and vehicle information etc.
After visitor selects an offer, it's possible to get the list of resources available for the offer via POST /resources/offer-resources
endpoint.
Note: Client would need to pass the whole offer object to this endpoint.
No API calls are needed. Client should collect additional information from the visitor into the CreateBookingRequest
object. This includes detailed information about passengers, vehicles, pets and resources.
Any selected resources could be added to the list of resources on the Offer
object
Note: Resources already present in the offer object should be treated as "required" and shouldn't be removed.
Before making a booking request, client can call POST /booking/confirm-prices
endpoint to confirm availability and prices for the chosen combination of offers, passengers and resources. (This step is optional and not implemented yet.)
To book one or several offers, client should collect additional information from the visitor into the CreateBookingRequest
object and send it to the POST /booking
endpoint.
Note: It's possible to book multiple offers in one request. It will always return a list of bookings.
Booking cancellation is possible via DELETE /booking/{bookingNumber}/{bookingRevision}
endpoint.
Information about cancellation charges is available at GET /booking/{bookingNumber}/{bookingRevision}/cancel-charges
endpoint.