GuidesAPI Reference
Log In
API Reference

Create Waypoint

Add a single Way Point to an existing Task

Path Params
int32
required

Unique identifier representing a task

Body Params
int32
required

Unique identifier representing a customer

int32
required

Unique identifier representing a company

string

Scheduled time for way point (format: %Y-%m-%dT%H:%M:%S%z)

string

Address of way point

string

Extra information about the address e.g. floor #, apartment #

string
string

This can be a borough e.g. Bronx, or any neighborhood / zone

string
double

Latitude component of way point location

double

Longitude component of way point location

string

Note to the driver

boolean

Allow scanning inventory at this way point

boolean

Driver can't leave way point before scanning inventory

boolean

Allow driver to change inventory

date-time

Task window bottom limit

date-time

Task window top limit

int32

e.g. 1st stop = 1; 2nd stop = 2

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json