Search
K
Fulfillment API

DispatchSearchRequest

object

Details of the dispatch search.

searchFieldsobject

Details of search fields.

Show Child Parameters
offsetinteger

Determines which record in the collection will be the first one displayed. This value is 1-based, meaning the count starts at 1. Please put this and limit at the end of the request.

Example:10

limitinteger

The maximum number of items to be returned in the response. Please put this and offset at the end of the request.

Default:50

Example:1

sortFieldsarray[object]

Details of search sort.

Show Child Parameters
Example

DriverPatchRequest

object

Details of driver patch operation.

driverIdstring(uuid)

The Central Dispatch user ID of the driver.

Example:d71b5750-e89b-12d3-a456-426614174000

Example

DriverSearchRequest

object

Driver IDs search.

opstring

The operation type for the driver IDs. Values: EQ, NEQ.

Example:EQ

valuesarray[string]

A collection of driver ID values.

Example:d71b5750-e89b-12d3-a456-426614174000, 3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347

Example

DriversResponse

object

Details of the drivers.

usersarray[string](uuid)

A collection of user IDs representing the drivers.

Example:ddd151ee-b1d3-4cec-8eb5-4a21bddd900b, 157a16f0-503d-4256-ba60-a4876e8eb9bb

Example

ErrorAlt

object

Details of an error or issue.

errorIDstring

The ID of the error.

Example:157a16f0-503d-4256-ba60-a4876e8eb9bb

codestring

The code used for the issue.

Example:resource.issue_type

descriptionstring

A detailed message.

Example:The issue happened because something is wrong.

propertiesarray[object]

Details of an error’s property.

Show Child Parameters
Example