API docs by Redocly

LoadOps API (1.0.0)

Download OpenAPI specification:

DriverLocation

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. Use externalSystemId field to speicify

findDriverLastLocation

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string

Responses

Trailer

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. Use externalSystemId field to speicify

Update trailer

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
required
integer <int64>

Trailer Id

externalSystemId
string

External System Id (Mandatory if byExternalSystemId is True in query params)

trailerName
string [ 0 .. 50 ] characters

Trailer Name

driver
string

Driver Assigned

vin
string [ 0 .. 17 ] characters

Trailers VIN

licensePlateNumber
string [ 0 .. 20 ] characters

Registration Number

licenseState
string [ 0 .. 50 ] characters

License Plate State

validFrom
string <date-time>

Valid From

object (UserAddress)

User Address Details

validTill
string <date-time>

Valid Till

object (AssetCurrentLocationDTO)

Asset Location

status
string
Enum: "UNAVAILABLE" "AVAILABLE" "ASSIGNED" "INACTIVE"

Status

ownershipType
string [ 0 .. 50 ] characters

Ownership Type

ownedCompany
string [ 0 .. 50 ] characters

Tractor Owner

mobileno
string = 10 characters

Owner Mobile Number

extension
string [ 0 .. 5 ] characters

Owner Extension

ownerEmail
string [ 0 .. 50 ] characters

Owner Email

trailerLength
string [ 0 .. 50 ] characters

Trailer Length

make
string [ 0 .. 50 ] characters

Trailer Make

model
string [ 0 .. 50 ] characters

Trailer Model

year
string [ 0 .. 6 ] characters

Trailer Year

trailerType
string [ 0 .. 50 ] characters

Trailer Type

gvw
integer <int32> [ 0 .. 100000 ]

Gross Vehicle Weight (in lbs)

payloadCapacity
integer <int32> [ 0 .. 100000 ]

Payload Capacity (in lbs)

insuranceCompany
string [ 0 .. 50 ] characters

Insurance Provider

insuranceEndDate
string <date-time>

Insurance End Date

insuranceStartDate
string <date-time>

Insurance Start Date

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get trailers

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
id
required
Array of integers <int64> [ items <int64 > ]

Trailer Id

externalSystemId
required
Array of strings

Trailer External System Id

status
required
Array of strings

Trailer Status

ownershipType
required
Array of strings

Trailer Ownership Type

trailerType
required
Array of strings

Trailer Type

make
required
Array of strings

Trailer Make

model
required
Array of strings

Trailer Model

trailerName
Array of strings

Trailer Name

Responses

Request samples

Content type
application/json
{
  • "id": [
    ],
  • "externalSystemId": [
    ],
  • "status": [
    ],
  • "ownershipType": [
    ],
  • "trailerType": [
    ],
  • "make": [
    ],
  • "model": [
    ],
  • "trailerName": [
    ]
}

Create trailer

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
externalSystemId
required
string

External System Id (Mandatory if byExternalSystemId is True in query params)

trailerName
required
string [ 0 .. 50 ] characters

Trailer Name

driver
string

Driver Assigned

vin
string [ 0 .. 17 ] characters

VIN Number

licensePlateNumber
string [ 0 .. 20 ] characters

Registration Plate #

licenseState
string [ 0 .. 50 ] characters

Registration Plate State

validFrom
string <date-time>

Registration Valid From

object (UserAddress)

User Address Details

validTill
string <date-time>

Registration Valid Till

object (AssetCurrentLocationDTO)

Asset Location

status
required
string
Enum: "UNAVAILABLE" "AVAILABLE" "ASSIGNED" "INACTIVE"

Status

ownershipType
string [ 0 .. 50 ] characters

Ownership Type

ownerCompany
string [ 0 .. 50 ] characters

Owner Company

mobileno
string = 10 characters

Phone Number

extension
string [ 0 .. 5 ] characters

Phone Extension

ownerEmail
string [ 0 .. 50 ] characters

Owner Email

trailerLength
string [ 0 .. 50 ] characters

Trailer Length

make
string [ 0 .. 50 ] characters

Make

model
string [ 0 .. 50 ] characters

Model

year
string [ 0 .. 6 ] characters ^(0|[1-9]\d*)$

Year

trailerType
string [ 0 .. 50 ] characters

Trailer Type

gvw
integer <int32> [ 0 .. 100000 ]

