Stops

Retrieve a stop

Retrieve a stop

get/plans/{planId}/stops/{stopId}

Request

Path parameters

planIdstring required

The plan id

stopIdstring required

The stop id

Response

The requested stop

idstring required
barcodesstring[] required

List of Barcode IDs associated with the stop.

allowedDriversstring[] required

The driver IDs that can be assigned to this stop

estimatedTravelDurationnumber nullable required

Estimated time that the driver will take to arrive at this stop from the previous stop in seconds.

estimatedTravelDistancenumber nullable required

The distance in meters between the previous stop and this stop.

notesstring nullable required

Notes for the stop.

packageCountnumber nullable required

The number of packages.

type'start' | 'stop' | 'end' required

The type of the stop. start is the first stop of the route, stop is a stop in the middle of the route, and end is the last stop of the route.

packageLabelstring nullable required

The label of the package.

stopPositionnumber nullable required

The position of the stop in the route.

trackingLinkstring nullable required

The recipient tracking link.

webAppLinkstring required

The web app link.

activity'delivery' | 'pickup'
planstring required
optimizationOrder'first' | 'last' | 'default'
customPropertiesobject nullable required

Custom properties of the stop, can be used to store additional information.

clientIdstring nullable required

The associated Client ID of the Spoke Connect

Changes

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