Onfleet¶

Node: onfleet · Full type: n8n-nodes-base.onfleet · Version: 1

Credentials¶

onfleetApi (alias: @onfleet)

CREDENTIAL @onfleet = onfleetApi "My Onfleet"

Operations¶

Resource: `admin`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`email`	string	""	required
`additionalFields`	collection	{}	keys: `phone`, `isReadOnly`

`delete`¶

No additional parameters.

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	64

`update`¶

Parameter	Type	Default	Details
`updateFields`	collection	{}	keys: `name`, `phone`, `isReadOnly`

Resource: `container`¶

`addTask`¶

Parameter	Type	Default	Details
`containerType`	options	""	required; `organizations`, `teams`, `workers`
`containerId`	string	""	required
`type`	options	""	required; `-1`, `0`, `1`
`index`	number	0	required
`tasks`	string	[]	required
`options`	collection	{}	keys: `considerDependencies`

`get`¶

Parameter	Type	Default	Details
`containerType`	options	""	required; `organizations`, `teams`, `workers`
`containerId`	string	""	required

`updateTask`¶

Parameter	Type	Default	Details
`containerId`	string	""	required
`tasks`	string	[]	required
`options`	collection	{}	keys: `considerDependencies`

Resource: `destination`¶

`create`¶

Parameter	Type	Default	Details
`unparsed`	boolean	false	required
`address`	string	""	required
`addressNumber`	string	""	required
`addressStreet`	string	""	required
`addressCity`	string	""	required
`addressCountry`	string	""	required
`additionalFields`	collection	{}	keys: `addressApartment`, `addressName`, `addressNotes`
`additionalFields`	collection	{}	keys: `addressApartment`, `addressName`, `addressNotes`, `addressPostalCode`

`get`¶

No additional parameters.

Resource: `hub`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`destination`	fixedCollection	{}	groups: `destinationProperties`
`additionalFields`	collection	{}	keys: `teams`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	64

`update`¶

Parameter	Type	Default	Details
`id`	string	""	required
`updateFields`	collection	{}	keys: `destination`, `name`, `teams`

Resource: `organization`¶

`get`¶

No additional parameters.

`getDelegatee`¶

Parameter	Type	Default	Details
`id`	string	""	required

Resource: `recipient`¶

`create`¶

Parameter	Type	Default	Details
`recipientName`	string	""	required
`recipientPhone`	string	""	required
`additionalFields`	collection	{}	keys: `recipientNotes`, `recipientSkipSMSNotifications`
`options`	collection	{}	keys: `recipientSkipPhoneNumberValidation`

`get`¶

Parameter	Type	Default	Details
`getBy`	options	"id"	required; `id`, `phone`, `name`
`id`	string	""	required
`name`	string	""	required
`phone`	string	""	required

`update`¶

Parameter	Type	Default	Details
`id`	string	""	required
`updateFields`	collection	{}	keys: `recipientName`, `notes`, `recipientPhone`, `skipSMSNotifications`

Resource: `task`¶

`clone`¶

Parameter	Type	Default	Details
`overrideFields`	collection	{}	keys: `completeAfter`, `completeBefore`, `includeBarcodes`, `includeDependencies`, `includeMetadata`, `notes`, ...

`complete`¶

Parameter	Type	Default	Details
`success`	boolean	true	required
`additionalFields`	collection	{}	keys: `notes`

`create`¶

Parameter	Type	Default	Details
`destination`	fixedCollection	{}	required; groups: `destinationProperties`
`additionalFields`	collection	{}	keys: `completeAfter`, `completeBefore`, `executor`, `merchant`, `notes`, `pickupTask`, ...

`delete`¶

No additional parameters.

`get`¶

No additional parameters.

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	64
`filters`	collection	{}	keys: `from`, `state`, `to`

`update`¶

Parameter	Type	Default	Details
`updateFields`	collection	{}	keys: `completeAfter`, `completeBefore`, `executor`, `merchant`, `notes`, `pickupTask`, ...

Resource: `team`¶

`autoDispatch`¶

Parameter	Type	Default	Details
`id`	string	""	required
`additionalFields`	collection	{}	keys: `endingRoute`, `maxAllowedDelay`, `maxTasksPerRoute`, `scheduleTimeWindow`, `serviceTime`, `taskTimeWindow`

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`workers`	multiOptions	[]	required
`managers`	multiOptions	[]	required
`additionalFields`	collection	{}	keys: `hub`, `enableSelfAssignment`

`delete`¶

Parameter	Type	Default	Details
`id`	string	""	required

`get`¶