Gross Vehicle Weight (in lbs)

payloadCapacity
integer <int32> [ 0 .. 100000 ]

Payload Capacity

insuranceCompany
string [ 0 .. 50 ] characters

Insurance Company

insuranceEndDate
string <date-time>

Insurance End Date

insuranceStartDate
string <date-time>

Insurance Start Date

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete trailer

Authorizations:
JWTBearerAuth
query Parameters
id
string
externalSystemId
string
header Parameters
Authorization
required
string

Responses

Tractor

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. Use externalSystemId field to speicify

Update tractor

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
required
integer <int64>

Tractor Id

externalSystemId
string

External System Id

tractorName
string [ 0 .. 50 ] characters

Tractor Name

vin
string [ 0 .. 17 ] characters

VIN

licensePlateNumber
string [ 0 .. 20 ] characters

License Plate Number

licenseState
string

License Plate State

object (AssetCurrentLocationDTO)

Asset Location

currentOdometer
integer <int32> [ 0 .. 3000000 ]

Current Odometer

ownerCompany
string [ 0 .. 50 ] characters

Owner Company

mobileno
string = 10 characters

Mobile Number

extension
string [ 0 .. 5 ] characters

Extension

ownerEmail
string [ 0 .. 50 ] characters

Owner Email

object (UserAddress)

User Address Details

ownershipType
string [ 0 .. 50 ] characters

Ownership Type

make
string [ 0 .. 50 ] characters

Make

model
string [ 0 .. 50 ] characters

Model

year
string [ 0 .. 6 ] characters

Year

tollProvider
string [ 0 .. 50 ] characters

Toll Provider

tollTagNumber
string [ 0 .. 50 ] characters

Toll Tag Number

fuelCapacity
number <double> [ 0 .. 100000 ]

Fuel Capacity

fuelType
string

Fuel Type

gvw
integer <int32> [ 0 .. 100000 ]

Gross Vehicle Weight (in lbs)

braking
string
Enum: "FULL_AIR_BRAKE" "HYDRAULIC_BRAKE" "AIR_OVER_HYDRAULIC"

Braking

transmission
string
Enum: "MANUAL" "AUTOMATIC"

Transmission

insuranceCompany
string [ 0 .. 50 ] characters

Insurance Company

insuranceStartDate
string <date-time>

Insurance Start Date

insuranceEndDate
string <date-time>

Insurance End Date

licenseValidFrom
string <date-time>

License Valid From

licenseValidTill
string <date-time>

License Valid Till

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get tractors

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
id
Array of integers <int64> [ items <int64 > ]

Tractor Id

externalSystemId
Array of strings

External System Id

vin
Array of strings

Trailer VIN

licensePlateNumber
Array of strings

License Plate Number

tractorName
Array of strings

Tractor Name

status
Array of strings

Tractor status

Responses

Request samples

Content type
application/json
{
  • "id": [
    ],
  • "externalSystemId": [
    ],
  • "vin": [
    ],
  • "licensePlateNumber": [
    ],
  • "tractorName": [
    ],
  • "status": [
    ]
}

Create tractor

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
tractorName
required
string [ 0 .. 50 ] characters

Tractor Number

externalSystemId
string

External System Id

vin
string [ 0 .. 17 ] characters

VIN Number

licensePlateNumber
string [ 0 .. 20 ] characters

Registration Plate #

licenseState
string

Registration Plate State

object (AssetCurrentLocationDTO)

Asset Location

currentOdometer
integer <int32> [ 0 .. 3000000 ]

Odometer reading

ownedCompany
string [ 0 .. 50 ] characters

Owner Company

mobileno
string = 10 characters

Phone Number

extension
string [ 0 .. 5 ] characters

Phone Extension

ownerEmail
string [ 0 .. 50 ] characters

Owner Email

object (UserAddress)

User Address Details

ownershipType
string [ 0 .. 50 ] characters

Ownership Type

make
string [ 0 .. 50 ] characters

Make

model
string [ 0 .. 50 ] characters

Model

year
string [ 0 .. 6 ] characters ^(0|[1-9]\d*)$

Year

tollProvider
string [ 0 .. 50 ] characters

Toll Provider

tollTagNumber
string [ 0 .. 50 ] characters

Toll Tag Number

fuelCapacity
number <double> [ 0 .. 100000 ]

