Create Master Route

post

https://wh.route4me.com/modules/api/v5.0/routes/master-route

Create Master Route Request. This endpoint allows you to create a new record with route details such as waypoints, optimization settings, and delivery details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

parameters

object

required

addresses

array of objects

required

length ≥ 2

addresses*

is_depot

boolean | null

Depot flag

address

string

required

length ≤ 255

Destination name

lat

float

required

-90 to 90

Latitude

lng

float

required

-180 to 180

Longitude

curbside_lat

float | null

-90 to 90

Curbside latitude

curbside_lng

float | null

-180 to 180

Curbside longitude

contact_id

integer | null

Contact identifier

order_id

integer | null

Order identifier

alias

string | null

Destination alias

sequence_no

integer | null

≥ 0

Sequence number

customer_po

string | null

Customer PO

invoice_no

string | null

Invoice number

reference_no

string | null

Reference number

order_no

string | null

Order number

weight

float | null

0 to 99999.99

Weight

cost

float | null

0 to 99999.99

Cost

revenue

float | null

0 to 99999.99

Revenue

cube

float | null

0 to 99999.99

Cubic volume

pieces

integer | null

Number of pieces

time

integer | null

Time

first_name

string | null

Customer first name

last_name

string | null

Customer last name

string | null

Customer email

phone

string | null

Customer phone

custom_fields

object | null

Custom fields

time_window_start

integer | null

Time window start

time_window_end

integer | null

Time window end

time_window_start_2

integer | null

Second time window start

time_window_end_2

integer | null

Second time window end

address_stop_type

string | null

Address stop type

priority

integer | null

0 to 255

Priority

group

string | null

Customer group

pickup

string | null

Pickup reference

dropoff

string | null

Dropoff reference

joint

boolean | null

Joint flag

required_skills

array of strings | null

Required skills

required_skills

is_depot

boolean | null

Depot flag

address

string

required

length ≤ 255

Destination name

lat

float

required

-90 to 90

Latitude

lng

float

required

-180 to 180

Longitude

curbside_lat

float | null

-90 to 90

Curbside latitude

curbside_lng

float | null

-180 to 180

Curbside longitude

contact_id

integer | null

Contact identifier

order_id

integer | null

Order identifier

alias

string | null

Destination alias

sequence_no

integer | null

≥ 0

Sequence number

customer_po

string | null

Customer PO

invoice_no

string | null

Invoice number

reference_no

string | null

Reference number

order_no

string | null

Order number

weight

float | null

0 to 99999.99

Weight

cost

float | null

0 to 99999.99

Cost

revenue

float | null

0 to 99999.99

Revenue

cube

float | null

0 to 99999.99

Cubic volume

pieces

integer | null

Number of pieces

time

integer | null

Time

first_name

string | null

Customer first name

last_name

string | null

Customer last name

string | null

Customer email

phone

string | null

Customer phone

custom_fields

object | null

Custom fields

time_window_start

integer | null

Time window start

time_window_end

integer | null

Time window end

time_window_start_2

integer | null

Second time window start

time_window_end_2

integer | null

Second time window end

address_stop_type

string | null

Address stop type

priority

integer | null

0 to 255

Priority

group

string | null

Customer group

pickup

string | null

Pickup reference

dropoff

string | null

Dropoff reference

joint

boolean | null

Joint flag

required_skills

array of strings | null

Required skills

required_skills

metadata

object | null

Additional metadata

source

string | null

enum

Master route source, by default is

Allowed:

200Master Route Created

406validation error