Data Models

Id

int

The Id of the merchant.

startShift

Date

The date and time the current shift started.

endShift

Date

The date and time the current shift started.

Id

int

The Id of the task.

activeWaypointId

int

The Id of the way point which the driver is currently servicing.

asap

boolean

Indicates whether this is an ASAP task. The values are:

• false or 0 - this not an ASAP task
• true or 1 - this is an ASAP task

The default value is false.

externalId

int

The Id of this task in your own system.

priority

String

The priority of this task.

status

int

The status of this task. The values are:

• 0 - the task was created, but is not assigned to a driver.
• 1 - the task was created and is not assigned to a driver.
• 2 - the driver is on the way to a way point.
• 3 - the driver arrived at a way point.
• 4 - the task ended (done).
• 6 - the task was accepted by a driver.
• 7 - the task was cancelled.
• 8 - the task was offered to a driver and the driver rejected the task.

title

String

The title of this task.

waypoints

Object

A way point object containing information about the way points in this task.

Id

int

The unique Id of the way point.

address

String

The address of this way point.

customer

object

An Customer object containing information about the customer at this way point.

done

Boolean

Indicates whether this way point is done. The values are:

• false or 0 - the way point is done
• true or 1 - the way point is not done

eta

Date

The expected time of arrival at the way point.

inventories

array of objects

An array of Inventories objects containing the inventories for this way point.

lat

double

The geoposition latitude of this way point.

lng

double

The geoposition longitude of this way point.

position

int

The position of this way point in all way points in the order to which this way point belongs. For example, the order may contain 5 way points and this way point is position 2 (the second).

scheduledAt

Date

The date and time the task was scheduled.

status

int

The way point status. The values are:

• pending - the driver has not yet started this way point in the order.
• started - the driver is on the way to this way point.
• checkedIn - the driver arrived at this way point.
• done - the driver left this way point.
• cancelled - the way point was cancelled.

taskId

int

The unique Id of the order.

Id

int

The Id of the customer.

email

String

The email address of this customer.

externalId

int

The Id of this customer in your own system.

priority

String

The priority of this task.

image

String

The file name of the image file for this customer.

phone

String

The phone number of this customer.

Id

int

The Id of this inventory item.

externalId

String

The Id of this inventory.

inventoryId

int

The Id of this inventory.

name

String

The name of this inventory.

originalQuantity

int

The number of original items of this inventory item in the inventory.

pending

boolean

Indicates whether this is pending. The values are:

• false or 0 - the inventory is not pending
• true or 1 - the inventory is pending

quantity

int

The number of items of this inventory item in the inventory.

scanString

String

The value of the scanned of this inventory.

waypointId

int

The Id of the way point for this inventory.

userId

int

The Id of this logged in user.

email

String

The eamil of this logged in user.

isHome

Boolean

Indicates whether this logged in user is at home. The values are:

name

String

The name of this logged in user.

phone

String

The phone of this logged in user.

profileImage

String

A string containing the path and filename of this logged in user's image file.