Fuel Capacity

fuelType
string

Fuel Type

gvw
integer <int32> [ 0 .. 100000 ]

Gross Vehicle Weight (in lbs)

braking
string
Enum: "FULL_AIR_BRAKE" "HYDRAULIC_BRAKE" "AIR_OVER_HYDRAULIC"

Braking

transmission
string
Enum: "MANUAL" "AUTOMATIC"

Transmission Type

insuranceCompany
string [ 0 .. 50 ] characters

Insurance Company

insuranceStartDate
string <date-time>

Insurance Start Date

insuranceEndDate
string <date-time>

Insurance End Date

licenseValidFrom
string <date-time>

License Valid From

licenseValidTill
string <date-time>

License Valid Till

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete tractor

Authorizations:
JWTBearerAuth
query Parameters
id
string
externalSystemId
string
header Parameters
Authorization
required
string

Responses

Authentication

The Authentication API is used to authenticate API requests and is required to authenticate LoadOps API resources. DOT, username and password are required to authenticate API requests for your project.

externalLogin

Request Body schema: application/json
required
dot
required
string

DOT

email
required
string

Email of the User

password
required
string

Password of the Account

Responses

Request samples

Content type
application/json
{
  • "dot": "string",
  • "email": "string",
  • "password": "string"
}

Customer Commodity

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. User externalSystemId field to speicify

Update customer commodities

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
integer <int64>

Customer Commodity Id

commodityType
string [ 0 .. 50 ] characters

Commodity Type

customerId
string

Customer Id

commodityTypeId
string

Commodity Type Id

externalSystemId
string

Reference Id

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Create customer commodities

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
commodityType
string [ 0 .. 50 ] characters
customerId
string
commodityTypeId
string
externalSystemId
string

Reference ID to identify the customer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get commodities items list

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string

Responses

Get customer commodities, Filter by id or externalSystemId

Authorizations:
JWTBearerAuth
query Parameters
id
string
externalSystemId
string
header Parameters
Authorization
required
string

Responses

Delete customer commodities

Authorizations:
JWTBearerAuth
query Parameters
id
string
externalSystemId
string
header Parameters
Authorization
required
string

Responses

Customer

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. User externalSystemId field to speicify

Update customers

Update details of an existing customer using customer id or reference id

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
required
integer <int64>

Customer ID

externalSystemId
string

ID of customer in your system

name
string

name fo the customer

type
string

Type of the Customer (Shipper/Broker). Please refer lookup table for types

mc
string

Motor Carrier No.

status
boolean

Status of the Customer

notes
string [ 0 .. 255 ] characters

Special Instructions If any

customerPreference
string
Enum: "PREFERRED" "PROHIBITED" "NONE"

Customer Preference (PREFERRED/PROHIBITED/ NONE)

object (UserAddress)

User Address Details

useDifferentBillTo
boolean

Toggle to use different billing information

billToName
string

Name of Billing Contact

object (UserAddress)

User Address Details

object (CustomerPhoneData)

Billing Contact Phone Number

billingNotes
string

Billing Notes

messageOnInvoice
string

Message on Invoice

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get customers

Get customers by id, name or externalSystemId. If nothing is passed then all the customers are retrieved.

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
id
Array of integers <int64> [ items <int64 > ]

ID of the corresponding Customer to retrieve.

name
Array of strings

Customer Name of the corresponding Customer to retrieve

externalSystemId
Array of strings

External System ID of the customer

Responses

Request samples

Content type
application/json
{
  • "id": [
    ],
  • "name": [
    ],
  • "externalSystemId": [
    ]
}

Create customers

Create new customers.

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
name
required
string

Name of the Customer

type
string

Type of the Customer (Shipper/Broker).

mc
string

Motor Carrier No.

notes
string [ 0 .. 255 ] characters

Special Instructions If any

customerPreference
string
Enum: "PREFERRED" "PROHIBITED" "NONE"

Customer Preference (PREFERRED/PROHIBITED/NONE)

object (AddressDTO)

Address of Customer

externalSystemId
string

Reference ID to identify the customer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete customers

Delete customers using customer id or reference id

Authorizations:
JWTBearerAuth
query Parameters
id
string
externalSystemId
string

ID of corresponding Customer to delete

header Parameters
Authorization
required
string

Responses

Customer Contact

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. User externalSystemId field to speicify

