DriverSearchRequest

searchFieldsobject

Details of search fields.

Show Child Parameters

offsetinteger(int32)

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(int32)

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

{
  "searchFields": {
    "paymentStatus": [
      "[]"
    ],
    "dispatchStatus": [
      "[]"
    ],
    "pickUpCity": [
      "[]"
    ],
    "pickUpState": [
      "[]"
    ],
    "pickUpZip": [
      "[]"
    ],
    "deliveryCity": [
      "[]"
    ],
    "deliveryState": [
      "[]"
    ],
    "deliveryZip": [
      "[]"
    ],
    "externalId": [
      "[]"
    ],
    "dispatchID": "dispatchID",
    "vin": [
      "[]"
    ],
    "driverId": [
      "[]"
    ],
    "shipperCompanyName": [
      "[]"
    ],
    "shipperOrderId": [
      "[]"
    ],
    "marketPlaceIds": [
      "[]"
    ],
    "externalCompanyIds": [
      "[]"
    ],
    "externalCompanyNames": [
      "[]"
    ],
    "externalVehicleIds": [
      "[]"
    ],
    "loadId": [
      "[]"
    ],
    "carrierName": [
      "[]"
    ],
    "carrierId": [
      "[]"
    ],
    "actualPickUpDateTime": "actualPickUpDateTime",
    "actualDropOffDateTime": "actualDropOffDateTime",
    "estimatedPickUpDateTime": "estimatedPickUpDateTime",
    "estimatedDropOffDateTime": "estimatedDropOffDateTime",
    "dispatchDate": {
      "op": "RANGE",
      "startDateTime": "startDateTime",
      "endDateTime": "endDateTime"
    },
    "listingIds": {
      "op": "EQ",
      "values": [
        "42220470",
        "157a16f0-503d-4256-ba60-a4876e8eb9bb"
      ]
    },
    "dispatchIds": {
      "op": "EQ",
      "values": [
        "d159acc0-e89b-12d3-a456-426614174000",
        "157a16f0-503d-4256-ba60-a4876e8eb9bb"
      ]
    },
    "driverIds": {
      "op": "EQ",
      "values": [
        "d71b5750-e89b-12d3-a456-426614174000",
        "3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347"
      ]
    },
    "isCarrierArchived": false,
    "isShipperArchived": false
  },
  "offset": 10,
  "limit": 1,
  "sortFields": [
    {
      "name": "actualPickUpDateTime",
      "direction": "ASCENDING"
    }
  ]
}

driverIdstring(uuid)

The Central Dispatch user ID of the driver.

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

Example

{
  "driverId": "d71b5750-e89b-12d3-a456-426614174000"
}

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

{
  "op": "EQ",
  "values": [
    "d71b5750-e89b-12d3-a456-426614174000",
    "3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347"
  ]
}

usersarray[string](uuid)

A collection of user IDs representing the drivers.

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

Example

{
  "users": [
    "ddd151ee-b1d3-4cec-8eb5-4a21bddd900b",
    "157a16f0-503d-4256-ba60-a4876e8eb9bb"
  ]
}

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

{
  "errorID": "157a16f0-503d-4256-ba60-a4876e8eb9bb",
  "code": "resource.issue_type",
  "description": "The issue happened because something is wrong.",
  "properties": [
    {
      "property": "person",
      "value": "J0hn D03"
    }
  ]
}

DispatchSearchRequest

DriverPatchRequest

DriversResponse

ErrorAlt