Client ConsoleDevelopment Console
API Reference

Create new trip(s).

post
https://api.interplai.io/v2/zones//trips

Create a new trip, or trips, within a zone. An array of up to 500 trips can be submitted in one API call.

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

Interplai-specified identifier of the zone.

Body Params

A trip is an ask for a vehicle to be assigned to transport cargo or people. A trip specifies waypoints, which contain locations and actions in a sequence, that must be fulfilled. Interplai processes the trip and recommends a route.

string

User-specified identifier of the trip.

int32
≥ 2
Defaults to 4

Maximum number of locations that can be visited in a route.

string
enum
required

The delivery scenario used when optimizing the trip.

none : no restrictions on the delivery scenario.

spsd : single pickup and single drop-off.

spmd : single pickup and multi drop-off.

mpsd : multi pickup and single drop-off.

mpmd : muti pickup and multi drop-off.

Allowed:
string

Interplai-specific identifier of the vehicle to be manually assigned.

optimizationTimeWindow
object

Time interval during which an optimization solution can be produced for the trip. Once the time interval has expired, the trip will no longer be optimized and a new trip will need to be created.

excludedVehicles
array of objects

Vehicles in this array will not be assigned to the optimization solution for this trip.

excludedVehicles
services
array of objects

A service is the category of mobility task a vehicle will be expected to carry out. Examples include food, flowers, laundry, etc.

services
waypoints
array of objects
required

Array of waypoints with the sequence order.

waypoints*
manifests
array of objects
manifests
mobileApp
object

Mobile app trip

transportationProviderPay
object

Trip handling fees charged by the provider.

Responses

Updated about 1 year ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago