Driver Complete API

Complete a route step with document submission, or update the document of a completed route step.

When all steps are completed, the encapsulating route’s status will change to completed automatically.

Either Session Token must be provided to authenticate the request.

patch/fleetify/routes/{routeID}/steps/{stepID}

Request

Base URL
https://api.nextbillion.io
Auth
API key in query parameter key
TypeScript
https://skmtc.dev/nextbillion-ai/apis/one-spec-service/docs/fleetify/routes/:routeID/steps/:stepID/patch.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

keystring required

A key is a unique identifier that is required to authenticate a request to the API.

Request body

modestring

Sets the status of the route step. Currently only completed is supported.

Note: once marked completed, a step cannot transition to other statuses. You can only update the document afterwards.

statusstring

Sets the status of the route step. Currently only completed is supported.

Note: once marked completed, a step cannot transition to other statuses. You can only update the document afterwards.

documentDocumentSubmission

A key-value map storing form submission data, where keys correspond to field labels and values can be of any type depend on the type of according document item.

Changes

No recorded changes to this operation across all 15 revisions of this API.