Update customer contacts

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
required
integer <int64>

Customer contact ID

fullName
string [ 0 .. 200 ] characters

Name of the Customer

phone
string [ 0 .. 30 ] characters

Phone number of the Contact

countryCode
string
Value: "USA"
extension
string
email
string [ 0 .. 100 ] characters

Email of the Contact

isPrimary
boolean

Is the primary contact of customer

note
string [ 0 .. 255 ] characters
customerId
required
integer <int64>

Customer ID of the contact

description
required
string [ 0 .. 200 ] characters

Description

externalSystemId
required
string

Reference ID of the Customer

sendPhoneAlert
boolean
sendEmailAlert
boolean
alerts
Array of strings
Items Enum: "ENROUTE_PICKUP" "ARRIVED_PICKUP" "ENROUTE_DELIVERY" "ARRIVED_DELIVERY" "COMPLETE_DELIVERY" "ENROUTE_INTERMEDIATE_STOP" "ARRIVED_INTERMEDIATE_STOP" "LOAD_ACCEPTED" "LOAD_REJECTED" "LOAD_PICKED_UP" "DOCUMENT_UPLOADED" "EDI_ORIGINAL" "EDI_CHANGE" "EDI_CANCELLATION" "LOAD_DELAYED" "NOTE_ADDED" "NOTE_UPDATED" "NOTE_DELETED" "DRIVER_ASSIGNED"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Create customer contacts

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
fullName
string [ 0 .. 200 ] characters
phone
string [ 0 .. 30 ] characters
countryCode
string
Value: "USA"
extension
string
email
string [ 0 .. 100 ] characters
isPrimary
boolean
note
string [ 0 .. 255 ] characters
customerId
string
description
string [ 0 .. 200 ] characters
externalSystemId
string
sendPhoneAlert
boolean
sendEmailAlert
boolean
alerts
Array of strings
Items Enum: "ENROUTE_PICKUP" "ARRIVED_PICKUP" "ENROUTE_DELIVERY" "ARRIVED_DELIVERY" "COMPLETE_DELIVERY" "ENROUTE_INTERMEDIATE_STOP" "ARRIVED_INTERMEDIATE_STOP" "LOAD_ACCEPTED" "LOAD_REJECTED" "LOAD_PICKED_UP" "DOCUMENT_UPLOADED" "EDI_ORIGINAL" "EDI_CHANGE" "EDI_CANCELLATION" "LOAD_DELAYED" "NOTE_ADDED" "NOTE_UPDATED" "NOTE_DELETED" "DRIVER_ASSIGNED"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get customer contacts

Authorizations:
JWTBearerAuth
query Parameters
id
string
externalSystemId
string
header Parameters
Authorization
required
string

Responses

Delete customer contacts

Authorizations:
JWTBearerAuth
query Parameters
id
string
externalSystemId
string
header Parameters
Authorization
required
string

Responses

Load Assignment

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. Use externalSystemId field to speicify

Unassign entities from load

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
TripReferenceCode
required
string
RemoveDriver
boolean
RemoveTractor
boolean
RemoveTrailer
boolean
RemoveCarrier
boolean

Responses

Request samples

Content type
application/json
{
  • "TripReferenceCode": "string",
  • "RemoveDriver": true,
  • "RemoveTractor": true,
  • "RemoveTrailer": true,
  • "RemoveCarrier": true
}

Assign entities to load

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
TripReferenceCode
required
string
Driver1ReferenceCode
string
Driver2ReferenceCode
string
TractorReferenceCode
string
TrailerReferenceCode
string
BrokerageStatus
boolean
CarrierReferenceCode
string

Responses

Request samples

Content type
application/json
{
  • "TripReferenceCode": "string",
  • "Driver1ReferenceCode": "string",
  • "Driver2ReferenceCode": "string",
  • "TractorReferenceCode": "string",
  • "TrailerReferenceCode": "string",
  • "BrokerageStatus": true,
  • "CarrierReferenceCode": "string"
}

Load Invoice

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. Use externalSystemId field to speicify

Update invoices

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
Default: false
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
invoiceId
required
string

Invoice id

loadedMiles
number <double>

Loaded miles

emptyMiles
number <double>

Empty miles

Array of objects (LineItemDTO)

Line Items to Update

invoiceTerm
string
Enum: "DUE_ON_RECEIPT" "NET_15" "NET_30" "NET_45" "CUSTOM"

