Find Best Insertion Positions

post

https://wh.route4me.com/modules/api/v5.0/routes/lookup-for-new-destination

Synchronously find the best positions to insert a new destination into existing routes. Evaluates candidate routes and positions and returns the list of best insertion options inline.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

lat

float

required

Latitude of the new destination.

lng

float

required

Longitude of the new destination.

scheduled_for

date

Date (YYYY-MM-DD) used to find candidate routes when route ids are not supplied. Required without route_ids.

route_ids

array of strings

Explicit list of route identifiers to consider.

route_ids

insert_mode

string

enum

Defaults to optimal_after_last_visited

Where the new destination may be inserted.

Allowed:

recommend_by

string

enum

Defaults to distance

Metric used to rank insertion options.

Allowed:

lookup_results_limit

integer

Maximum number of candidate routes to evaluate when route ids are not provided.

max_increase_percent_allowed

number

Upper bound on how much a route distance or duration may grow when inserting the new destination.

Responses

200The list of best insertion options (single-artifact result).

406Unprocessable Content