Unassigned Stops

Retrieve an unassigned stop

get/unassignedStops/{unassignedStopId}

Request

Base URL
https://api.spoke.com/public/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/spoke/apis/spoke-api/docs/unassignedStops/:unassignedStopId/get.ts
A function with typed inputs. Its response is checked against the schema.

unassignedStopIdstring required

The unassigned stop id

The requested unassigned stop

idstring required

depotstring required

The depot that this unassigned stop belongs to.

barcodesstring[] required

List of Barcode IDs associated with the stop.

allowedDriversstring[] required

The driver IDs that can be assigned to this stop.

notesstring nullable required

Notes for the stop.

packageCountnumber nullable required

The number of packages.

activity'delivery' | 'pickup'

trackingLinkstring nullable required

The recipient tracking link.

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

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