Documentation Powered by ReDoc

Routing API (1)

Download OpenAPI specification:Download

Routing API

Routing

BuildRoutes

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
stopKeys
required
Array of integers or null <int32>
loadType
required
integer <int32>
branchKey
required
integer <int32>
loadDate
required
string <date-time>
name
required
string or null
profileKey
required
integer <int32>
truckKey
required
integer <int32>

Responses

Request samples

Content type
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "stopKeys": [
    ],
  • "loadType": 0,
  • "branchKey": 0,
  • "loadDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "profileKey": 0,
  • "truckKey": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "resourceUrl": "string"
}

CreateRoute

This API endpoint is for creating a new route.

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
branchKey
integer <int32>
loadDate
string <date-time>
name
string or null
profileKey
integer <int32>
truckKey
integer <int32>

Responses

Request samples

Content type
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "branchKey": 0,
  • "loadDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "profileKey": 0,
  • "truckKey": 0
}

Response samples

Content type
application/json
null

DeleteRoute

path Parameters
key
required
string
query Parameters
unloadStops
boolean
Default: "true"

Determines whether or not existing stops on the route will be unloaded before the route is deleted. If this is set to false, then any stops present on the route will also be deleted.

Responses

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

FinalizeRoutes

Request Body schema: application/json
routeKeys
Array of integers

Responses

Request samples

Content type
application/json
{
  • "routeKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

GeocodeOrder

path Parameters
key
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "account": {
    },
  • "accountKeyID": 0,
  • "actuals": {
    },
  • "branchkeyidbackup": 0,
  • "delaystatus": 0,
  • "delaytime": 0,
  • "earliestDate": "2019-08-24T14:15:22Z",
  • "estimate": {
    },
  • "fixedTime": 0,
  • "latestDate": "2019-08-24T14:15:22Z",
  • "leg": 0,
  • "noteKeyid": 0,
  • "orders": [
    ],
  • "plan": {
    },
  • "plannedBreakTime": 0,
  • "plannedDistance": 0,
  • "plannedDuration": 0,
  • "plannedLayoverTime": 0,
  • "plannedWaitTime": 0,
  • "routeKey": 0,
  • "seq": 0,
  • "shipToKeyID": 0,
  • "id": "string",
  • "key": 0,
  • "stopstatuskeyid": 0,
  • "terminal": true,
  • "timeviolation": 0,
  • "timeViolationMinutes": 0,
  • "timeWindows": [
    ],
  • "usingShipToAddress": true,
  • "violations": [
    ],
  • "zone": 0
}

GetAvailableTruckMasters

query Parameters
branchKey
integer
loadDate
string
profileKey
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetRouteConfig

path Parameters
key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

InvertRoute

path Parameters
key
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

InvertRoutes

query Parameters
keys
Array of integers <int32>

Responses

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

LoadOrder

NOTE: Consolidated load-stop and load-order. The services should be able to determine, based on stopKey, whether a stop is unloaded or not. The services can also easily determine the source route (if not unloaded).

path Parameters
key
required
integer <int32>
Request Body schema: application/json
routeKey
integer

Responses

Request samples

Content type
application/json
{
  • "routeKey": 0
}

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

MoveStop

path Parameters
key
required
integer <int32>
Request Body schema: application/json
routeKey
integer
leg
integer
sequence
integer

Responses

Request samples

Content type
application/json
{
  • "routeKey": 0,
  • "leg": 0,
  • "sequence": 0
}

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

MoveStopAsync

path Parameters
key
required
integer <int32>
query Parameters
routeKey
integer
leg
integer
sequence
integer
Request Body schema: application/json
routeKey
integer
leg
integer
sequence
integer

Responses

Request samples

Content type
application/json
{
  • "routeKey": 0,
  • "leg": 0,
  • "sequence": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "resourceUrl": "string"
}

OptimizeBetweenAsync

Request Body schema: application/json
routeKeys
Array of integers
saveToDb
boolean

Responses

Request samples

Content type
application/json
{
  • "routeKeys": [
    ],
  • "saveToDb": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "resourceUrl": "string"
}

OptimizeWithin

Request Body schema: application/json
routeIds
Array of integers
saveToDb
boolean

Responses

Request samples

Content type
application/json
{
  • "routeIds": [
    ],
  • "saveToDb": true
}

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

RescheduleRoute

path Parameters
key
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

SuggestRoutes

path Parameters
key
required
integer <int32>
Request Body schema: application/json
routeKeys
Array of integers

