API Reference

Create a booking

post
https://people-mobility.api.eu1.scalar.zf.com/v1/bookings

Create a booking associated to a quote previously generated

📘

The rate limit for this API is small.


Body Params

Request for booking a transportation service

uuid
required

Quote unique identifier

traveler
object
required

Traveler unique identifier

string
enum

API client type

Allowed:
paymentMethods
array of strings
paymentMethods
Allowed:
customProperties
object

Custom JSON payload, persisted as-is in the database, not interpreted; must not include PII

bookerProfile
object

Custom JSON payload, persisted as-is in the database, not interpreted; must not include PII

billToParty
object

Custom JSON payload, persisted as-is in the database, not interpreted; must not include PII

uuid

Externally-provided unique booking identifier (the request is rejected if booking already exists)

bookedFare
object

Optional fare that for a Completed booking overrides the actualFare

Headers
uuid
required

Identifier generated by the client in order to ensure idempotency when creating a booking

Responses

429

Failure code. Too many incoming requests.

Updated 10 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

Did this page help you?