Skip to main content
POST
Preview Trip Schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Preview trip schedule payload

routeId
string<uuid>
required

Route identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d"

transportOperatorId
string<uuid>
required

Transport operator identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3c"

vehicleId
string<uuid>
required

Vehicle identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3d"

driverId
string<uuid>
required

Driver identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3e"

name
string
required

Trip schedule name

Example:

"São Paulo to Campinas daily morning"

frequency
enum<string>
required

Trip schedule frequency

Available options:
DAILY,
WEEKLY,
MONTHLY
Example:

"DAILY"

departureAt
string<date-time>
required

First scheduled departure

Example:

"2026-04-15T08:00:00.000Z"

stops
object[]
required

Trip schedule stops

Minimum array length: 2
itineraries
object[]
required

Trip schedule itineraries

Minimum array length: 1
interval
integer

Frequency interval

Example:

1

endAt
string<date-time> | null

Optional recurrence end

Example:

"2026-12-31T23:59:59.000Z"

Response

OK

status
enum<string>
required

Materialization status of a candidate trip

Available options:
MATERIALIZABLE,
CONFLICT,
DUPLICATE,
BLOCKED
Example:

"MATERIALIZABLE"

description
string | null
required

Conflict reason when not materializable

Example:

"Driver already booked in this period"

departureAt
string<date-time>
required

Departure time

Example:

"2026-04-15T08:00:00.000Z"

estimatedArrivalAt
string<date-time>
required

Estimated arrival time

Example:

"2026-04-15T14:00:00.000Z"