/tours/{tourId}/actions

post

https://api.dev.orbit.do/v5/tours/{tourId}/actions

Create and execute a tour action. Supported types include the standard CreateTourActionRequest and rebuild operations: 'rebuild-rearrange', 'rebuild-route-shipments', 'rebuild-unroute-shipments', 'rebuild-reorder-stops'. Rebuild actions accept 'fragmentGroups', route/unroute shipments atomically, update stop indices, and handle document link propagation/unpropagation for affected shipments on the tour. The 'rebuild-reorder-stops' action allows carriers to reorder incomplete stops within a tour by specifying a stop index and target position ('after-next' or 'end').

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

More details for the "review" action can be found in our documentation

Path Params

tourId

string

required

Body Params

request to create tour action

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*

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

401

unauthorized

200updated tour