SPspoke
Stops

Create a new stop

Create a new stop with the given data. Prefer using the batch import endpoint if you want to create multiple stops at once as it is more efficient and will produce better geocoding results. If the plan is not writable, this will fail, prefer using the Live Create Stop API instead.

post/plans/{planId}/stops

Request

Path parameters

planIdstring required

The plan id

Request body

allowedDriversstring[] nullable

Driver IDs that are allowed to be assigned to this stop. These drivers must be configured as part of the plan to be valid.

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 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.