API Reference

Generate one or more quotes

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

Generate one or more quotes

📘

The rate limit for this API is normal.

Body Params

Request for transportation services offer

origin
object
required

Journey origin location

destination
object
required

Journey destination location

int32
≥ 0
deprecated

Use capacityRequirement instead. Optional indication of positive load value (default = 1)

capacityRequirement
object

Number of regular seats and wheelchair spaces

string

Optional desired journey start time (mutually exclusive with desiredJourneyFinishTime, ASAP if both empty)

string

Optional desired journey finish time (mutually exclusive with desiredJourneyStartTime)

double
≥ 0

Optional maximum walking distance in meters for services involving transfers (stop-based)

serviceOptions
array of objects

Origin and destination overrides for specific stop-based services

serviceOptions
customJourneyTimeDeviations
object

Optional custom time window settings to override default service ones

string
enum

Optional filter-out of services outside of their service hours (default = disabled, all services are returned)

Allowed:
string
enum

Optional filter-out of services outside the pickup or dropoff points (default = disabled, all services are returned)

Allowed:
passengerFareOptions
array of objects

Optional set of fare option ids associated to the quote's passengers. The ids are organization-specific and are communicated during the customer onboarding. The array should contain an entry for each passenger defined in capacityRequirement. If no fare option is specified for a passenger, only the index should be provided

passengerFareOptions
Headers
uuid
required

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

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?