Basic Models

These are some of the common models that will be returned by some of the API. Check the endpoint’s documentation if it returns a different variant of the model.

DC

Describes a DC

{
  "id": "the dc's id",
  "name": "the dc's name",
  "time_zone": "America/Los_Angeles"
}

Property	Type	Nullable	Description
id	string	false	The id of the dc.
name	string	false	The name of the dc.
time_zone	string	false	The time zone the dc is in.

Driver

Describes a Driver

{
  "id": "the driver's id",
  "name": "the driver's name",
  "login_token": "abcde-fghikj"
}

Property	Type	Nullable	Description
id	string	false	The id of the driver.
name	string	false	The name of the driver.
login_token	string	false	The token used to login through Foxtrot’s mobile SDK

Note

The login token is used to login this driver to the SDK. These can be pre-fetched, stored and sent to the mobile app implementing the SDK after successful authentication.

Route

Describes a Route

{
  "id": "route id",
  "name": "route name",
  "assigned_driver_id": "driver id",
  "start_time": 1510622168000,
  "start_warehouse_id": "the warehouse id",
  "end_warehouse_id": "the warehouse id",
  "vehicle_id": "vehicle id",
  "version": 1,
  "waypoint_ids": [
    "waypoint id"
  ],
  "is_active": false,
  "is_finalized": false,
}

Property	Type	Nullable	Description
id	string	false	The id of the route.
name	string	false	The name of the route.
assigned_driver_id	string	true	The id of the driver assigned to this route.
start_time	long	false	The start time of the route as a UNIX epoch since January 1st, 1970 in milliseconds.
start_warehouse_id	string	false	The id of the starting warehouse.
end_warehouse_id	string	false	The id of the destination warehouse.
vehicle_id	string	true	The id of the vehicle associated to this route.
version	integer	false	The version of the route. This value changes whenever a route has changed.
waypoint_ids	Array[string]	false	An array of waypoint ids representing the route sequence.
is_active	boolean	false	This value control whether or not a driver can see the route during the day.
is_finalized	boolean	false	This value control whether or not a driver has completed the route.

Delivery Status

An enumeration of possible delivery statuses.

Method	Description
FAILED	(At Delivery Site: Option 1/3) Marks a failed delivery.
SUCCESSFUL	(At Delivery Site: Option 2/3) Marks a successful delivery.
VISIT_LATER	(At Delivery Site: Option 3/3) Marks the delivery to be visited later.
AUTHORIZE_REATTEMPT	(Optional: After prior DeliveryAttempt) Marks the delivery to be reattempted later.

Route Completion Time

Status of a route completion time.

Property	Type	Nullable	Description
type	string	false	Can be ESTIMATED, ACTUAL, or FINALIZED
timestamp	long	false	Completed timestamp as a UNIX epoch since January 1st, 1970 in milliseconds.

Route Completion Time Type

An enumeration of possible delivery statuses.

Method	Description
ESTIMATED	Route is still in progress so completion time is an estimate.
FINALIZED	Driver finished the route, but route is pending analysis.
ACTUAL	Route is completed.