Parameter	Type	Default	Details
`id`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	64

`getTimeEstimates`¶

Parameter	Type	Default	Details
`id`	string	""	required
`filters`	collection	{}	keys: `dropOff`, `pickUp`, `restrictedVehicleTypes`, `serviceTime`

`update`¶

Parameter	Type	Default	Details
`id`	string	""	required
`updateFields`	collection	{}	keys: `managers`, `hub`, `name`, `enableSelfAssignment`, `workers`

Resource: `worker`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`phone`	string	""	required
`teams`	multiOptions	[]	required
`additionalFields`	collection	{}	keys: `capacity`, `displayName`, `vehicle`

`delete`¶

Parameter	Type	Default	Details
`id`	string	""	required

`get`¶

Parameter	Type	Default	Details
`id`	string	""	required
`options`	collection	{}	keys: `analytics`, `filter`

`getAll`¶

Parameter	Type	Default	Details
`byLocation`	boolean	false	required
`longitude`	number	0	required
`latitude`	number	0	required
`returnAll`	boolean	false
`limit`	number	64
`filters`	collection	{}	keys: `radius`
`filters`	collection	{}	keys: `states`, `teams`, `phones`
`options`	collection	{}	keys: `filter`

`getSchedule`¶

Parameter	Type	Default	Details
`id`	string	""	required

`update`¶

Parameter	Type	Default	Details
`id`	string	""	required
`updateFields`	collection	{}	keys: `capacity`, `displayName`, `name`, `teams`

Common Parameters¶

Parameter	Type	Default	Details
`id`	string	""	required

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`phone`	string	""
`isReadOnly`	boolean	false

updateFields children:

Parameter	Type	Default
`name`	string	""
`phone`	string	""
`isReadOnly`	boolean	false

options children:

Parameter	Type	Default	Details
`considerDependencies`	boolean	false

destination children:

destinationProperties group:

Parameter	Type	Default	Details
`unparsed`	boolean	false
`address`	string	""	required
`addressNumber`	string	""	required
`addressStreet`	string	""	required
`addressCity`	string	""	required
`addressState`	string	""	required
`addressCountry`	string	""	required
`addressPostalCode`	string	""
`addressName`	string	""
`addressApartment`	string	""
`addressNotes`	string	""

filters children:

Parameter	Type	Default	Details
`from`	dateTime	""
`state`	multiOptions	[...]	multi: `all`, `2`, `1`, `3`, `0`
`to`	dateTime	""

overrideFields children:

Parameter	Type	Default
`completeAfter`	dateTime
`completeBefore`	dateTime
`includeBarcodes`	boolean	false
`includeDependencies`	boolean	false
`includeMetadata`	boolean	false
`notes`	string	""
`pickupTask`	boolean	false
`serviceTime`	number	0

schedule children:

scheduleProperties group:

Parameter	Type	Default	Details
`date`	dateTime	""	required
`timezone`	options	""	required
`shifts`	fixedCollection	{}	groups: `shiftsProperties`

Example¶

NODE "onfleet" @onfleet AS "Onfleet" {
  resource: "admin",
  operation: "get",
  id: {{ $json.id }},
  name: {{ $json.name }},
  email: {{ $json.email }}
}

Onfleet¶

Credentials¶

Operations¶

Resource: admin¶

create¶

delete¶

getAll¶

update¶

Resource: container¶

addTask¶

get¶

updateTask¶

Resource: destination¶

create¶

get¶

Resource: hub¶

create¶

getAll¶

update¶

Resource: organization¶

get¶

getDelegatee¶

Resource: recipient¶

create¶

get¶

update¶

Resource: task¶

clone¶

complete¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: team¶

autoDispatch¶

create¶

delete¶

get¶

getAll¶

getTimeEstimates¶

update¶

Resource: worker¶

create¶

delete¶

get¶

getAll¶

getSchedule¶

update¶

Common Parameters¶

Parameter Details¶

Example¶

Resource: `admin`¶

`create`¶

`delete`¶

`getAll`¶

`update`¶

Resource: `container`¶

`addTask`¶

`get`¶

`updateTask`¶

Resource: `destination`¶

`create`¶

`get`¶

Resource: `hub`¶

`create`¶

`getAll`¶

`update`¶

Resource: `organization`¶

`get`¶

`getDelegatee`¶

Resource: `recipient`¶

`create`¶

`get`¶

`update`¶

Resource: `task`¶

`clone`¶

`complete`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `team`¶

`autoDispatch`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`getTimeEstimates`¶

`update`¶

Resource: `worker`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`getSchedule`¶

`update`¶