SPspoke
Unassigned Stops

Create a new unassigned stop

Create a new unassigned stop with the given data.

post/unassignedStops

Request

Request body

depotstring nullable

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

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

clientIdstring nullable

Client ID of the retailer in Spoke Connect

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.

Response

The created unassignedStop

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.