SPspoke
Unassigned Stops

Update an existing unassigned stop

Does not support updating a unassigned stop's location, nor the clientId. To do so, delete the unassignedStop and create a new one.

patch/unassignedStops/{unassignedStopId}

Request

Path parameters

unassignedStopIdstring required

The unassigned stop id

Request body

allowedDriversstring[] nullable

Driver IDs that are allowed to be assigned to this stop. If not provided, the stop will be assigned to any available driver during optimization.

activity'delivery' | 'pickup' nullable

Activity type

optimizationOrder'first' | 'last' | 'default' nullable

The preferred order of this stop in the optimized route. If not provided or "default", the stop will be placed in the optimal order, decided by the optimization algorithm. Otherwise it will be placed either "first" or "last".

packageCountnumber nullable

Number of packages in the stop

notesstring nullable

Notes for the stop

barcodesstring[]

List of barcode IDs associated with this stop

customPropertiesobject nullable

Key-value pairs of custom stop properties for this stop. The keys must be unique and match a custom stop property defined in your team.

depotstring nullable

The Depot ID that this unassigned stop belongs to, in the format depot/<id>. If null, it will default to the team's main depot. If not provided, it will not be updated.

Response

The updated 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

Changes

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