These docs are for v1.1. Click to read the latest docs for v2.0.

Warehouse routing

Input

The goal of the routing API is to return the fastest route between two locations in the warehouse.

Request

The request is composed by the graph UUID, the origin node and the destination node.

PropertyTypeDescription
graphstring (UUID)The UUID of the graph where to calculate the path
fromstringThe name of the starting node of the path
tostringThe name of the destination node

Response

PropertyTypeDescription
patharray of stringA list of node names describing the nodes that have to be traversed to go from the origin to the destination
distanceintegerThe length of the path

Example

curl --request POST --url https://onpick.solvice.io/router/route \
		 -H "Authorization: <<apiKey>>" \
     --data '
{
     "graph": "00000000-0000-0000-0000-000000000000",
     "from": "node-0-0",
     "to": "node-4-0"
}
'
{
	"path": [
		"node-0-0",
		"node-1-0",
		"node-2-0",
		"node-3-0",
		"node-4-0"
	],
	"distance": 150.0
}