Invoice term

Array of objects (ReceivedPaymentDTO)

Received payments

customerId
integer <int64>

Customer id

customerContactId
integer <int64>

Customer contact id

proofOfDeliveryMandatory
boolean

Proof of delivery mandatory

billOfLadingMandatory
boolean

Bill of lading mandatory

paidOn
string <date-time>

Date on which invoice was paid

invoicedOn
string <date-time>

Date on which invoice was created

invoiceTermValue
integer <int64>

Invoice term value

messageOnInvoice
string

Message on invoice

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Invoices

Authorizations:
JWTBearerAuth
query Parameters
invoiceId
string
loadId
string
loadExternalSystemId
string
header Parameters
Authorization
required
string

Responses

Loads

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. Use externalSystemId field to speicify

Update load Stop

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
Default: false
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
loadId
required
string

Load ID

externalSystemId
required
string

External System Id (Mandatory if byExternalSystemId is True in query params)

object (StopUpdateData)

Stop Data

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Update load shipment status

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
Default: false
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
loadId
required
string

Load ID or refefence Id of the Load, pass byExternalSystemId true if you want to do changes based on your system id

tripId
required
string

Trip ID of the Load

externalSystemId
string

External System Id

object (TripActivityUpdateRequest)

Trip Activity Update Request

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Update load status

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
Default: false
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
loadId
required
string

Load ID

externalSystemId
required
string

External System Id

status
required
string
Enum: "QUOTE" "AVAILABLE" "ASSIGNMENT_PLANNED" "OFFERED_TO_DRIVER" "DISPATCHED" "IN_TRANSIT" "LOAD_COMPLETED" "CANCELLED" "READY_TO_INVOICE" "INVOICED" "PAID" "DELETED" "UNASSIGNED" "CONCERNED" "CONCERN_ADDRESSED"

Status of the Load

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Add load Stop

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
Default: false
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
tripId
required
string

Load ID or refefence Id of the Load / trip, pass byExternalSystemId true if you want to do changes based on referenceId

loadId
string

Load ID or refefence Id of the Load, pass byExternalSystemId true if you want to do changes based on referenceId

externalSystemId
string

External system id

previousTripStopId
integer <int64>

Previous stop id of the trip

required
object (NewStopDTO)

Stop Details

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Split load

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
TripReferenceCode
required
string
LoadReferenceCode
Array of strings
SplitBeforeStopReferenceCode
string
object (NewSplitStopDetails)

Responses

Request samples

Content type
application/json
{
  • "TripReferenceCode": "string",
  • "LoadReferenceCode": [
    ],
  • "SplitBeforeStopReferenceCode": "string",
  • "NewSplitStop": {
    }
}

Get loads with trips

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
ids
Array of strings

Load Ids

tripIds
Array of strings

Trip Ids

externalSystemId
Array of strings

External System Id

loadDisplayId
Array of strings

Load Display Id

tripDisplayId
Array of strings

Trip Display Id

customerId
Array of integers <int64> [ items <int64 > ]

Customer Id

driverDisplayId
Array of integers <int64> [ items <int64 > ]

Driver Display Id

driverNames
Array of strings

Driver Names

trailerName
Array of strings

Trailer Name

tractorName
Array of strings

Tractor Name

loadStatus
Array of strings
Items Enum: "QUOTE" "AVAILABLE" "ASSIGNMENT_PLANNED" "OFFERED_TO_DRIVER" "DISPATCHED" "IN_TRANSIT" "LOAD_COMPLETED" "CANCELLED" "READY_TO_INVOICE" "INVOICED" "PAID" "DELETED" "UNASSIGNED" "CONCERNED" "CONCERN_ADDRESSED"

Load Status

from
string <date-time>

Appointment Start Date or Actual Arrival Time Based on Schedule Type

to
string <date-time>

Appointment End Date or Actual Completion Time Based on Schedule Type

scheduleType
string
Enum: "APPOINTMENT" "ACTUAL"

Can Be used to fetch Loads based on Appointment/Actual times

page
integer <int32>

Page number

size
integer <int32>

Page size

updateDateFrom
string <date-time>

Filter loads whose Update Date is on or after this timestamp

updateDateTo
string <date-time>

