Sign in
Trips

Create new trip

Create new trip

post/apis/stork-api/trips

Request body

tripDefinitionstring required
scheduledStartstring required
tripCodestring required
delayedYellowstring
delayedRedstring
pendingColorstring
finishedColorstring
scheduledFinishstring required
tripLifetimestring
tripStartedLifetimestring
vehicleIdstring
vehicleExternalIdstring
driverIdstring
driverExternalIdstring
carrierIdstring
carrierExternalIdstring
terminalNamestring
maxDrivingTimenumber
drivingTimeWindowTolerancenumber
metersWithoutOptionsnumber
finishOnLastCheckpointStepboolean
forceShowLastCheckpointNextboolean
drivenTimenumber
ttlFinishedTripsstring
tagsstring[]

Example request

{
  "scheduledStart": "2024-05-27T16:19:20.702+00:00",
  "checkpoints": [
    {
      "steps": [
        {
          "plannedAt": "2024-05-27T06:00:00.000+00:00"
        }
      ]
    }
  ],
  "scheduledFinish": "2024-05-28T16:19:20.702+00:00"
}

Response

isDeletedboolean
deletedAtstring
idstring required
organizationIdstring required
realStartstring required
tripDefinitionstring required
delayedYellowstring required
delayedRedstring required
pendingColorstring required
finishedColorstring required
scheduledStartstring required
scheduledFinishstring required
realFinishstring required
finishReasonstring required
finishBystring required
localestring required
tripLifetimestring required
tripStartedLifetimestring required
tripCodestring required
totalDelaynumber required
terminalNamestring required
metersnumber required
minPercentagenumber required
maxPercentagenumber required
maxDrivingTimenumber required
restingTimenumber required
drivingTimeWindowTolerancenumber required
metersWithoutOptionsnumber required
finishOnLastCheckpointStepboolean required
forceShowLastCheckpointNextboolean required
stoppedboolean required
stoppedTimeIntransitToFirstCheckpointnumber required
drivenTimenumber
drivingTimeWindowstring[]
ttlFinishedTripsstring required
alertsstring[] required
logsstring[] required
hashstring required
reportingTypeobject required
tagsstring[] required

Changes

No recorded changes to this endpoint across all 1 revision of this API.