Update trips.

patch

https://api.interplai.io/v2/zones/{zoneId}/trips

Submit a patch to update an existing trip, or trips, within a zone. An array of up to 500 trip updates can be submitted in one API call.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

zoneId

string

required

Interplai-specified identifier of the zone.

Body Params

A trip is an ask for a route to be created in a zone that a vehicle can travel by going to each of the specified waypoints. A location is a position in the zone defined by its latitude and longitude coordinates, that may specify a business, customer, or other entity.

string

required

Interplai-specified identifier.

maxStopsAllowed

int32

≥ 2

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

routingScenarioMode

string

enum

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:

manuallyAssignedVehicleId

string

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

optimizationTimeWindow

object

Time interval during which a 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

customerRating

integer

The rating given by the customer to the driver.

customerFeedback

string

Feedback given by the customer to the driver for delivering the trip.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Updated trips.

400Bad request.

401Invalid API key.

404Not found - zone or location.