Filter loads whose Update Date is on or before this timestamp

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "tripIds": [
    ],
  • "externalSystemId": [
    ],
  • "loadDisplayId": [
    ],
  • "tripDisplayId": [
    ],
  • "customerId": [
    ],
  • "driverDisplayId": [
    ],
  • "driverNames": [
    ],
  • "trailerName": [
    ],
  • "tractorName": [
    ],
  • "loadStatus": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "scheduleType": "APPOINTMENT",
  • "page": 0,
  • "size": 0,
  • "updateDateFrom": "2019-08-24T14:15:22Z",
  • "updateDateTo": "2019-08-24T14:15:22Z"
}

Get empty trips

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
driverNames
Array of strings

Driver names

driverDisplayId
Array of integers <int64> [ items <int64 > ]

Driver display ids

tractorName
Array of strings

Tractor names

trailerName
Array of strings

Trailer names

tripIds
Array of strings

Trip ids

tripDisplayId
Array of strings

Trip display ids (sequence numbers)

tripStatus
Array of strings
Items Enum: "QUOTE" "AVAILABLE" "ASSIGNMENT_PLANNED" "OFFERED_TO_DRIVER" "DISPATCHED" "IN_TRANSIT" "LOAD_COMPLETED" "CANCELLED" "READY_TO_INVOICE" "INVOICED" "PAID" "DELETED" "UNASSIGNED" "CONCERNED" "CONCERN_ADDRESSED"

Trip Status

page
integer <int32>

Page number

size
integer <int32>

Page size

Responses

Request samples

Content type
application/json
{
  • "driverNames": [
    ],
  • "driverDisplayId": [
    ],
  • "tractorName": [
    ],
  • "trailerName": [
    ],
  • "tripIds": [
    ],
  • "tripDisplayId": [
    ],
  • "tripStatus": [
    ],
  • "page": 0,
  • "size": 0
}

getDriverGroups

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
driverIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "driverIds": [
    ]
}

createDriverGroups

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
string
organizationId
integer <int64>
groupName
string
driverIds
Array of integers <int64> [ items <int64 > ]
activeForOperation
boolean
dispatcherId
integer <int64>
implicitTractorAssignmentForbidden
boolean
implicitTrailerAssignmentForbidden
boolean
groupStatus
integer <int64>
source
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Create load

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
externalSystemId
required
string

External System ID of the Load

driverId
string

Driver ID

dispatcherId
string

Dispatcher ID

terminalId
string

Terminal ID

loadStatus
string
Enum: "QUOTE" "AVAILABLE" "ASSIGNMENT_PLANNED" "OFFERED_TO_DRIVER" "DISPATCHED" "IN_TRANSIT" "LOAD_COMPLETED" "CANCELLED" "READY_TO_INVOICE" "INVOICED" "PAID" "DELETED" "UNASSIGNED" "CONCERNED" "CONCERN_ADDRESSED"

Load Status

loadType
string
Enum: "FTL" "LTL" "MANIFEST"

Load Type

seqNumber
string
completeDate
string <date-time>

Complete Date

loadCreatorUserId
integer <int64>

Load Creator User ID

Array of objects (LoadCreateStopDTO)
object (GeneralLoadDetailsDTO)
customerId
string

Customer ID

customerContactId
string

Customer Contact ID

tractorId
string

Tractor ID

trailerId
string

Trailer ID

loadCategory
string

Load Category

revenue
number <double>

Revenue

operationType
string
Enum: "INVOICE_DISPATCH" "INVOICE_ONLY" "DISPATCH_ONLY"

Operation Type

proofOfDeliveryMandatory
boolean

True if proof of delivery is mandatory

billOfLadingMandatory
boolean

True if bill of Lading is mandatory

preLoaded
boolean

True if Trailer is Pre-loaded

dropTrailer
boolean

True if Trailer is Dropped

object (NewInvoiceDTO)
dateFormat
string

Requested Date format

brokerageTrip
boolean

Is trip brokered or not

Array of objects (TagDTO)
allowRelay
boolean

Y if allow relay is true

object (EDIDetailsDTO)
bolNumber
string
purchaseOrderNumber
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Assign dispatcher to load

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
Default: false
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
loadId
required
string

Load ID or refefence Id of the Load, pass byExternalSystemId true if you want to do changes based on referenceId

externalSystemId
string

External System Id

dispatcherId
required
integer <int64>

Dispatcher Id

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get financial items for invoice

