/tours/actions

post

https://api.dev.orbit.do/v5/tours/actions

Create a new tour by submitting a create-action payload. Accepts a 'create' type action with stops, vehicleClassId, and region. Stop addresses are geocoded server-side; do not send latitude/longitude — they are not part of the schema and will be ignored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create-action payload (type='create', stops[min 2], vehicleClassId, region required)

type

string

enum

required

Allowed:

stops

array of objects

required

length ≥ 2

The tour's stops in execution order; at least two are required (a pickup and a dropoff).

stops*

address

object

required

timeFrom

number

required

≥ 0

Epoch-seconds timestamp for the start of this stop's planned arrival window, interpreted in Europe/Berlin.

timeTo

number

required

≥ 0

Epoch-seconds timestamp for the end of this stop's planned arrival window, interpreted in Europe/Berlin.

expectedWaitingTime

number

≥ 0

Expected time spent at this stop, in seconds.

pickupDocuments

array of objects

pickupDocuments

proofRequirements

array of strings

Proof types the driver must capture at this stop before completing it.

proofRequirements

Allowed:

note

string

Free-text note for this stop, shown to the driver.

address

object

required

timeFrom

number

required

≥ 0

Epoch-seconds timestamp for the start of this stop's planned arrival window, interpreted in Europe/Berlin.

timeTo

number

required

≥ 0

Epoch-seconds timestamp for the end of this stop's planned arrival window, interpreted in Europe/Berlin.

expectedWaitingTime

number

≥ 0

Expected time spent at this stop, in seconds.

pickupDocuments

array of objects

pickupDocuments

proofRequirements

array of strings

Proof types the driver must capture at this stop before completing it.

proofRequirements

Allowed:

note

string

Free-text note for this stop, shown to the driver.

vehicleClassId

string

required

Internal VehicleClass id (UUID) for the tour.

region

string

required

length ≥ 1

The operational region, given as the region's identifier (a slug such as "berlin"), not its UUID id.

extras

array

extras

displayName

string

comment

string

Public comment on the tour (visible to the carrier).

internalComment

string

Internal comment on the tour (operator-only).

carrierInfo

object

Optional carrier assignment at creation; providing a carrierId makes the tour start Assigned rather than Unassigned.

Responses

400

validation error or invalid vehicleClassId

401

unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200created tour