HomeSupport
API Reference

Create a new route plan

post
https://example.com/integration-tenants/api/v1/routeplans
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Model to create a route plan.

Subsequent calls to other APIs will be required to fill the route plan.

int32
enum

[0 - 'MapBased', 1 - 'ZipBased']

Allowed:
string
required
length between 1 and 256

Route plan name for the primary language

string | null

Route plan name for the primary secondary language

string | null

Route plan description for the primary language

string | null

Route plan description for the primary secondary language

int32 | null
warehouseLocation
object
required
warehouseAddress
object
required
boolean

Indicates if the optimizer should add a step to return to the warehouse for this route.

boolean

Allows adding orders to a dispatched route.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

404

The route plan not found

500

An error occurred when trying to get the route plans

Updated about 1 month ago

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
text/json

Updated about 1 month ago