Authorizations:
JWTBearerAuth
query Parameters
type
string
itemName
string
itemIds
Array of strings
isInvoiceItem
boolean
isSettlementItem
boolean
pageNumber
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 25
header Parameters
Authorization
required
string

Responses

Delete load

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
Default: false
id
string
header Parameters
Authorization
required
string

Responses

Location

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. Use externalSystemId field to speicify

Update location

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
required
integer <int64>

Location Id or externalSystemId if byExternalSystemId is provided as true

locationName
string

Business Name

notes
string [ 0 .. 255 ] characters

Notes

object (UserAddress)

User Address Details

averageHandlingTime
integer <int32>

Average Handling Time

locationPreference
string
Enum: "PREFERRED" "PROHIBITED" "NONE"

Location Preference

externalSystemId
string

Reference Id of the location

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Locations

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
externalSystemId
Array of strings

External System ID

id
Array of integers <int64> [ items <int64 > ]

Loadops IDs of the locations

locationName
Array of strings

Name of Locations

Responses

Request samples

Content type
application/json
{
  • "externalSystemId": [
    ],
  • "id": [
    ],
  • "locationName": [
    ]
}

Create location

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
locationName
required
string

Location Name

notes
string [ 0 .. 255 ] characters
required
object (UserAddress)

User Address Details

avgHandlingTime
required
integer <int32>

Average handling time indicator

locationPreference
string
Enum: "PREFERRED" "PROHIBITED" "NONE"

Location Preference

externalSystemId
string

External System ID of the Business Locationd

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Check if a location exists by organization ID and location name (case-insensitive)

Authorizations:
JWTBearerAuth
query Parameters
locationName
required
string
header Parameters
Authorization
required
string

Responses

Delete location

Authorizations:
JWTBearerAuth
query Parameters
id
string
externalSystemId
string
header Parameters
Authorization
required
string

Responses

User

For all create, update, delete APIs, pass this parameter as true if you want to perform operation based on id provided as reference from your database. Use externalSystemId field to speicify

Update users

Updates an existing user in LoadOps by ID or Reference ID.

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
required
integer <int64>

Id of the User

externalSystemId
required
string

External System Id of the User

firstname
required
string

First Name of the User

lastname
required
string

Last Name of the User

email
required
string

Email Address of the User

timezone
string

User's Current Time zone

object (UserAddress)

User Address Details

employmentType
string
Enum: "OWNER_OPERATOR" "EMPLOYEE"

Employment Type

operationType
string
Enum: "LOCAL" "REGIONAL" "OTR" "CASUAL"

Operation Type

dispatcherId
integer <int64>

Provide dispatcher id (only when user is driver)

object (EmergencyContactDTO)

Emergency Contact of the User

object (OrgDriverLicense)

Org Driver License

roleCode
string
Enum: "AD" "PD" "DI" "AC" "DR" "NFD"

Role code of the User AD("Admin"), PD("Power Dispatcher"), DI("Financial Dispatcher"), AC("Accountant"), DR("Driver"), NFD("Dispatcher"),

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Update User emergency contacts

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
id
integer <int64>

Id of the Emergency Contact

externalSystemId
string

Reference Id

name
string [ 0 .. 50 ] characters

Name of the Emergency Contact

lastName
string [ 0 .. 50 ] characters

Last Name of the Emergency Contact

object (UserAddress)

User Address Details

object (UserPhoneData)

Phone Data of the Emergency Contact

email
string [ 0 .. 50 ] characters

Email of the Emergency Contact

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get users

Get users

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
ids
Array of strings

ID of the corresponding User

externalSystemIds
required
Array of strings

External System ID of the corresponding User

fullResponse
boolean

Full Response or not

status
Array of integers <int32> [ items <int32 > ]

is driver active or not

roleCodes
Array of strings

Role Code of the corresponding User

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "externalSystemIds": [
    ],
  • "fullResponse": true,
  • "status": [
    ],
  • "roleCodes": [
    ]
}

Get drivers

Get drivers

Authorizations:
JWTBearerAuth
header Parameters
Authorization
required
string
Request Body schema: application/json
ids
Array of strings

ID of the corresponding User

externalSystemIds
required
Array of strings

External System ID of the corresponding User

fullResponse
boolean

Full Response or not

status
Array of integers <int32> [ items <int32 > ]

is driver active or not

