API Reference
Log In
API Reference

/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. Each stop is placed at its loading point when address.shipperAddressLoadingPoint has latitude and longitude, else at the address latitude and longitude you send, else at the geocoded address.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

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

The stop's address. When shipperAddressLoadingPoint has latitude and longitude, the stop is placed at that loading point, the same position shipments to this address use. Otherwise latitude and longitude, when provided, are stored as the stop's authoritative position; when absent, the address is geocoded. Sending the exact coordinates your shipments carry keeps a kept stop and its incoming freight recognized as one site.

number
required
≥ 0

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

number
required
≥ 0

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

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:
string

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

address
object
required

The stop's address. When shipperAddressLoadingPoint has latitude and longitude, the stop is placed at that loading point, the same position shipments to this address use. Otherwise latitude and longitude, when provided, are stored as the stop's authoritative position; when absent, the address is geocoded. Sending the exact coordinates your shipments carry keeps a kept stop and its incoming freight recognized as one site.

number
required
≥ 0

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

number
required
≥ 0

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

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:
string

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

string
required

Internal VehicleClass id (UUID) for the tour.

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
string
string

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

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.

string
enum

When set to preserve, rebuilds keep the created stops even when they carry no freight, until a rebuild with the purge override sweeps them or a rearrange omits them. When omitted or purge, rebuilds derive stops from freight alone (the default behavior).

Allowed:
Responses

400

validation error or invalid vehicleClassId

401

unauthorized

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?