Responses

Request samples

Content type
application/json
{
  • "routeKeys": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

RenameRoute

path Parameters
key
required
integer <int32>
Request Body schema: application/json
routeName
string

Responses

Request samples

Content type
application/json
{
  • "routeName": "string"
}

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

SyncRoutes

Request Body schema: application/json
routeKeys
Array of integers

Responses

Request samples

Content type
application/json
{
  • "routeKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

TrimFakeOrders

NOTE: response type was ApiSolutionStats but should be RouteUpdateResult

Request Body schema: application/json
routeKeys
Array of integers

Responses

Request samples

Content type
application/json
{
  • "routeKeys": [
    ]
}

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

Unload

path Parameters
key
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

UnloadAsync

path Parameters
key
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "resourceUrl": "string"
}

UnloadRoute

path Parameters
key
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

ChangeStartTime

path Parameters
key
required
integer <int32>
Request Body schema: application/json
startDate
string
startTime
string

Given in HH:mm format

Responses

Request samples

Content type
application/json
{
  • "startDate": "string",
  • "startTime": "string"
}

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

UpdateRouteConfig

path Parameters
key
required
string
Request Body schema: application/json
routeConfigName
string
eqCode
string
oneWay
boolean
redispatch
boolean
earlyStart
string
lateStart
string
normalStart
string
latefinish
string
startDate
string
endDate
string
zone
integer
hourlyCost
number
distanceCost
number
dropCost
number
unitCost
number
fixedCost
number
preTrip
integer
postTrip
integer
turnTime
integer
unloadPerformance
number
amStart
string
amEnd
string
amMultiplier
number
pmStart
string
pmEnd
string
pmMultiplier
number
unloadHourCost
number
waitHourCost
number
layoverCost
number
maxWorkTime
number
targetWorkTime
number
maxDriveTime
number
minLayoverTime
number
workDay
number
minHoursRemainingForRedispatch
integer
maxLayovers:
integer
maxDriveTimeBeforeLayover
number
breakStart1
number
breakDuration1
number
breakStart2
number
breakDuration2
number
breakStart3
number
breakDuration3
number
Array of objects
Array of objects
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "routeConfigName": "string",
  • "eqCode": "string",
  • "oneWay": true,
  • "redispatch": true,
  • "earlyStart": "string",
  • "lateStart": "string",
  • "normalStart": "string",
  • "latefinish": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "zone": 0,
  • "hourlyCost": 0,
  • "distanceCost": 0,
  • "dropCost": 0,
  • "unitCost": 0,
  • "fixedCost": 0,
  • "preTrip": 0,
  • "postTrip": 0,
  • "turnTime": 0,
  • "unloadPerformance": 0,
  • "amStart": "string",
  • "amEnd": "string",
  • "amMultiplier": 0,
  • "pmStart": "string",
  • "pmEnd": "string",
  • "pmMultiplier": 0,
  • "unloadHourCost": 0,
  • "waitHourCost": 0,
  • "layoverCost": 0,
  • "maxWorkTime": 0,
  • "targetWorkTime": 0,
  • "maxDriveTime": 0,
  • "minLayoverTime": 0,
  • "workDay": 0,
  • "minHoursRemainingForRedispatch": 0,
  • "maxLayovers:": 0,
  • "maxDriveTimeBeforeLayover": 0,
  • "breakStart1": 0,
  • "breakDuration1": 0,
  • "breakStart2": 0,
  • "breakDuration2": 0,
  • "breakStart3": 0,
  • "breakDuration3": 0,
  • "overTimeCosts": [
    ],
  • "breakTimes": [
    ],
  • "volumes": [
    ],
  • "userFields": [
    ]
}

FinalizeRoute

path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "branch": {
    },
  • "loadedStops": [
    ],
  • "operationId": "string",
  • "routesDeleted": [
    ],
  • "routesUpdated": [
    ],
  • "unloadedStops": [
    ],
  • "stopsDeleted": [
    ]
}

Your GET endpoint

Your GET endpoint

path Parameters
routeKey
required
string

Tasks

/Tasks/v1/{taskId}

path Parameters
taskId
required
string

Responses

Response samples

Content type
application/json
{
  • "errorCode": 0,
  • "payload": { },
  • "status": "Success"
}

TruckProfiles

GetTruckProfiles

query Parameters
branchKey
integer <int32>

Responses

Response samples

Content type
application/json
null

Trucks

GetTrucksByProfileKey

query Parameters
profileKey
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]