roleCodes
Array of strings

Role Code of the corresponding User

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "externalSystemIds": [
    ],
  • "fullResponse": true,
  • "status": [
    ],
  • "roleCodes": [
    ]
}

Create users

Creates a new user in LoadOps. Users once created can be assigned to Loads.

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
withGroups
boolean
Default: false
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
externalSystemId
required
string

External System ID

firstname
required
string [ 0 .. 50 ] characters

First Name

middlename
string

Middle Name

lastname
required
string [ 0 .. 50 ] characters

Last Name

roleCode
required
string
Enum: "AD" "PD" "DI" "AC" "DR" "NFD"

Role Code AD("Admin"), PD("Power Dispatcher"), DI("Financial Dispatcher"), AC("Accountant"), DR("Driver"), NFD("Dispatcher")

email
required
string [ 0 .. 2147483647 ] characters

Email Address of User

accountStartDate
string <date-time>

Account Start Date

countryCode
string
Enum: "USA" "RU"

Country Code

phone
string [ 0 .. 5 ] characters

Phone

mobileno
string [ 0 .. 10 ] characters

Mobile Number

fuelCardProvider
string [ 0 .. 50 ] characters

Fuel Card Provider

fuelCardNumber
string [ 0 .. 50 ] characters

Fuel Card Number

object (UserAddress)

User Address Details

zipcode
string

Zip Code

ssn
string

SSN

effectiveStartDate
string <date-time>

Effective Start Date

effectiveTerminationDate
string <date-time>

Effective Termination Date

companyWorks
string

Company Works

registerDate
string <date-time>

Register Date

lastLoginDate
string <date-time>

Last Login Date

status
integer <int32>

Status

userType
string

User Type

timezone
string

Time Zone

object (OrgDriverLicense)

Org Driver License

employmentType
string
Enum: "OWNER_OPERATOR" "EMPLOYEE"

Employment Type

operationType
string
Enum: "LOCAL" "REGIONAL" "OTR" "CASUAL"

Operation Type

dispatcherId
integer <int64>

Dispatcher ID

object (EmergencyContactDTO)

Emergency Contact of the User

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Create User emergency contacts

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
boolean
header Parameters
Authorization
required
string
Request Body schema: application/json
required
Array
name
string [ 0 .. 50 ] characters
lastName
string [ 0 .. 50 ] characters
userId
string

User Id

object (UserAddress)

User Address Details

object (UserPhoneData)

Phone Data of the Emergency Contact

email
string [ 0 .. 50 ] characters
externalSystemId
string

Reference Id

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get User emergency contacts

Authorizations:
JWTBearerAuth
query Parameters
userId
string
id
string
externalSystemId
string
header Parameters
Authorization
required
string

Responses

deleteUsers

Authorizations:
JWTBearerAuth
query Parameters
byExternalSystemId
string

ID of the corresponding User to delete

id
required
string
header Parameters
Authorization
required
string

Responses

Delete User emergency contacts

Authorizations:
JWTBearerAuth
query Parameters
externalSystemId
required
string
id
string
byExternalSystemId
boolean
header Parameters
Authorization
required
string

Responses

Report

API's to get Advanced reports

getTrendReportData

query Parameters
organizationId
required
integer <int64>
fromDate
string <date-time>
toDate
string <date-time>
entity
string
dispatchType
string
terminalId
string
scheduleType
string
type
string
header Parameters
apiKey
required
string

Responses

getAdvanceReportData

Authorizations:
JWTBearerAuth
query Parameters
startDate
string <date-time>
endDate
string <date-time>
statusList
Array of strings
Items Enum: "QUOTE" "AVAILABLE" "ASSIGNMENT_PLANNED" "OFFERED_TO_DRIVER" "DISPATCHED" "IN_TRANSIT" "LOAD_COMPLETED" "CANCELLED" "READY_TO_INVOICE" "INVOICED" "PAID" "DELETED" "UNASSIGNED" "CONCERNED" "CONCERN_ADDRESSED"
sort
string
driverIds
Array of integers <int64> [ items <int64 > ]
customerIds
Array of integers <int64> [ items <int64 > ]
tractorIds
Array of integers <int64> [ items <int64 > ]
trailerIds
Array of integers <int64> [ items <int64 > ]
dispatchType
string
scheduleType
string
header Parameters
Authorization
required
string

Responses