TrueTMS API Reference
Welcome to the TrueTMS API Reference. This is a GraphQL API that allows you to interact with the TrueTMS platform. The API is available to partners and customers who have been granted access.
Terms of Service
API Endpoints
# Beta:
https://beta-api.truetms.com/graphql
# Production:
https://api.truetms.com/graphql
Headers
# Token obtained from the OAuth2 flow
Authorization: Bearer <YOUR_TOKEN_HERE>Authentication
The TrueTMS API uses OAuth2 for authentication. To authenticate, you will need to obtain a token from the OAuth2 flow. The token should be included in the Authorization header of your requests. Once we create client credentials for you, you can use the client ID and client secret to either obtain a token directly using the client_credentials flow or redirect the user to the authorization URL to obtain a token using the authorization_code flow.
Our OpenID connect endpoints are listed below:
Queries
assetLinkingByDriverId
Response
Returns an AssetLinking
Arguments
| Name | Description |
|---|---|
driverId - ObjectId!
|
Example
Query
query AssetLinkingByDriverId($driverId: ObjectId!) {
assetLinkingByDriverId(driverId: $driverId) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
endDate
isHardLinked
startDate
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
}
Variables
{"driverId": ObjectId}
Response
{
"data": {
"assetLinkingByDriverId": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"driver": Driver,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": false,
"startDate": "2007-12-03T10:15:30Z",
"tractor": Tractor,
"trailer": Trailer
}
}
}
assetLinkingById
Response
Returns an AssetLinking
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query AssetLinkingById($id: String!) {
assetLinkingById(id: $id) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
endDate
isHardLinked
startDate
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"assetLinkingById": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"driver": Driver,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": false,
"startDate": "2007-12-03T10:15:30Z",
"tractor": Tractor,
"trailer": Trailer
}
}
}
assetLinkingByTractorId
Response
Returns an AssetLinking
Arguments
| Name | Description |
|---|---|
tractorId - ObjectId!
|
Example
Query
query AssetLinkingByTractorId($tractorId: ObjectId!) {
assetLinkingByTractorId(tractorId: $tractorId) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
endDate
isHardLinked
startDate
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
}
Variables
{"tractorId": ObjectId}
Response
{
"data": {
"assetLinkingByTractorId": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"driver": Driver,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": true,
"startDate": "2007-12-03T10:15:30Z",
"tractor": Tractor,
"trailer": Trailer
}
}
}
assetLinkingByTrailerId
Response
Returns an AssetLinking
Arguments
| Name | Description |
|---|---|
trailerId - ObjectId!
|
Example
Query
query AssetLinkingByTrailerId($trailerId: ObjectId!) {
assetLinkingByTrailerId(trailerId: $trailerId) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
endDate
isHardLinked
startDate
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
}
Variables
{"trailerId": ObjectId}
Response
{
"data": {
"assetLinkingByTrailerId": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"driver": Driver,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": true,
"startDate": "2007-12-03T10:15:30Z",
"tractor": Tractor,
"trailer": Trailer
}
}
}
assetLinkings
Response
Returns an AssetLinkingPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query AssetLinkings(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
assetLinkings(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
additionalTrailers {
...TrailerFragment
}
driver {
...DriverFragment
}
endDate
isHardLinked
startDate
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"assetLinkings": {
"count": 987,
"data": [AssetLinking]
}
}
}
assignedTrips
Response
Returns a TripPaginatedResult!
Example
Query
query AssignedTrips(
$driver: String,
$filter: JSON,
$fromDate: DateTime,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$sort: TripSort,
$status: Status,
$take: Int,
$toDate: DateTime
) {
assignedTrips(
driver: $driver,
filter: $filter,
fromDate: $fromDate,
orderBy: $orderBy,
search: $search,
skip: $skip,
sort: $sort,
status: $status,
take: $take,
toDate: $toDate
) {
count
data {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{
"driver": "abc123",
"filter": {},
"fromDate": "2007-12-03T10:15:30Z",
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"sort": TripSort,
"status": "ACTIVE",
"take": 300,
"toDate": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"assignedTrips": {"count": 987, "data": [Trip]}
}
}
billingRuleById
Response
Returns a BillingRule!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query BillingRuleById($id: String!) {
billingRuleById(id: $id) {
_id
amount
condition {
operator
parameters {
...BillingRuleConditionParameterFragment
}
target
value
}
conditions {
operator
parameters {
...BillingRuleConditionParameterFragment
}
target
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
label
method
priority
rates {
amount
label
method
parameters {
...BillingRateParameterFragment
}
referenceNumber
}
referenceNumber
type
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"billingRuleById": {
"_id": "abc123",
"amount": 123.45,
"condition": BillingRuleCondition,
"conditions": [BillingRuleCondition],
"customer": BusinessEntity,
"label": "abc123",
"method": "FLAT_FEE",
"priority": 123.45,
"rates": [BillingRate],
"referenceNumber": "xyz789",
"type": "ACCESSORIAL"
}
}
}
billingRules
Response
Returns a BillingRulePaginatedResult!
Example
Query
query BillingRules(
$customer: String,
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
billingRules(
customer: $customer,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
amount
condition {
...BillingRuleConditionFragment
}
conditions {
...BillingRuleConditionFragment
}
customer {
...BusinessEntityFragment
}
label
method
priority
rates {
...BillingRateFragment
}
referenceNumber
type
}
}
}
Variables
{
"customer": "abc123",
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"billingRules": {"count": 987, "data": [BillingRule]}
}
}
brokerById
Example
Query
query BrokerById($id: String!) {
brokerById(id: $id) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"brokerById": {
"_id": "xyz789",
"accessToken": "xyz789",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 987.65,
"code": "xyz789",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"xyz789"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
brokers
Response
Returns a BrokerPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Brokers(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
brokers(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{"data": {"brokers": {"count": 123, "data": [Broker]}}}
bulkMetrics
Response
Returns [Metric!]!
Arguments
| Name | Description |
|---|---|
aggregateBy - [String!]!
|
|
dateRange - DateRangeInput
|
|
types - [MetricType!]!
|
Example
Query
query BulkMetrics(
$aggregateBy: [String!]!,
$dateRange: DateRangeInput,
$types: [MetricType!]!
) {
bulkMetrics(
aggregateBy: $aggregateBy,
dateRange: $dateRange,
types: $types
) {
_id
date
dimensions
type
value
}
}
Variables
{
"aggregateBy": ["xyz789"],
"dateRange": DateRangeInput,
"types": ["DELIVERY_COST"]
}
Response
{
"data": {
"bulkMetrics": [
{
"_id": "xyz789",
"date": "2007-12-03T10:15:30Z",
"dimensions": {},
"type": "abc123",
"value": 987.65
}
]
}
}
businessEntities
Response
Returns a BusinessEntityPaginatedResult!
Arguments
| Name | Description |
|---|---|
businessEntityTypes - [BusinessEntityType!]
|
|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query BusinessEntities(
$businessEntityTypes: [BusinessEntityType!],
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
businessEntities(
businessEntityTypes: $businessEntityTypes,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{
"businessEntityTypes": ["BROKER"],
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"businessEntities": {
"count": 123,
"data": [BusinessEntity]
}
}
}
businessEntityByExternalId
Response
Returns a BusinessEntity
Arguments
| Name | Description |
|---|---|
externalId - String!
|
Example
Query
query BusinessEntityByExternalId($externalId: String!) {
businessEntityByExternalId(externalId: $externalId) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"externalId": "abc123"}
Response
{
"data": {
"businessEntityByExternalId": {
"_id": "xyz789",
"accessToken": "xyz789",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 987.65,
"code": "xyz789",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "abc123",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"xyz789"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
businessEntityById
Response
Returns a BusinessEntity!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query BusinessEntityById($id: String!) {
businessEntityById(id: $id) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"businessEntityById": {
"_id": "abc123",
"accessToken": "xyz789",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 987.65,
"code": "abc123",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "xyz789",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
chassis
Response
Returns a ChassisPaginatedResult!
Example
Query
query Chassis(
$search: String,
$skip: Int,
$take: Int
) {
chassis(
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
}
}
Variables
{"search": "xyz789", "skip": 0, "take": 25}
Response
{"data": {"chassis": {"count": 123, "data": [Chassis]}}}
chassisById
Example
Query
query ChassisById($id: String!) {
chassisById(id: $id) {
_id
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
serialNumber
status
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"chassisById": {
"_id": "xyz789",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"serialNumber": "abc123",
"status": "ACTIVE"
}
}
}
customFieldDefinitionById
Response
Returns a CustomFieldDefinition!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query CustomFieldDefinitionById($id: String!) {
customFieldDefinitionById(id: $id) {
_id
context
description
isRequirement
key
label
requirementOptions {
isPartial
isRange
isRequired
}
selectOptions {
key
label
}
selectOptionsEndpoint
selectOptionsEntity
type
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"customFieldDefinitionById": {
"_id": "xyz789",
"context": ["CARRIER"],
"description": "abc123",
"isRequirement": true,
"key": "xyz789",
"label": "abc123",
"requirementOptions": CustomFieldRequirementOptions,
"selectOptions": [CustomFieldSelectOption],
"selectOptionsEndpoint": "xyz789",
"selectOptionsEntity": "CARRIER",
"type": "BOOLEAN"
}
}
}
customerById
Example
Query
query CustomerById($id: String!) {
customerById(id: $id) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"customerById": {
"_id": "xyz789",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 987.65,
"code": "xyz789",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "abc123",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
customerOrderById
Example
Query
query CustomerOrderById($id: String!) {
customerOrderById(id: $id) {
_id
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
locations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
orderNumber
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentId
status
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"customerOrderById": {
"_id": "xyz789",
"customer": BusinessEntity,
"customerId": ObjectId,
"locations": [ShipmentLocation],
"orderNumber": "xyz789",
"shipment": Shipment,
"shipmentId": ObjectId,
"status": "ACTIVE"
}
}
}
customerOrders
Response
Returns an OrderPaginatedResult!
Example
Query
query CustomerOrders(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$status: Status,
$take: Int
) {
customerOrders(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
status: $status,
take: $take
) {
count
data {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"status": "ACTIVE",
"take": 25
}
Response
{
"data": {
"customerOrders": {"count": 123, "data": [Order]}
}
}
customerShipments
Response
Returns a ShipmentPaginatedResult!
Example
Query
query CustomerShipments(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$status: Status,
$take: Int
) {
customerShipments(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
status: $status,
take: $take
) {
count
data {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"status": "ACTIVE",
"take": 25
}
Response
{
"data": {
"customerShipments": {
"count": 123,
"data": [Shipment]
}
}
}
customers
Response
Returns a CustomerPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Customers(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
customers(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"customers": {"count": 987, "data": [Customer]}
}
}
cutomFieldDefinitions
Response
Returns a CustomFieldDefinitionPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query CutomFieldDefinitions(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
cutomFieldDefinitions(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
context
description
isRequirement
key
label
requirementOptions {
...CustomFieldRequirementOptionsFragment
}
selectOptions {
...CustomFieldSelectOptionFragment
}
selectOptionsEndpoint
selectOptionsEntity
type
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"cutomFieldDefinitions": {
"count": 123,
"data": [CustomFieldDefinition]
}
}
}
deductionRuleById
Response
Returns a DeductionRule!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query DeductionRuleById($id: String!) {
deductionRuleById(id: $id) {
_id
amount
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
label
method
period {
end
repeatEvery
start
unit
}
type
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"deductionRuleById": {
"_id": "xyz789",
"amount": 987.65,
"driver": Driver,
"label": "xyz789",
"method": "FLAT_FEE",
"period": DeductionPeriod,
"type": "BONUS"
}
}
}
deductionRules
Response
Returns a DeductionRulePaginatedResult!
Example
Query
query DeductionRules(
$driver: String,
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
deductionRules(
driver: $driver,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
amount
driver {
...DriverFragment
}
label
method
period {
...DeductionPeriodFragment
}
type
}
}
}
Variables
{
"driver": "abc123",
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"deductionRules": {
"count": 987,
"data": [DeductionRule]
}
}
}
driverByEldId
Example
Query
query DriverByEldId($eldId: String!) {
driverByEldId(eldId: $eldId) {
_id
customFields {
key
value
}
dateOfBirth
dateOfPhysicalExamination
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
domicileEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
eldId
firstname
groupIds
hos {
currentDrivingTime
currentOnDutyTime
currentStatus
statusTime
totalDrivingTime
totalOnDutyTime
}
isOwnerOperator
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
lastname
license {
address {
...TextualAddressFragment
}
classification
endorsements
expiryDate
issuedDate
issuedState
licenseNumber
restriction
}
medical {
expiryDate
issuedDate
number
restriction
}
middlename
phoneNumber
status
tags
userId
}
}
Variables
{"eldId": "xyz789"}
Response
{
"data": {
"driverByEldId": {
"_id": "abc123",
"customFields": [CustomField],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocument],
"domicile": Address,
"domicileEntity": BusinessEntity,
"domicileId": ObjectId,
"eldId": "abc123",
"firstname": "abc123",
"groupIds": [ObjectId],
"hos": DriverHos,
"isOwnerOperator": false,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"lastname": "abc123",
"license": DriverLicense,
"medical": DriverMedical,
"middlename": "abc123",
"phoneNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"userId": "xyz789"
}
}
}
driverById
Example
Query
query DriverById($id: String!) {
driverById(id: $id) {
_id
customFields {
key
value
}
dateOfBirth
dateOfPhysicalExamination
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
domicileEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
eldId
firstname
groupIds
hos {
currentDrivingTime
currentOnDutyTime
currentStatus
statusTime
totalDrivingTime
totalOnDutyTime
}
isOwnerOperator
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
lastname
license {
address {
...TextualAddressFragment
}
classification
endorsements
expiryDate
issuedDate
issuedState
licenseNumber
restriction
}
medical {
expiryDate
issuedDate
number
restriction
}
middlename
phoneNumber
status
tags
userId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"driverById": {
"_id": "xyz789",
"customFields": [CustomField],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocument],
"domicile": Address,
"domicileEntity": BusinessEntity,
"domicileId": ObjectId,
"eldId": "xyz789",
"firstname": "abc123",
"groupIds": [ObjectId],
"hos": DriverHos,
"isOwnerOperator": true,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"lastname": "abc123",
"license": DriverLicense,
"medical": DriverMedical,
"middlename": "xyz789",
"phoneNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"userId": "xyz789"
}
}
}
driverByLicenseNumber
Example
Query
query DriverByLicenseNumber($licenseNumber: String!) {
driverByLicenseNumber(licenseNumber: $licenseNumber) {
_id
customFields {
key
value
}
dateOfBirth
dateOfPhysicalExamination
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
domicileEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
eldId
firstname
groupIds
hos {
currentDrivingTime
currentOnDutyTime
currentStatus
statusTime
totalDrivingTime
totalOnDutyTime
}
isOwnerOperator
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
lastname
license {
address {
...TextualAddressFragment
}
classification
endorsements
expiryDate
issuedDate
issuedState
licenseNumber
restriction
}
medical {
expiryDate
issuedDate
number
restriction
}
middlename
phoneNumber
status
tags
userId
}
}
Variables
{"licenseNumber": "xyz789"}
Response
{
"data": {
"driverByLicenseNumber": {
"_id": "xyz789",
"customFields": [CustomField],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocument],
"domicile": Address,
"domicileEntity": BusinessEntity,
"domicileId": ObjectId,
"eldId": "xyz789",
"firstname": "abc123",
"groupIds": [ObjectId],
"hos": DriverHos,
"isOwnerOperator": true,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"lastname": "abc123",
"license": DriverLicense,
"medical": DriverMedical,
"middlename": "xyz789",
"phoneNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"userId": "xyz789"
}
}
}
driverSettlementById
Response
Returns a DriverSettlement
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query DriverSettlementById($id: String!) {
driverSettlementById(id: $id) {
_id
deductions {
_id
amount
date
deductionRule {
...DeductionRuleFragment
}
label
type
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverSettlementNumber
endDate
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
pdfDocument {
error
isGenerating
url
}
startDate
status
trips {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"driverSettlementById": {
"_id": "xyz789",
"deductions": [Deduction],
"driver": Driver,
"driverSettlementNumber": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"payments": [TripPayment],
"pdfDocument": DriverSettlementPdf,
"startDate": "2007-12-03T10:15:30Z",
"status": "CANCELLED",
"trips": [Trip]
}
}
}
driverSettlementByNumber
Response
Returns a DriverSettlement!
Arguments
| Name | Description |
|---|---|
driverSettlementNumber - String!
|
Example
Query
query DriverSettlementByNumber($driverSettlementNumber: String!) {
driverSettlementByNumber(driverSettlementNumber: $driverSettlementNumber) {
_id
deductions {
_id
amount
date
deductionRule {
...DeductionRuleFragment
}
label
type
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverSettlementNumber
endDate
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
pdfDocument {
error
isGenerating
url
}
startDate
status
trips {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{"driverSettlementNumber": "xyz789"}
Response
{
"data": {
"driverSettlementByNumber": {
"_id": "xyz789",
"deductions": [Deduction],
"driver": Driver,
"driverSettlementNumber": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"payments": [TripPayment],
"pdfDocument": DriverSettlementPdf,
"startDate": "2007-12-03T10:15:30Z",
"status": "CANCELLED",
"trips": [Trip]
}
}
}
driverSettlements
Response
Returns a DriverSettlementPaginatedResult!
Arguments
| Name | Description |
|---|---|
driver - String
|
|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
status - DriverSettlementStatus
|
|
take - Int
|
Default = 300 |
Example
Query
query DriverSettlements(
$driver: String,
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$status: DriverSettlementStatus,
$take: Int
) {
driverSettlements(
driver: $driver,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
status: $status,
take: $take
) {
count
data {
_id
deductions {
...DeductionFragment
}
driver {
...DriverFragment
}
driverSettlementNumber
endDate
payments {
...TripPaymentFragment
}
pdfDocument {
...DriverSettlementPdfFragment
}
startDate
status
trips {
...TripFragment
}
}
}
}
Variables
{
"driver": "xyz789",
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"status": "CANCELLED",
"take": 300
}
Response
{
"data": {
"driverSettlements": {
"count": 123,
"data": [DriverSettlement]
}
}
}
driverShiftAssignmentByDriverId
Response
Returns a DriverShiftAssignment
Arguments
| Name | Description |
|---|---|
driverId - ObjectId!
|
Example
Query
query DriverShiftAssignmentByDriverId($driverId: ObjectId!) {
driverShiftAssignmentByDriverId(driverId: $driverId) {
_id
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverId
driverShift {
_id
days
domicile {
...BusinessEntityFragment
}
domicileId
driverIds
endTime {
...TimeFragment
}
isAdhoc
label
startTime {
...TimeFragment
}
}
driverShiftId
endDate
startDate
}
}
Variables
{"driverId": ObjectId}
Response
{
"data": {
"driverShiftAssignmentByDriverId": {
"_id": "xyz789",
"driver": Driver,
"driverId": ObjectId,
"driverShift": DriverShift,
"driverShiftId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"startDate": "2007-12-03T10:15:30Z"
}
}
}
driverShiftAssignmentById
Response
Returns a DriverShiftAssignment
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query DriverShiftAssignmentById($id: String!) {
driverShiftAssignmentById(id: $id) {
_id
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverId
driverShift {
_id
days
domicile {
...BusinessEntityFragment
}
domicileId
driverIds
endTime {
...TimeFragment
}
isAdhoc
label
startTime {
...TimeFragment
}
}
driverShiftId
endDate
startDate
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"driverShiftAssignmentById": {
"_id": "xyz789",
"driver": Driver,
"driverId": ObjectId,
"driverShift": DriverShift,
"driverShiftId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"startDate": "2007-12-03T10:15:30Z"
}
}
}
driverShiftAssignments
Response
Returns a DriverShiftAssignmentPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query DriverShiftAssignments(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
driverShiftAssignments(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
driver {
...DriverFragment
}
driverId
driverShift {
...DriverShiftFragment
}
driverShiftId
endDate
startDate
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"driverShiftAssignments": {
"count": 123,
"data": [DriverShiftAssignment]
}
}
}
driverShiftByDriverId
Response
Returns a DriverShift
Arguments
| Name | Description |
|---|---|
driverId - ObjectId!
|
Example
Query
query DriverShiftByDriverId($driverId: ObjectId!) {
driverShiftByDriverId(driverId: $driverId) {
_id
days
domicile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
driverIds
endTime {
hour
minute
}
isAdhoc
label
startTime {
hour
minute
}
}
}
Variables
{"driverId": ObjectId}
Response
{
"data": {
"driverShiftByDriverId": {
"_id": "abc123",
"days": [123],
"domicile": BusinessEntity,
"domicileId": ObjectId,
"driverIds": [ObjectId],
"endTime": Time,
"isAdhoc": false,
"label": "abc123",
"startTime": Time
}
}
}
driverShiftById
Response
Returns a DriverShift
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query DriverShiftById($id: String!) {
driverShiftById(id: $id) {
_id
days
domicile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
driverIds
endTime {
hour
minute
}
isAdhoc
label
startTime {
hour
minute
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"driverShiftById": {
"_id": "abc123",
"days": [123],
"domicile": BusinessEntity,
"domicileId": ObjectId,
"driverIds": [ObjectId],
"endTime": Time,
"isAdhoc": true,
"label": "xyz789",
"startTime": Time
}
}
}
driverShifts
Response
Returns a DriverShiftPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query DriverShifts(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
driverShifts(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
days
domicile {
...BusinessEntityFragment
}
domicileId
driverIds
endTime {
...TimeFragment
}
isAdhoc
label
startTime {
...TimeFragment
}
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"driverShifts": {"count": 123, "data": [DriverShift]}
}
}
drivers
Response
Returns a DriverPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
where - DriverWhere
|
Example
Query
query Drivers(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int,
$where: DriverWhere
) {
drivers(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take,
where: $where
) {
count
data {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300,
"where": DriverWhere
}
Response
{"data": {"drivers": {"count": 123, "data": [Driver]}}}
extensionById
Response
Returns an Extension!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query ExtensionById($id: String!) {
extensionById(id: $id) {
_id
category
configurationDefinitions {
defaultValue
description
name
required
type
}
coverImage
description
name
settings {
authEndpoint
configureEndpoint
customFields {
...ExtensionCustomFieldDefinitionFragment
}
eventHandlers {
...ExtensionEventHandlerFragment
}
hooks {
...ExtensionHookFragment
}
installEndpoint
messagesEndpoint
operations {
...ExtensionOperationFragment
}
rootUrl
uninstallEndpoint
widgets {
...ExtensionWidgetFragment
}
}
websiteUrl
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"extensionById": {
"_id": "abc123",
"category": "abc123",
"configurationDefinitions": [
ExtensionConfigurationDefinition
],
"coverImage": "xyz789",
"description": "xyz789",
"name": "abc123",
"settings": ExtensionSettings,
"websiteUrl": "abc123"
}
}
}
extensions
Response
Returns an ExtensionPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Extensions(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
extensions(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
extension {
...ExtensionFragment
}
installed
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"extensions": {
"count": 123,
"data": [ExtensionWithStatus]
}
}
}
extensionsCustomFields
Response
Arguments
| Name | Description |
|---|---|
context - ExtensionCustomFieldContext!
|
Example
Query
query ExtensionsCustomFields($context: ExtensionCustomFieldContext!) {
extensionsCustomFields(context: $context) {
context
description
extensionId
key
label
selectOptions {
key
label
}
selectOptionsEndpoint
type
}
}
Variables
{"context": "EXPENSE"}
Response
{
"data": {
"extensionsCustomFields": [
{
"context": "xyz789",
"description": "xyz789",
"extensionId": "xyz789",
"key": "abc123",
"label": "xyz789",
"selectOptions": [
ExtensionCustomFieldSelectOption
],
"selectOptionsEndpoint": "abc123",
"type": "BOOLEAN"
}
]
}
}
extensionsMessages
Response
Returns [ExtensionMessage!]!
Example
Query
query ExtensionsMessages {
extensionsMessages {
actions {
text
type
url
}
context
extensionId
extensionName
text
type
}
}
Response
{
"data": {
"extensionsMessages": [
{
"actions": [ExtensionAction],
"context": "ORDERS_LIST",
"extensionId": "abc123",
"extensionName": "abc123",
"text": "xyz789",
"type": "ERROR"
}
]
}
}
extensionsOperations
Response
Arguments
| Name | Description |
|---|---|
context - ExtensionOperationContext!
|
Example
Query
query ExtensionsOperations($context: ExtensionOperationContext!) {
extensionsOperations(context: $context) {
context
description
endpoint
extensionId
icon
key
name
}
}
Variables
{"context": "BUSINESS_ENTITY"}
Response
{
"data": {
"extensionsOperations": [
{
"context": "BUSINESS_ENTITY",
"description": "xyz789",
"endpoint": "xyz789",
"extensionId": "xyz789",
"icon": "abc123",
"key": "abc123",
"name": "xyz789"
}
]
}
}
extensionsWidgets
Response
Arguments
| Name | Description |
|---|---|
context - ExtensionWidgetContext!
|
Example
Query
query ExtensionsWidgets($context: ExtensionWidgetContext!) {
extensionsWidgets(context: $context) {
context
endpoint
extensionId
label
rootUrl
}
}
Variables
{"context": "PLANNING_TOOL_HEADER"}
Response
{
"data": {
"extensionsWidgets": [
{
"context": "PLANNING_TOOL_HEADER",
"endpoint": "abc123",
"extensionId": "xyz789",
"label": "abc123",
"rootUrl": "abc123"
}
]
}
}
forecastingNotifications
Response
Returns [ForecastingNotification!]!
Arguments
| Name | Description |
|---|---|
receiverId - ObjectId
|
Example
Query
query ForecastingNotifications($receiverId: ObjectId) {
forecastingNotifications(receiverId: $receiverId) {
level
message
receiverForecastId
receiverId
storageFacilityId
}
}
Variables
{"receiverId": ObjectId}
Response
{
"data": {
"forecastingNotifications": [
{
"level": "CRITICAL",
"message": "xyz789",
"receiverForecastId": ObjectId,
"receiverId": ObjectId,
"storageFacilityId": "xyz789"
}
]
}
}
goodProfileById
Response
Returns a GoodProfile!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query GoodProfileById($id: String!) {
goodProfileById(id: $id) {
_id
code
color
customFields {
key
value
}
documents {
_id
name
url
}
equivalences {
conditions {
...GoodProfileEquivalenceConditionFragment
}
equivalentGoodId
}
externalId
goodProfileClass {
_id
description
label
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
type
value
}
shipperIds
supplierIds
tags
unit
weight
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"goodProfileById": {
"_id": "xyz789",
"code": "abc123",
"color": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"equivalences": [GoodProfileEquivalence],
"externalId": "abc123",
"goodProfileClass": GoodProfileClass,
"goodProfileClassId": ObjectId,
"groupIds": [ObjectId],
"label": "xyz789",
"liquidGravity": 123.45,
"restrictions": [GoodProfileRestriction],
"shipperIds": ["xyz789"],
"supplierIds": ["xyz789"],
"tags": ["abc123"],
"unit": "GALLONS",
"weight": 123.45
}
}
}
goodProfileClassById
Response
Returns a GoodProfileClass
Arguments
| Name | Description |
|---|---|
id - ObjectId!
|
Example
Query
query GoodProfileClassById($id: ObjectId!) {
goodProfileClassById(id: $id) {
_id
description
label
}
}
Variables
{"id": ObjectId}
Response
{
"data": {
"goodProfileClassById": {
"_id": ObjectId,
"description": "abc123",
"label": "xyz789"
}
}
}
goodProfileClasses
Response
Returns a GoodProfileClassPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query GoodProfileClasses(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
goodProfileClasses(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
description
label
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"goodProfileClasses": {
"count": 123,
"data": [GoodProfileClass]
}
}
}
goodProfiles
Response
Returns a GoodProfilePaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query GoodProfiles(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
goodProfiles(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"goodProfiles": {"count": 123, "data": [GoodProfile]}
}
}
groupById
Example
Query
query GroupById($id: String!) {
groupById(id: $id) {
_id
description
memberIds
name
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"groupById": {
"_id": "abc123",
"description": "abc123",
"memberIds": ["abc123"],
"name": "xyz789"
}
}
}
groups
Response
Returns a GroupPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Groups(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
groups(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
description
memberIds
name
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{"data": {"groups": {"count": 123, "data": [Group]}}}
invoiceById
Example
Query
query InvoiceById($id: String!) {
invoiceById(id: $id) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"invoiceById": {
"_id": "abc123",
"charges": [ShipmentCharge],
"closingNote": "abc123",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "abc123",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 987.65,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 987.65
}
}
}
invoiceByInvoiceNumber
Example
Query
query InvoiceByInvoiceNumber($invoiceNumber: String!) {
invoiceByInvoiceNumber(invoiceNumber: $invoiceNumber) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{"invoiceNumber": "abc123"}
Response
{
"data": {
"invoiceByInvoiceNumber": {
"_id": "abc123",
"charges": [ShipmentCharge],
"closingNote": "abc123",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "xyz789",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 123.45,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 123.45
}
}
}
invoiceByShipmentId
Example
Query
query InvoiceByShipmentId($shipmentId: String!) {
invoiceByShipmentId(shipmentId: $shipmentId) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{"shipmentId": "abc123"}
Response
{
"data": {
"invoiceByShipmentId": {
"_id": "xyz789",
"charges": [ShipmentCharge],
"closingNote": "xyz789",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "xyz789",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 987.65,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 987.65
}
}
}
invoices
Response
Returns an InvoicePaginatedResult!
Arguments
| Name | Description |
|---|---|
customer - String
|
|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
status - InvoiceStatus
|
|
take - Int
|
Default = 300 |
Example
Query
query Invoices(
$customer: String,
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$status: InvoiceStatus,
$take: Int
) {
invoices(
customer: $customer,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
status: $status,
take: $take
) {
count
data {
_id
charges {
...ShipmentChargeFragment
}
closingNote
customer {
...BusinessEntityFragment
}
groupIds
invoiceNumber
missingRequiredDocuments {
...DocumentRequirementFragment
}
paidAmount
payments {
...InvoicePaymentFragment
}
pdfDocument {
...InvoicePdfFragment
}
shipment {
...ShipmentFragment
}
shipmentIds
shipments {
...ShipmentFragment
}
status
taxRate
}
}
}
Variables
{
"customer": "xyz789",
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"status": "CANCELLED",
"take": 300
}
Response
{"data": {"invoices": {"count": 123, "data": [Invoice]}}}
isSubscribed
Response
Returns a Boolean!
Example
Query
query IsSubscribed {
isSubscribed
}
Response
{"data": {"isSubscribed": false}}
loadBoardLoadById
Example
Query
query LoadBoardLoadById($id: String!) {
loadBoardLoadById(id: $id) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"loadBoardLoadById": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": true,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
loadBoardLoads
Response
Returns a LoadBoardSearchResultPaginatedResult!
Arguments
| Name | Description |
|---|---|
searchCriteria - LoadBoardSearchCriteria!
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query LoadBoardLoads(
$searchCriteria: LoadBoardSearchCriteria!,
$skip: Int,
$take: Int
) {
loadBoardLoads(
searchCriteria: $searchCriteria,
skip: $skip,
take: $take
) {
count
data {
_id
additionalTrailerTypes
charges {
...ShipmentChargeFragment
}
constraints {
...ShipmentConstraintFragment
}
customer {
...BusinessEntityFragment
}
loadType
shipmentLocations {
...ShipmentLocationFragment
}
trailerType
}
}
}
Variables
{
"searchCriteria": LoadBoardSearchCriteria,
"skip": 0,
"take": 300
}
Response
{
"data": {
"loadBoardLoads": {
"count": 987,
"data": [LoadBoardSearchResult]
}
}
}
maintenanceTaskByDriverId
Response
Returns a MaintenanceTask
Arguments
| Name | Description |
|---|---|
driverId - ObjectId!
|
Example
Query
query MaintenanceTaskByDriverId($driverId: ObjectId!) {
maintenanceTaskByDriverId(driverId: $driverId) {
_id
assetId
assetType
endDate
label
recurrence {
frequency
interval
}
required
startDate
startMileage
status
}
}
Variables
{"driverId": ObjectId}
Response
{
"data": {
"maintenanceTaskByDriverId": {
"_id": "xyz789",
"assetId": ObjectId,
"assetType": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"label": "xyz789",
"recurrence": MaintenanceTaskRecurrence,
"required": true,
"startDate": "2007-12-03T10:15:30Z",
"startMileage": 987.65,
"status": "CANCELLED"
}
}
}
maintenanceTaskById
Response
Returns a MaintenanceTask
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query MaintenanceTaskById($id: String!) {
maintenanceTaskById(id: $id) {
_id
assetId
assetType
endDate
label
recurrence {
frequency
interval
}
required
startDate
startMileage
status
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"maintenanceTaskById": {
"_id": "xyz789",
"assetId": ObjectId,
"assetType": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"label": "xyz789",
"recurrence": MaintenanceTaskRecurrence,
"required": true,
"startDate": "2007-12-03T10:15:30Z",
"startMileage": 123.45,
"status": "CANCELLED"
}
}
}
maintenanceTasks
Response
Returns a MaintenanceTaskPaginatedResult!
Arguments
| Name | Description |
|---|---|
assetId - ObjectId
|
|
assetType - TripAssetTypes
|
|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
status - MaintenanceTaskStatus
|
|
take - Int
|
Default = 300 |
Example
Query
query MaintenanceTasks(
$assetId: ObjectId,
$assetType: TripAssetTypes,
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$status: MaintenanceTaskStatus,
$take: Int
) {
maintenanceTasks(
assetId: $assetId,
assetType: $assetType,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
status: $status,
take: $take
) {
count
data {
_id
assetId
assetType
endDate
label
recurrence {
...MaintenanceTaskRecurrenceFragment
}
required
startDate
startMileage
status
}
}
}
Variables
{
"assetId": ObjectId,
"assetType": "ADDITIONAL_TRAILERS",
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"status": "CANCELLED",
"take": 300
}
Response
{
"data": {
"maintenanceTasks": {
"count": 123,
"data": [MaintenanceTask]
}
}
}
metrics
Response
Returns [Metric!]!
Arguments
| Name | Description |
|---|---|
aggregateBy - [String!]!
|
|
dateRange - DateRangeInput
|
|
type - MetricType!
|
Example
Query
query Metrics(
$aggregateBy: [String!]!,
$dateRange: DateRangeInput,
$type: MetricType!
) {
metrics(
aggregateBy: $aggregateBy,
dateRange: $dateRange,
type: $type
) {
_id
date
dimensions
type
value
}
}
Variables
{
"aggregateBy": ["xyz789"],
"dateRange": DateRangeInput,
"type": "DELIVERY_COST"
}
Response
{
"data": {
"metrics": [
{
"_id": "xyz789",
"date": "2007-12-03T10:15:30Z",
"dimensions": {},
"type": "xyz789",
"value": 123.45
}
]
}
}
myDocuments
Response
Returns [OrganizationDocument!]!
Example
Query
query MyDocuments {
myDocuments {
_id
name
url
}
}
Response
{
"data": {
"myDocuments": [
{
"_id": "abc123",
"name": "xyz789",
"url": "xyz789"
}
]
}
}
myDriverSettlements
Response
Returns a MyDriverSettlementPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query MyDriverSettlements(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
myDriverSettlements(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
deductions {
...DeductionFragment
}
driver {
...DriverFragment
}
driverSettlementNumber
endDate
payments {
...TripPaymentFragment
}
pdfDocument {
...DriverSettlementPdfFragment
}
startDate
status
trips {
...TripFragment
}
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"myDriverSettlements": {
"count": 123,
"data": [DriverSettlement]
}
}
}
myOrganization
Response
Returns an Organization!
Example
Query
query MyOrganization {
myOrganization {
_id
address
attributes {
chargebeeCustomerId
dotNumber
}
contactFullname
displayName
dotNumber
email
id
name
phoneNumber
realm
}
}
Response
{
"data": {
"myOrganization": {
"_id": "abc123",
"address": "abc123",
"attributes": KeycloakOrganizationAttributes,
"contactFullname": "xyz789",
"displayName": "abc123",
"dotNumber": "xyz789",
"email": Email,
"id": "xyz789",
"name": "xyz789",
"phoneNumber": "abc123",
"realm": "abc123"
}
}
}
orderById
Example
Query
query OrderById($id: String!) {
orderById(id: $id) {
_id
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
locations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
orderNumber
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentId
status
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"orderById": {
"_id": "xyz789",
"customer": BusinessEntity,
"customerId": ObjectId,
"locations": [ShipmentLocation],
"orderNumber": "xyz789",
"shipment": Shipment,
"shipmentId": ObjectId,
"status": "ACTIVE"
}
}
}
orders
Response
Returns an OrderPaginatedResult!
Example
Query
query Orders(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$status: Status,
$take: Int
) {
orders(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
status: $status,
take: $take
) {
count
data {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"status": "ACTIVE",
"take": 25
}
Response
{"data": {"orders": {"count": 987, "data": [Order]}}}
orgUserById
Example
Query
query OrgUserById($id: String!) {
orgUserById(id: $id) {
_id
attributes {
customFields
driverId
freshchatRestoreId
phoneNumber
phoneNumberVerified
promoCode
tags
trialDays
}
email
enabled
firstName
id
lastName
roles {
id
name
}
username
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"orgUserById": {
"_id": "abc123",
"attributes": UserAttributes,
"email": "xyz789",
"enabled": true,
"firstName": "xyz789",
"id": "xyz789",
"lastName": "abc123",
"roles": [KeycloakUserRole],
"username": "xyz789"
}
}
}
orgUsers
Response
Returns an OrgUserPaginatedResult!
Example
Query
query OrgUsers(
$enabled: Boolean,
$filter: JSON,
$orderBy: [OrderByItem!],
$roles: [String!],
$search: String,
$skip: Int,
$take: Int
) {
orgUsers(
enabled: $enabled,
filter: $filter,
orderBy: $orderBy,
roles: $roles,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
attributes {
...UserAttributesFragment
}
email
enabled
firstName
id
lastName
roles {
...KeycloakUserRoleFragment
}
username
}
}
}
Variables
{
"enabled": true,
"filter": {},
"orderBy": [OrderByItem],
"roles": ["abc123"],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{"data": {"orgUsers": {"count": 987, "data": [OrgUser]}}}
organizationSettings
Response
Returns an OrganizationSettings
Example
Query
query OrganizationSettings {
organizationSettings {
_id
dispatching {
canChangeTripOrder
canConsolidateInProgressShipments
canDriverSetAlternateSupplierPinCode
canUseAdHocAddress
enableCapacityWarnings
}
general {
currency
driversCanSeeFutureTrips
language
measurementSystem
singleClickTripCompletion
useSimpleWorkflow
weekStartsOn
}
invoicing {
companyAddress
companyEmail
companyPhone
enableConsolidatedInvoicing
enableTaxRate
logoUrl
prefix
primaryColor
processes
receiverDocumentationBodyTemplate
receiverDocumentationSubjectTemplate
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
showLoadedDeliveredQuantities
}
name
ratecon {
bodyTemplate
companyAddress
companyEmail
companyPhone
subjectTemplate
termsAndConditions
}
transactionTemplates {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
}
}
Response
{
"data": {
"organizationSettings": {
"_id": "xyz789",
"dispatching": DispatchingSettings,
"general": GeneralSettings,
"invoicing": InvoicingSettings,
"name": "abc123",
"ratecon": RateconSettings,
"transactionTemplates": [TransactionInputObject]
}
}
}
ownedTrailerTypes
Response
Returns [TrailerType!]!
Example
Query
query OwnedTrailerTypes {
ownedTrailerTypes
}
Response
{"data": {"ownedTrailerTypes": ["AUTO_CARRIER"]}}
paymentRuleById
Response
Returns a PaymentRule!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query PaymentRuleById($id: String!) {
paymentRuleById(id: $id) {
_id
amount
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
method
period {
end
repeatEvery
start
unit
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"paymentRuleById": {
"_id": "abc123",
"amount": 987.65,
"driver": Driver,
"method": "PER_HOUR",
"period": PaymentPeriod
}
}
}
paymentRules
Response
Returns a PaymentRulePaginatedResult!
Example
Query
query PaymentRules(
$driver: String,
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
paymentRules(
driver: $driver,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
amount
driver {
...DriverFragment
}
method
period {
...PaymentPeriodFragment
}
}
}
}
Variables
{
"driver": "xyz789",
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"paymentRules": {"count": 123, "data": [PaymentRule]}
}
}
qualificationByDriverId
Response
Returns a Qualification
Arguments
| Name | Description |
|---|---|
driverId - ObjectId!
|
Example
Query
query QualificationByDriverId($driverId: ObjectId!) {
qualificationByDriverId(driverId: $driverId) {
_id
assetId
assetType
documents {
_id
name
url
}
endDate
label
number
required
startDate
}
}
Variables
{"driverId": ObjectId}
Response
{
"data": {
"qualificationByDriverId": {
"_id": "abc123",
"assetId": ObjectId,
"assetType": "abc123",
"documents": [Document],
"endDate": "2007-12-03T10:15:30Z",
"label": "xyz789",
"number": "xyz789",
"required": true,
"startDate": "2007-12-03T10:15:30Z"
}
}
}
qualificationById
Response
Returns a Qualification
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query QualificationById($id: String!) {
qualificationById(id: $id) {
_id
assetId
assetType
documents {
_id
name
url
}
endDate
label
number
required
startDate
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"qualificationById": {
"_id": "xyz789",
"assetId": ObjectId,
"assetType": "abc123",
"documents": [Document],
"endDate": "2007-12-03T10:15:30Z",
"label": "abc123",
"number": "xyz789",
"required": false,
"startDate": "2007-12-03T10:15:30Z"
}
}
}
qualifications
Response
Returns a QualificationPaginatedResult!
Arguments
| Name | Description |
|---|---|
assetId - ObjectId
|
|
assetType - TripAssetTypes
|
|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Qualifications(
$assetId: ObjectId,
$assetType: TripAssetTypes,
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
qualifications(
assetId: $assetId,
assetType: $assetType,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
assetId
assetType
documents {
...DocumentFragment
}
endDate
label
number
required
startDate
}
}
}
Variables
{
"assetId": ObjectId,
"assetType": "ADDITIONAL_TRAILERS",
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"qualifications": {
"count": 987,
"data": [Qualification]
}
}
}
reasonCodeById
Response
Returns a ReasonCode
Arguments
| Name | Description |
|---|---|
id - ObjectId!
|
Example
Query
query ReasonCodeById($id: ObjectId!) {
reasonCodeById(id: $id) {
_id
createdAt
createdBy
description
locationId
shipmentId
tripId
type
updatedAt
}
}
Variables
{"id": ObjectId}
Response
{
"data": {
"reasonCodeById": {
"_id": ObjectId,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": "xyz789",
"description": "abc123",
"locationId": "abc123",
"shipmentId": ObjectId,
"tripId": ObjectId,
"type": "CUSTOMER",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
reasonCodes
Response
Returns a ReasonCodePaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query ReasonCodes(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
reasonCodes(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
createdAt
createdBy
description
locationId
shipmentId
tripId
type
updatedAt
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"reasonCodes": {"count": 123, "data": [ReasonCode]}
}
}
reasonCodesByShipment
Response
Returns a ReasonCodePaginatedResult!
Arguments
| Name | Description |
|---|---|
shipmentId - ObjectId!
|
Example
Query
query ReasonCodesByShipment($shipmentId: ObjectId!) {
reasonCodesByShipment(shipmentId: $shipmentId) {
count
data {
_id
createdAt
createdBy
description
locationId
shipmentId
tripId
type
updatedAt
}
}
}
Variables
{"shipmentId": ObjectId}
Response
{
"data": {
"reasonCodesByShipment": {
"count": 123,
"data": [ReasonCode]
}
}
}
reasonCodesByTrip
Response
Returns a ReasonCodePaginatedResult!
Arguments
| Name | Description |
|---|---|
tripId - ObjectId!
|
Example
Query
query ReasonCodesByTrip($tripId: ObjectId!) {
reasonCodesByTrip(tripId: $tripId) {
count
data {
_id
createdAt
createdBy
description
locationId
shipmentId
tripId
type
updatedAt
}
}
}
Variables
{"tripId": ObjectId}
Response
{
"data": {
"reasonCodesByTrip": {
"count": 123,
"data": [ReasonCode]
}
}
}
receiverById
Example
Query
query ReceiverById($id: String!) {
receiverById(id: $id) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"receiverById": {
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 987.65,
"code": "xyz789",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "xyz789",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"xyz789"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
receiverForecastById
Response
Returns a ReceiverForecast!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query ReceiverForecastById($id: String!) {
receiverForecastById(id: $id) {
_id
models {
_id
contaminates
isExclusive
label
maxCapacity
minCapacity
slots {
...ForecastingModelSlotFragment
}
storageFacilityId
target
threshold
weight
}
readingsFileConfiguration {
dateColumn
dateFormat
levelColumn
readingDeviationCriticalThreshold
readingDeviationDangerThreshold
readingDeviationWarningThreshold
runoutCriticalThreshold
runoutDangerThreshold
runoutWarningThreshold
staleReadingCriticalThreshold
staleReadingDangerThreshold
staleReadingWarningThreshold
storeColumn
tankIdColumn
timeColumn
timeFormat
}
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverId
trailerProfile {
compartments {
...TrailerProfileCompartmentFragment
}
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"receiverForecastById": {
"_id": "abc123",
"models": [ForecastingModel],
"readingsFileConfiguration": ReadingsFileConfiguration,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"trailerProfile": TrailerProfile
}
}
}
receiverForecasts
Response
Returns a ReceiverForecastPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query ReceiverForecasts(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
receiverForecasts(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
models {
...ForecastingModelFragment
}
readingsFileConfiguration {
...ReadingsFileConfigurationFragment
}
receiver {
...BusinessEntityFragment
}
receiverId
trailerProfile {
...TrailerProfileFragment
}
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"receiverForecasts": {
"count": 123,
"data": [ReceiverForecast]
}
}
}
receivers
Response
Returns a ReceiverPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Receivers(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
receivers(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"receivers": {"count": 123, "data": [Receiver]}
}
}
relationshipByDriverId
Response
Returns a Relationship
Arguments
| Name | Description |
|---|---|
driverId - ObjectId!
|
Example
Query
query RelationshipByDriverId($driverId: ObjectId!) {
relationshipByDriverId(driverId: $driverId) {
_id
commodities {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
commodityIds
customerIds
customers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverIds
receivers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipperIds
shippers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
supplierIds
suppliers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{"driverId": ObjectId}
Response
{
"data": {
"relationshipByDriverId": {
"_id": "abc123",
"commodities": [GoodProfile],
"commodityIds": [ObjectId],
"customerIds": [ObjectId],
"customers": [BusinessEntity],
"receiverIds": [ObjectId],
"receivers": [BusinessEntity],
"shipperIds": [ObjectId],
"shippers": [BusinessEntity],
"supplierIds": [ObjectId],
"suppliers": [BusinessEntity]
}
}
}
relationshipById
Response
Returns a Relationship
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query RelationshipById($id: String!) {
relationshipById(id: $id) {
_id
commodities {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
commodityIds
customerIds
customers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverIds
receivers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipperIds
shippers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
supplierIds
suppliers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"relationshipById": {
"_id": "xyz789",
"commodities": [GoodProfile],
"commodityIds": [ObjectId],
"customerIds": [ObjectId],
"customers": [BusinessEntity],
"receiverIds": [ObjectId],
"receivers": [BusinessEntity],
"shipperIds": [ObjectId],
"shippers": [BusinessEntity],
"supplierIds": [ObjectId],
"suppliers": [BusinessEntity]
}
}
}
relationships
Response
Returns a RelationshipPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Relationships(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
relationships(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
commodities {
...GoodProfileFragment
}
commodityIds
customerIds
customers {
...BusinessEntityFragment
}
receiverIds
receivers {
...BusinessEntityFragment
}
shipperIds
shippers {
...BusinessEntityFragment
}
supplierIds
suppliers {
...BusinessEntityFragment
}
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"relationships": {
"count": 987,
"data": [Relationship]
}
}
}
reportData
Response
Returns a ReportData!
Arguments
| Name | Description |
|---|---|
filter - ReportFilter
|
|
lang - String!
|
|
period - PeriodInput!
|
|
reportType - ReportType!
|
Example
Query
query ReportData(
$filter: ReportFilter,
$lang: String!,
$period: PeriodInput!,
$reportType: ReportType!
) {
reportData(
filter: $filter,
lang: $lang,
period: $period,
reportType: $reportType
) {
data {
_id {
...ReportItemIdFragment
}
values
}
period {
end
start
}
xAxisLabel
}
}
Variables
{
"filter": ReportFilter,
"lang": "xyz789",
"period": PeriodInput,
"reportType": "CUSTOMER_REVENUE"
}
Response
{
"data": {
"reportData": {
"data": [ReportItem],
"period": Period,
"xAxisLabel": "xyz789"
}
}
}
roles
Response
Returns [KeycloakUserRole!]!
Example
Query
query Roles {
roles {
id
name
}
}
Response
{
"data": {
"roles": [
{
"id": "abc123",
"name": "abc123"
}
]
}
}
shipmentById
Example
Query
query ShipmentById($id: String!) {
shipmentById(id: $id) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"shipmentById": {
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": false,
"isSplit": true,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
shipments
Response
Returns a ShipmentPaginatedResult!
Arguments
| Name | Description |
|---|---|
excludePastShipments - Boolean
|
If true, will exclude shipments that are in the past |
excludeRecurrentShipments - Boolean
|
If true, will exclude shipments that are recurrent. |
excludeRotationShipments - Boolean
|
If true, will exclude shipments that have rotations |
excludeSplitShipments - Boolean
|
If true, will exclude shipments that have been split |
filter - JSON
|
Filters to apply to the shipments |
ids - [ObjectId!]
|
|
orderBy - [OrderByItem!]
|
|
parentShipmentId - String
|
Return shipments recurrences of this parent shipment only |
plannedForToday - Boolean
|
|
receiverId - String
|
|
search - String
|
|
skip - Int
|
Default = 0 |
sort - ShipmentSort
|
|
status - Status
|
|
statuses - [Status!]
|
|
take - Int
|
Default = 25 |
timezone - String
|
Example
Query
query Shipments(
$excludePastShipments: Boolean,
$excludeRecurrentShipments: Boolean,
$excludeRotationShipments: Boolean,
$excludeSplitShipments: Boolean,
$filter: JSON,
$ids: [ObjectId!],
$orderBy: [OrderByItem!],
$parentShipmentId: String,
$plannedForToday: Boolean,
$receiverId: String,
$search: String,
$skip: Int,
$sort: ShipmentSort,
$status: Status,
$statuses: [Status!],
$take: Int,
$timezone: String
) {
shipments(
excludePastShipments: $excludePastShipments,
excludeRecurrentShipments: $excludeRecurrentShipments,
excludeRotationShipments: $excludeRotationShipments,
excludeSplitShipments: $excludeSplitShipments,
filter: $filter,
ids: $ids,
orderBy: $orderBy,
parentShipmentId: $parentShipmentId,
plannedForToday: $plannedForToday,
receiverId: $receiverId,
search: $search,
skip: $skip,
sort: $sort,
status: $status,
statuses: $statuses,
take: $take,
timezone: $timezone
) {
count
data {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
}
}
Variables
{
"excludePastShipments": false,
"excludeRecurrentShipments": true,
"excludeRotationShipments": true,
"excludeSplitShipments": true,
"filter": {},
"ids": [ObjectId],
"orderBy": [OrderByItem],
"parentShipmentId": "abc123",
"plannedForToday": true,
"receiverId": "xyz789",
"search": "abc123",
"skip": 0,
"sort": ShipmentSort,
"status": "ACTIVE",
"statuses": ["ACTIVE"],
"take": 25,
"timezone": "xyz789"
}
Response
{
"data": {
"shipments": {"count": 123, "data": [Shipment]}
}
}
shipperById
Example
Query
query ShipperById($id: String!) {
shipperById(id: $id) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"shipperById": {
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 987.65,
"code": "abc123",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": [
"xyz789"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
shippers
Response
Returns a ShipperPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Shippers(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
shippers(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{"data": {"shippers": {"count": 123, "data": [Shipper]}}}
storageFacilityAverageDailySales
Response
Returns [AverageSales!]!
Example
Query
query StorageFacilityAverageDailySales(
$receiverId: ObjectId!,
$storageFacilityId: String!
) {
storageFacilityAverageDailySales(
receiverId: $receiverId,
storageFacilityId: $storageFacilityId
) {
averageSalesAmount
dayOfWeek
}
}
Variables
{
"receiverId": ObjectId,
"storageFacilityId": "abc123"
}
Response
{
"data": {
"storageFacilityAverageDailySales": [
{"averageSalesAmount": 123.45, "dayOfWeek": 987.65}
]
}
}
storageFacilityReadingById
Response
Returns a StorageFacilityReading!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query StorageFacilityReadingById($id: String!) {
storageFacilityReadingById(id: $id) {
_id
date
level
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverId
storageFacilityId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"storageFacilityReadingById": {
"_id": "xyz789",
"date": "2007-12-03T10:15:30Z",
"level": 987.65,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"storageFacilityId": "xyz789"
}
}
}
storageFacilityReadings
Response
Returns a StorageFacilityReadingPaginatedResult!
Example
Query
query StorageFacilityReadings(
$filter: JSON,
$orderBy: [OrderByItem!],
$receiverId: ObjectId,
$search: String,
$skip: Int,
$storageFacilityId: String,
$take: Int
) {
storageFacilityReadings(
filter: $filter,
orderBy: $orderBy,
receiverId: $receiverId,
search: $search,
skip: $skip,
storageFacilityId: $storageFacilityId,
take: $take
) {
count
data {
_id
date
level
receiver {
...BusinessEntityFragment
}
receiverId
storageFacilityId
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"receiverId": ObjectId,
"search": "xyz789",
"skip": 0,
"storageFacilityId": "abc123",
"take": 300
}
Response
{
"data": {
"storageFacilityReadings": {
"count": 123,
"data": [StorageFacilityReading]
}
}
}
storageFacilitySales
Response
Arguments
| Name | Description |
|---|---|
dateRanges - [DateRangeInput!]!
|
|
storageFacilityId - String!
|
Example
Query
query StorageFacilitySales(
$dateRanges: [DateRangeInput!]!,
$storageFacilityId: String!
) {
storageFacilitySales(
dateRanges: $dateRanges,
storageFacilityId: $storageFacilityId
) {
endDate
salesAmount
startDate
}
}
Variables
{
"dateRanges": [DateRangeInput],
"storageFacilityId": "xyz789"
}
Response
{
"data": {
"storageFacilitySales": [
{
"endDate": "2007-12-03T10:15:30Z",
"salesAmount": 123.45,
"startDate": "2007-12-03T10:15:30Z"
}
]
}
}
subscriptionInfo
Response
Returns a SubscriptionInfo
Example
Query
query SubscriptionInfo {
subscriptionInfo {
activatedAt
createdAt
entitlements {
featureId
value
}
id
lastUpdated
mrr
numberOfAdminSeats
numberOfDriverSeats
status
trialEnd
trialStart
}
}
Response
{
"data": {
"subscriptionInfo": {
"activatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"entitlements": [SubscriptionEntitlementInfo],
"id": "xyz789",
"lastUpdated": "2007-12-03T10:15:30Z",
"mrr": 987.65,
"numberOfAdminSeats": 987.65,
"numberOfDriverSeats": 987.65,
"status": "ACTIVE",
"trialEnd": "2007-12-03T10:15:30Z",
"trialStart": "2007-12-03T10:15:30Z"
}
}
}
supplierContractById
Response
Returns a SupplierContract!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query SupplierContractById($id: String!) {
supplierContractById(id: $id) {
_id
allocation {
dailyQuantity
monthlyQuantity
totalQuantity
weeklyQuantity
}
conditions {
operator
target
value
}
contractNumber
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
endDate
goodProfile {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
goodProfileId
pinCode
shipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipperId
startDate
supplier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
supplierId
unitPrice
usedAllocation {
dailyQuantity
monthlyQuantity
totalQuantity
weeklyQuantity
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"supplierContractById": {
"_id": "abc123",
"allocation": SupplierContractAllocation,
"conditions": [SupplierContractCondition],
"contractNumber": "abc123",
"customer": BusinessEntity,
"customerId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"goodProfile": GoodProfile,
"goodProfileId": ObjectId,
"pinCode": "abc123",
"shipper": BusinessEntity,
"shipperId": ObjectId,
"startDate": "2007-12-03T10:15:30Z",
"supplier": BusinessEntity,
"supplierId": ObjectId,
"unitPrice": 987.65,
"usedAllocation": SupplierContractAllocation
}
}
}
supplierContracts
Response
Returns a SupplierContractPaginatedResult!
Arguments
| Name | Description |
|---|---|
customerId - ObjectId
|
The id of the customer that the contract is with |
filter - JSON
|
Filters to apply to the shipments |
goodProfileId - ObjectId
|
The id of the good profile that the contract is for |
orderBy - [OrderByItem!]
|
|
search - String
|
|
shipperId - ObjectId
|
The id of the shipper that the contract is with |
skip - Int
|
Default = 0 |
supplierId - ObjectId
|
The id of the supplier that the contract is with |
take - Int
|
Default = 300 |
Example
Query
query SupplierContracts(
$customerId: ObjectId,
$filter: JSON,
$goodProfileId: ObjectId,
$orderBy: [OrderByItem!],
$search: String,
$shipperId: ObjectId,
$skip: Int,
$supplierId: ObjectId,
$take: Int
) {
supplierContracts(
customerId: $customerId,
filter: $filter,
goodProfileId: $goodProfileId,
orderBy: $orderBy,
search: $search,
shipperId: $shipperId,
skip: $skip,
supplierId: $supplierId,
take: $take
) {
count
data {
_id
allocation {
...SupplierContractAllocationFragment
}
conditions {
...SupplierContractConditionFragment
}
contractNumber
customer {
...BusinessEntityFragment
}
customerId
endDate
goodProfile {
...GoodProfileFragment
}
goodProfileId
pinCode
shipper {
...BusinessEntityFragment
}
shipperId
startDate
supplier {
...BusinessEntityFragment
}
supplierId
unitPrice
usedAllocation {
...SupplierContractAllocationFragment
}
}
}
}
Variables
{
"customerId": ObjectId,
"filter": {},
"goodProfileId": ObjectId,
"orderBy": [OrderByItem],
"search": "xyz789",
"shipperId": ObjectId,
"skip": 0,
"supplierId": ObjectId,
"take": 300
}
Response
{
"data": {
"supplierContracts": {
"count": 123,
"data": [SupplierContract]
}
}
}
trackShipment
Response
Returns a ShipmentTrackingInfos!
Arguments
| Name | Description |
|---|---|
token - String!
|
Example
Query
query TrackShipment($token: String!) {
trackShipment(token: $token) {
lastKnownTrailerLocation {
altitude
heading
latitude
longitude
speed
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
trip {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{"token": "abc123"}
Response
{
"data": {
"trackShipment": {
"lastKnownTrailerLocation": Coordinates,
"shipment": Shipment,
"trip": Trip
}
}
}
trackShipmentById
Response
Returns a ShipmentTrackingInfos!
Arguments
| Name | Description |
|---|---|
shipmentId - ObjectId!
|
Example
Query
query TrackShipmentById($shipmentId: ObjectId!) {
trackShipmentById(shipmentId: $shipmentId) {
lastKnownTrailerLocation {
altitude
heading
latitude
longitude
speed
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
trip {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{"shipmentId": ObjectId}
Response
{
"data": {
"trackShipmentById": {
"lastKnownTrailerLocation": Coordinates,
"shipment": Shipment,
"trip": Trip
}
}
}
tractorByEldId
Example
Query
query TractorByEldId($eldId: String!) {
tractorByEldId(eldId: $eldId) {
_id
currentDriverEldId
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
eldId
groupIds
lastKnownEldLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownEldLocationDate
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
Variables
{"eldId": "xyz789"}
Response
{
"data": {
"tractorByEldId": {
"_id": "xyz789",
"currentDriverEldId": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "xyz789",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "xyz789",
"make": "xyz789",
"mileage": 987.65,
"model": "xyz789",
"plateNumber": "xyz789",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"tareWeight": 987.65,
"year": 123.45
}
}
}
tractorById
Example
Query
query TractorById($id: String!) {
tractorById(id: $id) {
_id
currentDriverEldId
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
eldId
groupIds
lastKnownEldLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownEldLocationDate
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"tractorById": {
"_id": "abc123",
"currentDriverEldId": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "abc123",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "abc123",
"make": "xyz789",
"mileage": 123.45,
"model": "abc123",
"plateNumber": "abc123",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"tareWeight": 987.65,
"year": 123.45
}
}
}
tractorByLicenseNumber
Example
Query
query TractorByLicenseNumber($licenseNumber: String!) {
tractorByLicenseNumber(licenseNumber: $licenseNumber) {
_id
currentDriverEldId
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
eldId
groupIds
lastKnownEldLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownEldLocationDate
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
Variables
{"licenseNumber": "abc123"}
Response
{
"data": {
"tractorByLicenseNumber": {
"_id": "xyz789",
"currentDriverEldId": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "abc123",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "xyz789",
"make": "xyz789",
"mileage": 123.45,
"model": "xyz789",
"plateNumber": "xyz789",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"tareWeight": 123.45,
"year": 987.65
}
}
}
tractorByPlateNumber
Example
Query
query TractorByPlateNumber($plateNumber: String!) {
tractorByPlateNumber(plateNumber: $plateNumber) {
_id
currentDriverEldId
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
eldId
groupIds
lastKnownEldLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownEldLocationDate
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
Variables
{"plateNumber": "xyz789"}
Response
{
"data": {
"tractorByPlateNumber": {
"_id": "xyz789",
"currentDriverEldId": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "abc123",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "abc123",
"make": "abc123",
"mileage": 123.45,
"model": "xyz789",
"plateNumber": "xyz789",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"tareWeight": 123.45,
"year": 123.45
}
}
}
tractorBySerialNumber
Example
Query
query TractorBySerialNumber($serialNumber: String!) {
tractorBySerialNumber(serialNumber: $serialNumber) {
_id
currentDriverEldId
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
eldId
groupIds
lastKnownEldLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownEldLocationDate
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
Variables
{"serialNumber": "xyz789"}
Response
{
"data": {
"tractorBySerialNumber": {
"_id": "abc123",
"currentDriverEldId": "abc123",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "xyz789",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "xyz789",
"make": "xyz789",
"mileage": 123.45,
"model": "abc123",
"plateNumber": "xyz789",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"tareWeight": 987.65,
"year": 987.65
}
}
}
tractors
Response
Returns a TractorPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Tractors(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
tractors(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{"data": {"tractors": {"count": 123, "data": [Tractor]}}}
trailerById
Example
Query
query TrailerById($id: String!) {
trailerById(id: $id) {
_id
compartments {
capacity
identifier
unit
}
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
groupIds
height
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"trailerById": {
"_id": "xyz789",
"compartments": [TrailerCompartment],
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"groupIds": [ObjectId],
"height": 987.65,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"length": 123.45,
"licenseNumber": "abc123",
"maxTemperature": 987.65,
"maxWeight": 123.45,
"mileage": 123.45,
"minTemperature": 123.45,
"numberOfAxles": 123.45,
"serial": "xyz789",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"type": "AUTO_CARRIER",
"vin": "abc123",
"width": 123.45
}
}
}
trailerEventById
Response
Returns a TrailerEvent!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query TrailerEventById($id: String!) {
trailerEventById(id: $id) {
_id
date
trailerId
type
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"trailerEventById": {
"_id": "abc123",
"date": "2007-12-03T10:15:30Z",
"trailerId": ObjectId,
"type": "TRAILER_WASH"
}
}
}
trailerEvents
Response
Returns a TrailerEventPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query TrailerEvents(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
trailerEvents(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
date
trailerId
type
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{
"data": {
"trailerEvents": {
"count": 987,
"data": [TrailerEvent]
}
}
}
trailers
Response
Returns a TrailerPaginatedResult!
Arguments
| Name | Description |
|---|---|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
search - String
|
|
skip - Int
|
Default = 0 |
take - Int
|
Default = 300 |
Example
Query
query Trailers(
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
trailers(
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
}
Variables
{
"filter": {},
"orderBy": [OrderByItem],
"search": "abc123",
"skip": 0,
"take": 300
}
Response
{"data": {"trailers": {"count": 123, "data": [Trailer]}}}
transactionById
Response
Returns a Transaction!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query TransactionById($id: String!) {
transactionById(id: $id) {
_id
customFields {
key
value
}
document {
_id
name
url
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"transactionById": {
"_id": "xyz789",
"customFields": [CustomField],
"document": TransactionDocument,
"label": "xyz789",
"number": "xyz789",
"rate": 987.65,
"reimburseToDriver": false,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": true,
"type": "EXPENSE",
"unit": 123.45,
"unitType": "abc123"
}
}
}
transactions
Response
Returns a TransactionPaginatedResult!
Example
Query
query Transactions(
$customer: String,
$filter: JSON,
$orderBy: [OrderByItem!],
$search: String,
$skip: Int,
$take: Int
) {
transactions(
customer: $customer,
filter: $filter,
orderBy: $orderBy,
search: $search,
skip: $skip,
take: $take
) {
count
data {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
}
}
Variables
{
"customer": "abc123",
"filter": {},
"orderBy": [OrderByItem],
"search": "xyz789",
"skip": 0,
"take": 300
}
Response
{
"data": {
"transactions": {"count": 987, "data": [Transaction]}
}
}
tripById
Example
Query
query TripById($id: String!) {
tripById(id: $id) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"tripById": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 123.45,
"distanceToEnd": 987.65,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 987.65,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["abc123"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
}
}
tripPositions
Response
Returns [TripDriverPosition!]!
Arguments
| Name | Description |
|---|---|
tripId - String!
|
Example
Query
query TripPositions($tripId: String!) {
tripPositions(tripId: $tripId) {
activity {
confidence
type
}
battery {
is_charging
level
}
coords {
altitude
heading
latitude
longitude
speed
}
event
extras {
tripId
}
is_moving
odometer
timestamp
trip
uuid
}
}
Variables
{"tripId": "abc123"}
Response
{
"data": {
"tripPositions": [
{
"activity": Activity,
"battery": Battery,
"coords": Coordinates,
"event": "abc123",
"extras": Extras,
"is_moving": false,
"odometer": 987.65,
"timestamp": "abc123",
"trip": "abc123",
"uuid": "abc123"
}
]
}
}
trips
Response
Returns a TripPaginatedResult!
Arguments
| Name | Description |
|---|---|
driver - String
|
|
excludeCarrierAssigned - Boolean
|
|
excludeDriverAssigned - Boolean
|
|
filter - JSON
|
Filters to apply to the shipments |
orderBy - [OrderByItem!]
|
|
plannedForToday - Boolean
|
|
search - String
|
|
skip - Int
|
Default = 0 |
sort - TripSort
|
|
status - Status
|
|
take - Int
|
Default = 300 |
timezone - String
|
Example
Query
query Trips(
$driver: String,
$excludeCarrierAssigned: Boolean,
$excludeDriverAssigned: Boolean,
$filter: JSON,
$orderBy: [OrderByItem!],
$plannedForToday: Boolean,
$search: String,
$skip: Int,
$sort: TripSort,
$status: Status,
$take: Int,
$timezone: String
) {
trips(
driver: $driver,
excludeCarrierAssigned: $excludeCarrierAssigned,
excludeDriverAssigned: $excludeDriverAssigned,
filter: $filter,
orderBy: $orderBy,
plannedForToday: $plannedForToday,
search: $search,
skip: $skip,
sort: $sort,
status: $status,
take: $take,
timezone: $timezone
) {
count
data {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{
"driver": "abc123",
"excludeCarrierAssigned": true,
"excludeDriverAssigned": false,
"filter": {},
"orderBy": [OrderByItem],
"plannedForToday": true,
"search": "abc123",
"skip": 0,
"sort": TripSort,
"status": "ACTIVE",
"take": 300,
"timezone": "abc123"
}
Response
{"data": {"trips": {"count": 987, "data": [Trip]}}}
Mutations
activateTrial
Response
Returns a SubscriptionInfo!
Example
Query
mutation ActivateTrial {
activateTrial {
activatedAt
createdAt
entitlements {
featureId
value
}
id
lastUpdated
mrr
numberOfAdminSeats
numberOfDriverSeats
status
trialEnd
trialStart
}
}
Response
{
"data": {
"activateTrial": {
"activatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"entitlements": [SubscriptionEntitlementInfo],
"id": "xyz789",
"lastUpdated": "2007-12-03T10:15:30Z",
"mrr": 123.45,
"numberOfAdminSeats": 123.45,
"numberOfDriverSeats": 123.45,
"status": "ACTIVE",
"trialEnd": "2007-12-03T10:15:30Z",
"trialStart": "2007-12-03T10:15:30Z"
}
}
}
addAssetLinking
Response
Returns an AssetLinking!
Arguments
| Name | Description |
|---|---|
newAssetLinkingData - AssetLinkingInput!
|
Example
Query
mutation AddAssetLinking($newAssetLinkingData: AssetLinkingInput!) {
addAssetLinking(newAssetLinkingData: $newAssetLinkingData) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
endDate
isHardLinked
startDate
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
}
Variables
{"newAssetLinkingData": AssetLinkingInput}
Response
{
"data": {
"addAssetLinking": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"driver": Driver,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": false,
"startDate": "2007-12-03T10:15:30Z",
"tractor": Tractor,
"trailer": Trailer
}
}
}
addBillingRule
Response
Returns a BillingRule!
Arguments
| Name | Description |
|---|---|
newBillingRuleData - NewBillingRuleInput!
|
Example
Query
mutation AddBillingRule($newBillingRuleData: NewBillingRuleInput!) {
addBillingRule(newBillingRuleData: $newBillingRuleData) {
_id
amount
condition {
operator
parameters {
...BillingRuleConditionParameterFragment
}
target
value
}
conditions {
operator
parameters {
...BillingRuleConditionParameterFragment
}
target
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
label
method
priority
rates {
amount
label
method
parameters {
...BillingRateParameterFragment
}
referenceNumber
}
referenceNumber
type
}
}
Variables
{"newBillingRuleData": NewBillingRuleInput}
Response
{
"data": {
"addBillingRule": {
"_id": "abc123",
"amount": 987.65,
"condition": BillingRuleCondition,
"conditions": [BillingRuleCondition],
"customer": BusinessEntity,
"label": "abc123",
"method": "FLAT_FEE",
"priority": 987.65,
"rates": [BillingRate],
"referenceNumber": "xyz789",
"type": "ACCESSORIAL"
}
}
}
addBroker
Response
Returns a Broker!
Arguments
| Name | Description |
|---|---|
newBrokerData - NewBusinessEntityInput!
|
Example
Query
mutation AddBroker($newBrokerData: NewBusinessEntityInput!) {
addBroker(newBrokerData: $newBrokerData) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"newBrokerData": NewBusinessEntityInput}
Response
{
"data": {
"addBroker": {
"_id": "xyz789",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 987.65,
"code": "abc123",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "xyz789",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": [
"xyz789"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
addBusinessEntity
Response
Returns a BusinessEntity!
Arguments
| Name | Description |
|---|---|
newBusinessEntityData - NewBusinessEntityInputWithType!
|
Example
Query
mutation AddBusinessEntity($newBusinessEntityData: NewBusinessEntityInputWithType!) {
addBusinessEntity(newBusinessEntityData: $newBusinessEntityData) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"newBusinessEntityData": NewBusinessEntityInputWithType}
Response
{
"data": {
"addBusinessEntity": {
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 987.65,
"code": "abc123",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "xyz789",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": [
"xyz789"
],
"standardCarrierAlphaCode": "xyz789",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
addCharge
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
chargeData - ShipmentChargeInput!
|
|
shipmentId - String!
|
Example
Query
mutation AddCharge(
$chargeData: ShipmentChargeInput!,
$shipmentId: String!
) {
addCharge(
chargeData: $chargeData,
shipmentId: $shipmentId
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"chargeData": ShipmentChargeInput,
"shipmentId": "abc123"
}
Response
{
"data": {
"addCharge": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
addChassis
Response
Returns a Chassis!
Arguments
| Name | Description |
|---|---|
newChassisData - NewTractorInput!
|
Example
Query
mutation AddChassis($newChassisData: NewTractorInput!) {
addChassis(newChassisData: $newChassisData) {
_id
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
serialNumber
status
}
}
Variables
{"newChassisData": NewTractorInput}
Response
{
"data": {
"addChassis": {
"_id": "abc123",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"serialNumber": "xyz789",
"status": "ACTIVE"
}
}
}
addCustomFieldDefinition
Response
Returns a CustomFieldDefinition!
Arguments
| Name | Description |
|---|---|
newCustomFieldDefinitionData - NewCustomFieldDefinitionInput!
|
Example
Query
mutation AddCustomFieldDefinition($newCustomFieldDefinitionData: NewCustomFieldDefinitionInput!) {
addCustomFieldDefinition(newCustomFieldDefinitionData: $newCustomFieldDefinitionData) {
_id
context
description
isRequirement
key
label
requirementOptions {
isPartial
isRange
isRequired
}
selectOptions {
key
label
}
selectOptionsEndpoint
selectOptionsEntity
type
}
}
Variables
{
"newCustomFieldDefinitionData": NewCustomFieldDefinitionInput
}
Response
{
"data": {
"addCustomFieldDefinition": {
"_id": "xyz789",
"context": ["CARRIER"],
"description": "xyz789",
"isRequirement": false,
"key": "xyz789",
"label": "abc123",
"requirementOptions": CustomFieldRequirementOptions,
"selectOptions": [CustomFieldSelectOption],
"selectOptionsEndpoint": "xyz789",
"selectOptionsEntity": "CARRIER",
"type": "BOOLEAN"
}
}
}
addCustomer
Response
Returns a Customer!
Arguments
| Name | Description |
|---|---|
newCustomerData - NewBusinessEntityInput!
|
Example
Query
mutation AddCustomer($newCustomerData: NewBusinessEntityInput!) {
addCustomer(newCustomerData: $newCustomerData) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"newCustomerData": NewBusinessEntityInput}
Response
{
"data": {
"addCustomer": {
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 123.45,
"code": "xyz789",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "xyz789",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"xyz789"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
addCustomerOrder
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
newOrderData - NewOrderInput!
|
Example
Query
mutation AddCustomerOrder($newOrderData: NewOrderInput!) {
addCustomerOrder(newOrderData: $newOrderData) {
_id
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
locations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
orderNumber
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentId
status
}
}
Variables
{"newOrderData": NewOrderInput}
Response
{
"data": {
"addCustomerOrder": {
"_id": "xyz789",
"customer": BusinessEntity,
"customerId": ObjectId,
"locations": [ShipmentLocation],
"orderNumber": "abc123",
"shipment": Shipment,
"shipmentId": ObjectId,
"status": "ACTIVE"
}
}
}
addDeductionRule
Response
Returns a DeductionRule!
Arguments
| Name | Description |
|---|---|
newDeductionRuleData - NewDeductionRuleInput!
|
Example
Query
mutation AddDeductionRule($newDeductionRuleData: NewDeductionRuleInput!) {
addDeductionRule(newDeductionRuleData: $newDeductionRuleData) {
_id
amount
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
label
method
period {
end
repeatEvery
start
unit
}
type
}
}
Variables
{"newDeductionRuleData": NewDeductionRuleInput}
Response
{
"data": {
"addDeductionRule": {
"_id": "abc123",
"amount": 987.65,
"driver": Driver,
"label": "xyz789",
"method": "FLAT_FEE",
"period": DeductionPeriod,
"type": "BONUS"
}
}
}
addDriver
Response
Returns a Driver!
Arguments
| Name | Description |
|---|---|
newDriverData - NewDriverInput!
|
Example
Query
mutation AddDriver($newDriverData: NewDriverInput!) {
addDriver(newDriverData: $newDriverData) {
_id
customFields {
key
value
}
dateOfBirth
dateOfPhysicalExamination
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
domicileEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
eldId
firstname
groupIds
hos {
currentDrivingTime
currentOnDutyTime
currentStatus
statusTime
totalDrivingTime
totalOnDutyTime
}
isOwnerOperator
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
lastname
license {
address {
...TextualAddressFragment
}
classification
endorsements
expiryDate
issuedDate
issuedState
licenseNumber
restriction
}
medical {
expiryDate
issuedDate
number
restriction
}
middlename
phoneNumber
status
tags
userId
}
}
Variables
{"newDriverData": NewDriverInput}
Response
{
"data": {
"addDriver": {
"_id": "xyz789",
"customFields": [CustomField],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocument],
"domicile": Address,
"domicileEntity": BusinessEntity,
"domicileId": ObjectId,
"eldId": "abc123",
"firstname": "abc123",
"groupIds": [ObjectId],
"hos": DriverHos,
"isOwnerOperator": false,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"lastname": "xyz789",
"license": DriverLicense,
"medical": DriverMedical,
"middlename": "xyz789",
"phoneNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"userId": "xyz789"
}
}
}
addDriverShift
Response
Returns a DriverShift!
Arguments
| Name | Description |
|---|---|
newDriverShiftData - NewDriverShiftInput!
|
Example
Query
mutation AddDriverShift($newDriverShiftData: NewDriverShiftInput!) {
addDriverShift(newDriverShiftData: $newDriverShiftData) {
_id
days
domicile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
driverIds
endTime {
hour
minute
}
isAdhoc
label
startTime {
hour
minute
}
}
}
Variables
{"newDriverShiftData": NewDriverShiftInput}
Response
{
"data": {
"addDriverShift": {
"_id": "abc123",
"days": [987],
"domicile": BusinessEntity,
"domicileId": ObjectId,
"driverIds": [ObjectId],
"endTime": Time,
"isAdhoc": false,
"label": "xyz789",
"startTime": Time
}
}
}
addDriverShiftAssignment
Response
Returns a DriverShiftAssignment!
Arguments
| Name | Description |
|---|---|
newDriverShiftAssignmentData - NewDriverShiftAssignmentInput!
|
Example
Query
mutation AddDriverShiftAssignment($newDriverShiftAssignmentData: NewDriverShiftAssignmentInput!) {
addDriverShiftAssignment(newDriverShiftAssignmentData: $newDriverShiftAssignmentData) {
_id
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverId
driverShift {
_id
days
domicile {
...BusinessEntityFragment
}
domicileId
driverIds
endTime {
...TimeFragment
}
isAdhoc
label
startTime {
...TimeFragment
}
}
driverShiftId
endDate
startDate
}
}
Variables
{
"newDriverShiftAssignmentData": NewDriverShiftAssignmentInput
}
Response
{
"data": {
"addDriverShiftAssignment": {
"_id": "xyz789",
"driver": Driver,
"driverId": ObjectId,
"driverShift": DriverShift,
"driverShiftId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"startDate": "2007-12-03T10:15:30Z"
}
}
}
addGoodProfile
Response
Returns a GoodProfile!
Arguments
| Name | Description |
|---|---|
newGoodProfileData - NewGoodProfileInput!
|
Example
Query
mutation AddGoodProfile($newGoodProfileData: NewGoodProfileInput!) {
addGoodProfile(newGoodProfileData: $newGoodProfileData) {
_id
code
color
customFields {
key
value
}
documents {
_id
name
url
}
equivalences {
conditions {
...GoodProfileEquivalenceConditionFragment
}
equivalentGoodId
}
externalId
goodProfileClass {
_id
description
label
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
type
value
}
shipperIds
supplierIds
tags
unit
weight
}
}
Variables
{"newGoodProfileData": NewGoodProfileInput}
Response
{
"data": {
"addGoodProfile": {
"_id": "xyz789",
"code": "abc123",
"color": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"equivalences": [GoodProfileEquivalence],
"externalId": "xyz789",
"goodProfileClass": GoodProfileClass,
"goodProfileClassId": ObjectId,
"groupIds": [ObjectId],
"label": "abc123",
"liquidGravity": 123.45,
"restrictions": [GoodProfileRestriction],
"shipperIds": ["abc123"],
"supplierIds": ["abc123"],
"tags": ["abc123"],
"unit": "GALLONS",
"weight": 987.65
}
}
}
addGoodProfileClass
Response
Returns a GoodProfileClass!
Arguments
| Name | Description |
|---|---|
newGoodProfileClassData - NewGoodProfileClassInput!
|
Example
Query
mutation AddGoodProfileClass($newGoodProfileClassData: NewGoodProfileClassInput!) {
addGoodProfileClass(newGoodProfileClassData: $newGoodProfileClassData) {
_id
description
label
}
}
Variables
{"newGoodProfileClassData": NewGoodProfileClassInput}
Response
{
"data": {
"addGoodProfileClass": {
"_id": ObjectId,
"description": "xyz789",
"label": "abc123"
}
}
}
addGroup
Response
Returns a Group!
Arguments
| Name | Description |
|---|---|
newGroupData - NewGroupInput!
|
Example
Query
mutation AddGroup($newGroupData: NewGroupInput!) {
addGroup(newGroupData: $newGroupData) {
_id
description
memberIds
name
}
}
Variables
{"newGroupData": NewGroupInput}
Response
{
"data": {
"addGroup": {
"_id": "xyz789",
"description": "xyz789",
"memberIds": ["abc123"],
"name": "abc123"
}
}
}
addMaintenanceTask
Response
Returns a MaintenanceTask!
Arguments
| Name | Description |
|---|---|
newMaintenanceTaskData - NewMaintenanceTaskInput!
|
Example
Query
mutation AddMaintenanceTask($newMaintenanceTaskData: NewMaintenanceTaskInput!) {
addMaintenanceTask(newMaintenanceTaskData: $newMaintenanceTaskData) {
_id
assetId
assetType
endDate
label
recurrence {
frequency
interval
}
required
startDate
startMileage
status
}
}
Variables
{"newMaintenanceTaskData": NewMaintenanceTaskInput}
Response
{
"data": {
"addMaintenanceTask": {
"_id": "abc123",
"assetId": ObjectId,
"assetType": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"label": "abc123",
"recurrence": MaintenanceTaskRecurrence,
"required": true,
"startDate": "2007-12-03T10:15:30Z",
"startMileage": 123.45,
"status": "CANCELLED"
}
}
}
addNotesShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
newNotesData - MultiShipmentNotesInput!
|
Example
Query
mutation AddNotesShipment($newNotesData: MultiShipmentNotesInput!) {
addNotesShipment(newNotesData: $newNotesData) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"newNotesData": MultiShipmentNotesInput}
Response
{
"data": {
"addNotesShipment": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["abc123"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
addOrder
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
newOrderData - NewOrderInput!
|
Example
Query
mutation AddOrder($newOrderData: NewOrderInput!) {
addOrder(newOrderData: $newOrderData) {
_id
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
locations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
orderNumber
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentId
status
}
}
Variables
{"newOrderData": NewOrderInput}
Response
{
"data": {
"addOrder": {
"_id": "xyz789",
"customer": BusinessEntity,
"customerId": ObjectId,
"locations": [ShipmentLocation],
"orderNumber": "xyz789",
"shipment": Shipment,
"shipmentId": ObjectId,
"status": "ACTIVE"
}
}
}
addOrgDoc
Response
Returns an OrganizationDocument!
Arguments
| Name | Description |
|---|---|
newOrganizationDocumentData - NewOrganizationDocumentInput!
|
Example
Query
mutation AddOrgDoc($newOrganizationDocumentData: NewOrganizationDocumentInput!) {
addOrgDoc(newOrganizationDocumentData: $newOrganizationDocumentData) {
_id
name
url
}
}
Variables
{
"newOrganizationDocumentData": NewOrganizationDocumentInput
}
Response
{
"data": {
"addOrgDoc": {
"_id": "abc123",
"name": "abc123",
"url": "abc123"
}
}
}
addOrgUser
Response
Returns an OrgUser!
Arguments
| Name | Description |
|---|---|
newOrgUserData - NewOrgUserInput!
|
Example
Query
mutation AddOrgUser($newOrgUserData: NewOrgUserInput!) {
addOrgUser(newOrgUserData: $newOrgUserData) {
_id
attributes {
customFields
driverId
freshchatRestoreId
phoneNumber
phoneNumberVerified
promoCode
tags
trialDays
}
email
enabled
firstName
id
lastName
roles {
id
name
}
username
}
}
Variables
{"newOrgUserData": NewOrgUserInput}
Response
{
"data": {
"addOrgUser": {
"_id": "xyz789",
"attributes": UserAttributes,
"email": "abc123",
"enabled": true,
"firstName": "xyz789",
"id": "abc123",
"lastName": "xyz789",
"roles": [KeycloakUserRole],
"username": "xyz789"
}
}
}
addPaymentRule
Response
Returns a PaymentRule!
Arguments
| Name | Description |
|---|---|
newPaymentRuleData - NewPaymentRuleInput!
|
Example
Query
mutation AddPaymentRule($newPaymentRuleData: NewPaymentRuleInput!) {
addPaymentRule(newPaymentRuleData: $newPaymentRuleData) {
_id
amount
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
method
period {
end
repeatEvery
start
unit
}
}
}
Variables
{"newPaymentRuleData": NewPaymentRuleInput}
Response
{
"data": {
"addPaymentRule": {
"_id": "abc123",
"amount": 987.65,
"driver": Driver,
"method": "PER_HOUR",
"period": PaymentPeriod
}
}
}
addQualification
Response
Returns a Qualification!
Arguments
| Name | Description |
|---|---|
newQualificationData - NewQualificationInput!
|
Example
Query
mutation AddQualification($newQualificationData: NewQualificationInput!) {
addQualification(newQualificationData: $newQualificationData) {
_id
assetId
assetType
documents {
_id
name
url
}
endDate
label
number
required
startDate
}
}
Variables
{"newQualificationData": NewQualificationInput}
Response
{
"data": {
"addQualification": {
"_id": "abc123",
"assetId": ObjectId,
"assetType": "abc123",
"documents": [Document],
"endDate": "2007-12-03T10:15:30Z",
"label": "abc123",
"number": "xyz789",
"required": false,
"startDate": "2007-12-03T10:15:30Z"
}
}
}
addReasonCode
Response
Returns a ReasonCode!
Arguments
| Name | Description |
|---|---|
newReasonCodeData - NewReasonCodeInput!
|
Example
Query
mutation AddReasonCode($newReasonCodeData: NewReasonCodeInput!) {
addReasonCode(newReasonCodeData: $newReasonCodeData) {
_id
createdAt
createdBy
description
locationId
shipmentId
tripId
type
updatedAt
}
}
Variables
{"newReasonCodeData": NewReasonCodeInput}
Response
{
"data": {
"addReasonCode": {
"_id": ObjectId,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": "abc123",
"description": "abc123",
"locationId": "xyz789",
"shipmentId": ObjectId,
"tripId": ObjectId,
"type": "CUSTOMER",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
addReceiver
Response
Returns a Receiver!
Arguments
| Name | Description |
|---|---|
newReceiverData - NewBusinessEntityInput!
|
Example
Query
mutation AddReceiver($newReceiverData: NewBusinessEntityInput!) {
addReceiver(newReceiverData: $newReceiverData) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"newReceiverData": NewBusinessEntityInput}
Response
{
"data": {
"addReceiver": {
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 987.65,
"code": "abc123",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "xyz789",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "xyz789",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
addReceiverForecast
Response
Returns a ReceiverForecast!
Arguments
| Name | Description |
|---|---|
newReceiverForecastData - NewReceiverForecastInput!
|
Example
Query
mutation AddReceiverForecast($newReceiverForecastData: NewReceiverForecastInput!) {
addReceiverForecast(newReceiverForecastData: $newReceiverForecastData) {
_id
models {
_id
contaminates
isExclusive
label
maxCapacity
minCapacity
slots {
...ForecastingModelSlotFragment
}
storageFacilityId
target
threshold
weight
}
readingsFileConfiguration {
dateColumn
dateFormat
levelColumn
readingDeviationCriticalThreshold
readingDeviationDangerThreshold
readingDeviationWarningThreshold
runoutCriticalThreshold
runoutDangerThreshold
runoutWarningThreshold
staleReadingCriticalThreshold
staleReadingDangerThreshold
staleReadingWarningThreshold
storeColumn
tankIdColumn
timeColumn
timeFormat
}
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverId
trailerProfile {
compartments {
...TrailerProfileCompartmentFragment
}
}
}
}
Variables
{"newReceiverForecastData": NewReceiverForecastInput}
Response
{
"data": {
"addReceiverForecast": {
"_id": "xyz789",
"models": [ForecastingModel],
"readingsFileConfiguration": ReadingsFileConfiguration,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"trailerProfile": TrailerProfile
}
}
}
addRelationship
Response
Returns a Relationship!
Arguments
| Name | Description |
|---|---|
newRelationshipData - NewRelationshipInput!
|
Example
Query
mutation AddRelationship($newRelationshipData: NewRelationshipInput!) {
addRelationship(newRelationshipData: $newRelationshipData) {
_id
commodities {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
commodityIds
customerIds
customers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverIds
receivers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipperIds
shippers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
supplierIds
suppliers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{"newRelationshipData": NewRelationshipInput}
Response
{
"data": {
"addRelationship": {
"_id": "xyz789",
"commodities": [GoodProfile],
"commodityIds": [ObjectId],
"customerIds": [ObjectId],
"customers": [BusinessEntity],
"receiverIds": [ObjectId],
"receivers": [BusinessEntity],
"shipperIds": [ObjectId],
"shippers": [BusinessEntity],
"supplierIds": [ObjectId],
"suppliers": [BusinessEntity]
}
}
}
addShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
newShipmentData - NewShipmentInput!
|
Example
Query
mutation AddShipment($newShipmentData: NewShipmentInput!) {
addShipment(newShipmentData: $newShipmentData) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"newShipmentData": NewShipmentInput}
Response
{
"data": {
"addShipment": {
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
addShipmentDocument
Response
Returns a ShipmentDocument!
Arguments
| Name | Description |
|---|---|
newDocumentData - ShipmentDocumentInput!
|
Example
Query
mutation AddShipmentDocument($newDocumentData: ShipmentDocumentInput!) {
addShipmentDocument(newDocumentData: $newDocumentData) {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
type
updatedAt
url
}
}
Variables
{"newDocumentData": ShipmentDocumentInput}
Response
{
"data": {
"addShipmentDocument": {
"_id": "abc123",
"accessLevel": ["CARRIER"],
"associatedCharge": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": "xyz789",
"isBillable": true,
"lastUpdatedBy": "abc123",
"name": "xyz789",
"receiver": BusinessEntity,
"shipper": BusinessEntity,
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"url": "xyz789"
}
}
}
addShipmentDocuments
Response
Returns [ShipmentDocument!]!
Arguments
| Name | Description |
|---|---|
newDocumentsData - [ShipmentDocumentInfoInput!]!
|
|
shipment - String!
|
Example
Query
mutation AddShipmentDocuments(
$newDocumentsData: [ShipmentDocumentInfoInput!]!,
$shipment: String!
) {
addShipmentDocuments(
newDocumentsData: $newDocumentsData,
shipment: $shipment
) {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
type
updatedAt
url
}
}
Variables
{
"newDocumentsData": [ShipmentDocumentInfoInput],
"shipment": "abc123"
}
Response
{
"data": {
"addShipmentDocuments": [
{
"_id": "abc123",
"accessLevel": ["CARRIER"],
"associatedCharge": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": "abc123",
"isBillable": false,
"lastUpdatedBy": "xyz789",
"name": "abc123",
"receiver": BusinessEntity,
"shipper": BusinessEntity,
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"url": "xyz789"
}
]
}
}
addShipmentEvent
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
shipmentEventData - ShipmentEventInput!
|
Example
Query
mutation AddShipmentEvent($shipmentEventData: ShipmentEventInput!) {
addShipmentEvent(shipmentEventData: $shipmentEventData) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"shipmentEventData": ShipmentEventInput}
Response
{
"data": {
"addShipmentEvent": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["xyz789"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
addShipper
Response
Returns a Shipper!
Arguments
| Name | Description |
|---|---|
newShipperData - NewBusinessEntityInput!
|
Example
Query
mutation AddShipper($newShipperData: NewBusinessEntityInput!) {
addShipper(newShipperData: $newShipperData) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{"newShipperData": NewBusinessEntityInput}
Response
{
"data": {
"addShipper": {
"_id": "xyz789",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 987.65,
"code": "abc123",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "xyz789",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
addStorageFacilityReading
Response
Returns a StorageFacilityReading!
Arguments
| Name | Description |
|---|---|
newStorageFacilityReadingData - NewStorageFacilityReadingInput!
|
Example
Query
mutation AddStorageFacilityReading($newStorageFacilityReadingData: NewStorageFacilityReadingInput!) {
addStorageFacilityReading(newStorageFacilityReadingData: $newStorageFacilityReadingData) {
_id
date
level
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverId
storageFacilityId
}
}
Variables
{
"newStorageFacilityReadingData": NewStorageFacilityReadingInput
}
Response
{
"data": {
"addStorageFacilityReading": {
"_id": "abc123",
"date": "2007-12-03T10:15:30Z",
"level": 987.65,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"storageFacilityId": "xyz789"
}
}
}
addSupplierContract
Response
Returns a SupplierContract!
Arguments
| Name | Description |
|---|---|
newSupplierContractData - NewSupplierContractInput!
|
Example
Query
mutation AddSupplierContract($newSupplierContractData: NewSupplierContractInput!) {
addSupplierContract(newSupplierContractData: $newSupplierContractData) {
_id
allocation {
dailyQuantity
monthlyQuantity
totalQuantity
weeklyQuantity
}
conditions {
operator
target
value
}
contractNumber
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
endDate
goodProfile {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
goodProfileId
pinCode
shipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipperId
startDate
supplier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
supplierId
unitPrice
usedAllocation {
dailyQuantity
monthlyQuantity
totalQuantity
weeklyQuantity
}
}
}
Variables
{"newSupplierContractData": NewSupplierContractInput}
Response
{
"data": {
"addSupplierContract": {
"_id": "abc123",
"allocation": SupplierContractAllocation,
"conditions": [SupplierContractCondition],
"contractNumber": "abc123",
"customer": BusinessEntity,
"customerId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"goodProfile": GoodProfile,
"goodProfileId": ObjectId,
"pinCode": "abc123",
"shipper": BusinessEntity,
"shipperId": ObjectId,
"startDate": "2007-12-03T10:15:30Z",
"supplier": BusinessEntity,
"supplierId": ObjectId,
"unitPrice": 987.65,
"usedAllocation": SupplierContractAllocation
}
}
}
addTractor
Response
Returns a Tractor!
Arguments
| Name | Description |
|---|---|
newTractorData - NewTractorInput!
|
Example
Query
mutation AddTractor($newTractorData: NewTractorInput!) {
addTractor(newTractorData: $newTractorData) {
_id
currentDriverEldId
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
eldId
groupIds
lastKnownEldLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownEldLocationDate
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
Variables
{"newTractorData": NewTractorInput}
Response
{
"data": {
"addTractor": {
"_id": "abc123",
"currentDriverEldId": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "abc123",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "abc123",
"make": "xyz789",
"mileage": 123.45,
"model": "xyz789",
"plateNumber": "xyz789",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"tareWeight": 987.65,
"year": 987.65
}
}
}
addTrailer
Response
Returns a Trailer!
Arguments
| Name | Description |
|---|---|
newTrailerData - NewTrailerInput!
|
Example
Query
mutation AddTrailer($newTrailerData: NewTrailerInput!) {
addTrailer(newTrailerData: $newTrailerData) {
_id
compartments {
capacity
identifier
unit
}
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
groupIds
height
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
Variables
{"newTrailerData": NewTrailerInput}
Response
{
"data": {
"addTrailer": {
"_id": "abc123",
"compartments": [TrailerCompartment],
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"groupIds": [ObjectId],
"height": 987.65,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"length": 123.45,
"licenseNumber": "xyz789",
"maxTemperature": 123.45,
"maxWeight": 987.65,
"mileage": 123.45,
"minTemperature": 987.65,
"numberOfAxles": 123.45,
"serial": "abc123",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"type": "AUTO_CARRIER",
"vin": "xyz789",
"width": 987.65
}
}
}
addTrailerEvent
Response
Returns a TrailerEvent!
Arguments
| Name | Description |
|---|---|
newTrailerEventData - NewTrailerEventInput!
|
Example
Query
mutation AddTrailerEvent($newTrailerEventData: NewTrailerEventInput!) {
addTrailerEvent(newTrailerEventData: $newTrailerEventData) {
_id
date
trailerId
type
}
}
Variables
{"newTrailerEventData": NewTrailerEventInput}
Response
{
"data": {
"addTrailerEvent": {
"_id": "abc123",
"date": "2007-12-03T10:15:30Z",
"trailerId": ObjectId,
"type": "TRAILER_WASH"
}
}
}
addTransaction
Response
Returns a Transaction!
Arguments
| Name | Description |
|---|---|
newTransactionData - TransactionInput!
|
Example
Query
mutation AddTransaction($newTransactionData: TransactionInput!) {
addTransaction(newTransactionData: $newTransactionData) {
_id
customFields {
key
value
}
document {
_id
name
url
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
}
Variables
{"newTransactionData": TransactionInput}
Response
{
"data": {
"addTransaction": {
"_id": "xyz789",
"customFields": [CustomField],
"document": TransactionDocument,
"label": "abc123",
"number": "abc123",
"rate": 987.65,
"reimburseToDriver": true,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": false,
"type": "EXPENSE",
"unit": 123.45,
"unitType": "xyz789"
}
}
}
addTrip
Use generateTrip instead
Response
Returns a Trip!
Arguments
| Name | Description |
|---|---|
ignoreDriverShifts - Boolean
|
Default = false |
newTripData - NewTripInput!
|
Example
Query
mutation AddTrip(
$ignoreDriverShifts: Boolean,
$newTripData: NewTripInput!
) {
addTrip(
ignoreDriverShifts: $ignoreDriverShifts,
newTripData: $newTripData
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{"ignoreDriverShifts": false, "newTripData": NewTripInput}
Response
{
"data": {
"addTrip": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 123.45,
"distanceToEnd": 987.65,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 987.65,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 987.65,
"routeDistance": 123.45,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
}
}
addTripPayment
Response
Returns a Trip
Arguments
| Name | Description |
|---|---|
payment - TransactionInput!
|
|
tripId - String!
|
Example
Query
mutation AddTripPayment(
$payment: TransactionInput!,
$tripId: String!
) {
addTripPayment(
payment: $payment,
tripId: $tripId
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{
"payment": TransactionInput,
"tripId": "abc123"
}
Response
{
"data": {
"addTripPayment": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 987.65,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 123.45,
"payments": [TripPayment],
"polyline": "abc123",
"predictedLoadedDistance": 987.65,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "xyz789",
"violations": [TripViolation]
}
}
}
assignTripAsset
Response
Returns a Trip!
Arguments
| Name | Description |
|---|---|
ignoreDriverShifts - Boolean
|
Default = false |
tripAssetAssignmentData - TripAssetAssignment!
|
Example
Query
mutation AssignTripAsset(
$ignoreDriverShifts: Boolean,
$tripAssetAssignmentData: TripAssetAssignment!
) {
assignTripAsset(
ignoreDriverShifts: $ignoreDriverShifts,
tripAssetAssignmentData: $tripAssetAssignmentData
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{
"ignoreDriverShifts": false,
"tripAssetAssignmentData": TripAssetAssignment
}
Response
{
"data": {
"assignTripAsset": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 123.45,
"distanceToEnd": 987.65,
"distanceToStart": 123.45,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 123.45,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 987.65,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
}
}
assignTripAssets
Response
Returns a Trip
Arguments
| Name | Description |
|---|---|
ignoreDriverShifts - Boolean
|
Default = false |
tripAssetAssignmentData - [TripAssetAssignment!]!
|
Example
Query
mutation AssignTripAssets(
$ignoreDriverShifts: Boolean,
$tripAssetAssignmentData: [TripAssetAssignment!]!
) {
assignTripAssets(
ignoreDriverShifts: $ignoreDriverShifts,
tripAssetAssignmentData: $tripAssetAssignmentData
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{
"ignoreDriverShifts": false,
"tripAssetAssignmentData": [TripAssetAssignment]
}
Response
{
"data": {
"assignTripAssets": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 123.45,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 123.45,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 123.45,
"routeDistance": 123.45,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["abc123"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
}
}
assignTripTrailerCompartments
Response
Returns a Trip!
Arguments
| Name | Description |
|---|---|
trailerCompartmentAssignments - [TrailerCompartmentAssignmentInput!]!
|
|
tripId - String!
|
Example
Query
mutation AssignTripTrailerCompartments(
$trailerCompartmentAssignments: [TrailerCompartmentAssignmentInput!]!,
$tripId: String!
) {
assignTripTrailerCompartments(
trailerCompartmentAssignments: $trailerCompartmentAssignments,
tripId: $tripId
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{
"trailerCompartmentAssignments": [
TrailerCompartmentAssignmentInput
],
"tripId": "xyz789"
}
Response
{
"data": {
"assignTripTrailerCompartments": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 123.45,
"distanceToEnd": 987.65,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "abc123",
"predictedLoadedDistance": 987.65,
"routeDistance": 123.45,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["abc123"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
}
}
batchProcessInvoices
Response
Returns an InvoiceBatchResult
Arguments
| Name | Description |
|---|---|
invoiceIds - [ObjectId!]!
|
|
status - InvoiceStatus!
|
Example
Query
mutation BatchProcessInvoices(
$invoiceIds: [ObjectId!]!,
$status: InvoiceStatus!
) {
batchProcessInvoices(
invoiceIds: $invoiceIds,
status: $status
) {
invoicesUpdated {
_id
charges {
...ShipmentChargeFragment
}
closingNote
customer {
...BusinessEntityFragment
}
groupIds
invoiceNumber
missingRequiredDocuments {
...DocumentRequirementFragment
}
paidAmount
payments {
...InvoicePaymentFragment
}
pdfDocument {
...InvoicePdfFragment
}
shipment {
...ShipmentFragment
}
shipmentIds
shipments {
...ShipmentFragment
}
status
taxRate
}
textError
}
}
Variables
{"invoiceIds": [ObjectId], "status": "CANCELLED"}
Response
{
"data": {
"batchProcessInvoices": {
"invoicesUpdated": [Invoice],
"textError": "xyz789"
}
}
}
bulkAddBusinessEntities
Response
Returns [BusinessEntity!]!
Arguments
| Name | Description |
|---|---|
newBusinessEntityData - [NewBusinessEntityInputWithType!]!
|
Example
Query
mutation BulkAddBusinessEntities($newBusinessEntityData: [NewBusinessEntityInputWithType!]!) {
bulkAddBusinessEntities(newBusinessEntityData: $newBusinessEntityData) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{
"newBusinessEntityData": [
NewBusinessEntityInputWithType
]
}
Response
{
"data": {
"bulkAddBusinessEntities": [
{
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 123.45,
"code": "xyz789",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [
DefaultReferenceNumber
],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "abc123",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": [
"xyz789"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
]
}
}
bulkAddDrivers
Response
Returns [Driver!]!
Arguments
| Name | Description |
|---|---|
newDriverData - [NewDriverInput!]!
|
Example
Query
mutation BulkAddDrivers($newDriverData: [NewDriverInput!]!) {
bulkAddDrivers(newDriverData: $newDriverData) {
_id
customFields {
key
value
}
dateOfBirth
dateOfPhysicalExamination
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
domicileEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
eldId
firstname
groupIds
hos {
currentDrivingTime
currentOnDutyTime
currentStatus
statusTime
totalDrivingTime
totalOnDutyTime
}
isOwnerOperator
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
lastname
license {
address {
...TextualAddressFragment
}
classification
endorsements
expiryDate
issuedDate
issuedState
licenseNumber
restriction
}
medical {
expiryDate
issuedDate
number
restriction
}
middlename
phoneNumber
status
tags
userId
}
}
Variables
{"newDriverData": [NewDriverInput]}
Response
{
"data": {
"bulkAddDrivers": [
{
"_id": "abc123",
"customFields": [CustomField],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocument],
"domicile": Address,
"domicileEntity": BusinessEntity,
"domicileId": ObjectId,
"eldId": "abc123",
"firstname": "xyz789",
"groupIds": [ObjectId],
"hos": DriverHos,
"isOwnerOperator": false,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"lastname": "abc123",
"license": DriverLicense,
"medical": DriverMedical,
"middlename": "abc123",
"phoneNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"userId": "xyz789"
}
]
}
}
bulkAddGoodProfileClasses
Response
Returns [GoodProfileClass!]!
Arguments
| Name | Description |
|---|---|
newGoodProfileClassesData - [NewGoodProfileClassInput!]!
|
Example
Query
mutation BulkAddGoodProfileClasses($newGoodProfileClassesData: [NewGoodProfileClassInput!]!) {
bulkAddGoodProfileClasses(newGoodProfileClassesData: $newGoodProfileClassesData) {
_id
description
label
}
}
Variables
{"newGoodProfileClassesData": [NewGoodProfileClassInput]}
Response
{
"data": {
"bulkAddGoodProfileClasses": [
{
"_id": ObjectId,
"description": "xyz789",
"label": "xyz789"
}
]
}
}
bulkAddGoodProfiles
Response
Returns [GoodProfile!]!
Arguments
| Name | Description |
|---|---|
newGoodProfilesData - [NewGoodProfileInput!]!
|
Example
Query
mutation BulkAddGoodProfiles($newGoodProfilesData: [NewGoodProfileInput!]!) {
bulkAddGoodProfiles(newGoodProfilesData: $newGoodProfilesData) {
_id
code
color
customFields {
key
value
}
documents {
_id
name
url
}
equivalences {
conditions {
...GoodProfileEquivalenceConditionFragment
}
equivalentGoodId
}
externalId
goodProfileClass {
_id
description
label
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
type
value
}
shipperIds
supplierIds
tags
unit
weight
}
}
Variables
{"newGoodProfilesData": [NewGoodProfileInput]}
Response
{
"data": {
"bulkAddGoodProfiles": [
{
"_id": "abc123",
"code": "xyz789",
"color": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"equivalences": [GoodProfileEquivalence],
"externalId": "xyz789",
"goodProfileClass": GoodProfileClass,
"goodProfileClassId": ObjectId,
"groupIds": [ObjectId],
"label": "xyz789",
"liquidGravity": 123.45,
"restrictions": [GoodProfileRestriction],
"shipperIds": ["xyz789"],
"supplierIds": ["xyz789"],
"tags": ["abc123"],
"unit": "GALLONS",
"weight": 123.45
}
]
}
}
bulkAddGroups
Response
Returns [Group!]!
Arguments
| Name | Description |
|---|---|
newGroupsData - [NewGroupInput!]!
|
Example
Query
mutation BulkAddGroups($newGroupsData: [NewGroupInput!]!) {
bulkAddGroups(newGroupsData: $newGroupsData) {
_id
description
memberIds
name
}
}
Variables
{"newGroupsData": [NewGroupInput]}
Response
{
"data": {
"bulkAddGroups": [
{
"_id": "abc123",
"description": "xyz789",
"memberIds": ["abc123"],
"name": "abc123"
}
]
}
}
bulkAddOrders
Response
Returns [Order!]!
Arguments
| Name | Description |
|---|---|
newOrdersData - [NewOrderInput!]!
|
Example
Query
mutation BulkAddOrders($newOrdersData: [NewOrderInput!]!) {
bulkAddOrders(newOrdersData: $newOrdersData) {
_id
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
locations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
orderNumber
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentId
status
}
}
Variables
{"newOrdersData": [NewOrderInput]}
Response
{
"data": {
"bulkAddOrders": [
{
"_id": "abc123",
"customer": BusinessEntity,
"customerId": ObjectId,
"locations": [ShipmentLocation],
"orderNumber": "abc123",
"shipment": Shipment,
"shipmentId": ObjectId,
"status": "ACTIVE"
}
]
}
}
bulkAddOrgUsers
Response
Returns [OrgUser!]!
Arguments
| Name | Description |
|---|---|
newOrgUsersData - [NewOrgUserInput!]!
|
Example
Query
mutation BulkAddOrgUsers($newOrgUsersData: [NewOrgUserInput!]!) {
bulkAddOrgUsers(newOrgUsersData: $newOrgUsersData) {
_id
attributes {
customFields
driverId
freshchatRestoreId
phoneNumber
phoneNumberVerified
promoCode
tags
trialDays
}
email
enabled
firstName
id
lastName
roles {
id
name
}
username
}
}
Variables
{"newOrgUsersData": [NewOrgUserInput]}
Response
{
"data": {
"bulkAddOrgUsers": [
{
"_id": "abc123",
"attributes": UserAttributes,
"email": "xyz789",
"enabled": true,
"firstName": "xyz789",
"id": "abc123",
"lastName": "abc123",
"roles": [KeycloakUserRole],
"username": "abc123"
}
]
}
}
bulkAddReceiverForecasts
Response
Returns [ReceiverForecast!]!
Arguments
| Name | Description |
|---|---|
newReceiverForecastsData - [NewReceiverForecastInput!]!
|
Example
Query
mutation BulkAddReceiverForecasts($newReceiverForecastsData: [NewReceiverForecastInput!]!) {
bulkAddReceiverForecasts(newReceiverForecastsData: $newReceiverForecastsData) {
_id
models {
_id
contaminates
isExclusive
label
maxCapacity
minCapacity
slots {
...ForecastingModelSlotFragment
}
storageFacilityId
target
threshold
weight
}
readingsFileConfiguration {
dateColumn
dateFormat
levelColumn
readingDeviationCriticalThreshold
readingDeviationDangerThreshold
readingDeviationWarningThreshold
runoutCriticalThreshold
runoutDangerThreshold
runoutWarningThreshold
staleReadingCriticalThreshold
staleReadingDangerThreshold
staleReadingWarningThreshold
storeColumn
tankIdColumn
timeColumn
timeFormat
}
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverId
trailerProfile {
compartments {
...TrailerProfileCompartmentFragment
}
}
}
}
Variables
{"newReceiverForecastsData": [NewReceiverForecastInput]}
Response
{
"data": {
"bulkAddReceiverForecasts": [
{
"_id": "abc123",
"models": [ForecastingModel],
"readingsFileConfiguration": ReadingsFileConfiguration,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"trailerProfile": TrailerProfile
}
]
}
}
bulkAddStorageFacilityReadings
Response
Returns [StorageFacilityReading!]!
Arguments
| Name | Description |
|---|---|
newStorageFacilityReadingsData - [NewStorageFacilityReadingInput!]!
|
Example
Query
mutation BulkAddStorageFacilityReadings($newStorageFacilityReadingsData: [NewStorageFacilityReadingInput!]!) {
bulkAddStorageFacilityReadings(newStorageFacilityReadingsData: $newStorageFacilityReadingsData) {
_id
date
level
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverId
storageFacilityId
}
}
Variables
{
"newStorageFacilityReadingsData": [
NewStorageFacilityReadingInput
]
}
Response
{
"data": {
"bulkAddStorageFacilityReadings": [
{
"_id": "xyz789",
"date": "2007-12-03T10:15:30Z",
"level": 987.65,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"storageFacilityId": "abc123"
}
]
}
}
bulkAddSupplierContracts
Response
Returns [SupplierContract!]!
Arguments
| Name | Description |
|---|---|
newSupplierContractsData - [NewSupplierContractInput!]!
|
Example
Query
mutation BulkAddSupplierContracts($newSupplierContractsData: [NewSupplierContractInput!]!) {
bulkAddSupplierContracts(newSupplierContractsData: $newSupplierContractsData) {
_id
allocation {
dailyQuantity
monthlyQuantity
totalQuantity
weeklyQuantity
}
conditions {
operator
target
value
}
contractNumber
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
endDate
goodProfile {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
goodProfileId
pinCode
shipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipperId
startDate
supplier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
supplierId
unitPrice
usedAllocation {
dailyQuantity
monthlyQuantity
totalQuantity
weeklyQuantity
}
}
}
Variables
{"newSupplierContractsData": [NewSupplierContractInput]}
Response
{
"data": {
"bulkAddSupplierContracts": [
{
"_id": "abc123",
"allocation": SupplierContractAllocation,
"conditions": [SupplierContractCondition],
"contractNumber": "abc123",
"customer": BusinessEntity,
"customerId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"goodProfile": GoodProfile,
"goodProfileId": ObjectId,
"pinCode": "abc123",
"shipper": BusinessEntity,
"shipperId": ObjectId,
"startDate": "2007-12-03T10:15:30Z",
"supplier": BusinessEntity,
"supplierId": ObjectId,
"unitPrice": 987.65,
"usedAllocation": SupplierContractAllocation
}
]
}
}
bulkAddTractors
Response
Returns [Tractor!]!
Arguments
| Name | Description |
|---|---|
newTractorsData - [NewTractorInput!]!
|
Example
Query
mutation BulkAddTractors($newTractorsData: [NewTractorInput!]!) {
bulkAddTractors(newTractorsData: $newTractorsData) {
_id
currentDriverEldId
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
eldId
groupIds
lastKnownEldLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownEldLocationDate
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
Variables
{"newTractorsData": [NewTractorInput]}
Response
{
"data": {
"bulkAddTractors": [
{
"_id": "xyz789",
"currentDriverEldId": "abc123",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "abc123",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "abc123",
"make": "xyz789",
"mileage": 987.65,
"model": "xyz789",
"plateNumber": "xyz789",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"tareWeight": 987.65,
"year": 987.65
}
]
}
}
bulkAddTrailerEvents
Response
Returns [TrailerEvent!]!
Arguments
| Name | Description |
|---|---|
newTrailerEventData - [NewTrailerEventInput!]!
|
Example
Query
mutation BulkAddTrailerEvents($newTrailerEventData: [NewTrailerEventInput!]!) {
bulkAddTrailerEvents(newTrailerEventData: $newTrailerEventData) {
_id
date
trailerId
type
}
}
Variables
{"newTrailerEventData": [NewTrailerEventInput]}
Response
{
"data": {
"bulkAddTrailerEvents": [
{
"_id": "xyz789",
"date": "2007-12-03T10:15:30Z",
"trailerId": ObjectId,
"type": "TRAILER_WASH"
}
]
}
}
bulkAddTrailers
Response
Returns [Trailer!]!
Arguments
| Name | Description |
|---|---|
newTrailerData - [NewTrailerInput!]!
|
Example
Query
mutation BulkAddTrailers($newTrailerData: [NewTrailerInput!]!) {
bulkAddTrailers(newTrailerData: $newTrailerData) {
_id
compartments {
capacity
identifier
unit
}
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
groupIds
height
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
Variables
{"newTrailerData": [NewTrailerInput]}
Response
{
"data": {
"bulkAddTrailers": [
{
"_id": "xyz789",
"compartments": [TrailerCompartment],
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"groupIds": [ObjectId],
"height": 123.45,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"length": 987.65,
"licenseNumber": "abc123",
"maxTemperature": 123.45,
"maxWeight": 987.65,
"mileage": 987.65,
"minTemperature": 987.65,
"numberOfAxles": 987.65,
"serial": "xyz789",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"type": "AUTO_CARRIER",
"vin": "abc123",
"width": 987.65
}
]
}
}
bulkAssignToGroup
Response
Returns a Group!
Arguments
| Name | Description |
|---|---|
groupId - ObjectId!
|
|
memberIds - [String!]!
|
Example
Query
mutation BulkAssignToGroup(
$groupId: ObjectId!,
$memberIds: [String!]!
) {
bulkAssignToGroup(
groupId: $groupId,
memberIds: $memberIds
) {
_id
description
memberIds
name
}
}
Variables
{
"groupId": ObjectId,
"memberIds": ["xyz789"]
}
Response
{
"data": {
"bulkAssignToGroup": {
"_id": "xyz789",
"description": "xyz789",
"memberIds": ["xyz789"],
"name": "abc123"
}
}
}
bulkEditBusinessEntities
Response
Returns a BulkUpdateResult!
Arguments
| Name | Description |
|---|---|
editBusinessEntityData - BusinessEntityUpdateInput!
|
|
ids - [ObjectId!]!
|
Example
Query
mutation BulkEditBusinessEntities(
$editBusinessEntityData: BusinessEntityUpdateInput!,
$ids: [ObjectId!]!
) {
bulkEditBusinessEntities(
editBusinessEntityData: $editBusinessEntityData,
ids: $ids
) {
acknowledged
matchedCount
modifiedCount
upsertedCount
}
}
Variables
{
"editBusinessEntityData": BusinessEntityUpdateInput,
"ids": [ObjectId]
}
Response
{
"data": {
"bulkEditBusinessEntities": {
"acknowledged": false,
"matchedCount": 123,
"modifiedCount": 123,
"upsertedCount": 123
}
}
}
bulkEditDrivers
Response
Returns a BulkUpdateResult!
Arguments
| Name | Description |
|---|---|
editDriverData - BulkEditDriverInput!
|
|
ids - [ObjectId!]!
|
Example
Query
mutation BulkEditDrivers(
$editDriverData: BulkEditDriverInput!,
$ids: [ObjectId!]!
) {
bulkEditDrivers(
editDriverData: $editDriverData,
ids: $ids
) {
acknowledged
matchedCount
modifiedCount
upsertedCount
}
}
Variables
{
"editDriverData": BulkEditDriverInput,
"ids": [ObjectId]
}
Response
{
"data": {
"bulkEditDrivers": {
"acknowledged": true,
"matchedCount": 987,
"modifiedCount": 123,
"upsertedCount": 987
}
}
}
bulkEditGoodProfiles
Response
Returns a BulkUpdateResult!
Arguments
| Name | Description |
|---|---|
editGoodProfileData - GoodProfileUpdateInput!
|
|
ids - [ObjectId!]!
|
Example
Query
mutation BulkEditGoodProfiles(
$editGoodProfileData: GoodProfileUpdateInput!,
$ids: [ObjectId!]!
) {
bulkEditGoodProfiles(
editGoodProfileData: $editGoodProfileData,
ids: $ids
) {
acknowledged
matchedCount
modifiedCount
upsertedCount
}
}
Variables
{
"editGoodProfileData": GoodProfileUpdateInput,
"ids": [ObjectId]
}
Response
{
"data": {
"bulkEditGoodProfiles": {
"acknowledged": false,
"matchedCount": 987,
"modifiedCount": 987,
"upsertedCount": 987
}
}
}
bulkEditShipments
Response
Returns a BulkUpdateResult!
Arguments
| Name | Description |
|---|---|
editshipmentsData - ShipmentUpdateInput!
|
|
ids - [ObjectId!]!
|
Example
Query
mutation BulkEditShipments(
$editshipmentsData: ShipmentUpdateInput!,
$ids: [ObjectId!]!
) {
bulkEditShipments(
editshipmentsData: $editshipmentsData,
ids: $ids
) {
acknowledged
matchedCount
modifiedCount
upsertedCount
}
}
Variables
{
"editshipmentsData": ShipmentUpdateInput,
"ids": [ObjectId]
}
Response
{
"data": {
"bulkEditShipments": {
"acknowledged": false,
"matchedCount": 987,
"modifiedCount": 123,
"upsertedCount": 987
}
}
}
bulkEditTractors
Response
Returns a BulkUpdateResult!
Arguments
| Name | Description |
|---|---|
editTractorData - TractorUpdateInput!
|
|
ids - [ObjectId!]!
|
Example
Query
mutation BulkEditTractors(
$editTractorData: TractorUpdateInput!,
$ids: [ObjectId!]!
) {
bulkEditTractors(
editTractorData: $editTractorData,
ids: $ids
) {
acknowledged
matchedCount
modifiedCount
upsertedCount
}
}
Variables
{
"editTractorData": TractorUpdateInput,
"ids": [ObjectId]
}
Response
{
"data": {
"bulkEditTractors": {
"acknowledged": true,
"matchedCount": 123,
"modifiedCount": 123,
"upsertedCount": 123
}
}
}
bulkEditTrailers
Response
Returns a BulkUpdateResult!
Arguments
| Name | Description |
|---|---|
editTrailerData - TrailerUpdateInput!
|
|
ids - [ObjectId!]!
|
Example
Query
mutation BulkEditTrailers(
$editTrailerData: TrailerUpdateInput!,
$ids: [ObjectId!]!
) {
bulkEditTrailers(
editTrailerData: $editTrailerData,
ids: $ids
) {
acknowledged
matchedCount
modifiedCount
upsertedCount
}
}
Variables
{
"editTrailerData": TrailerUpdateInput,
"ids": [ObjectId]
}
Response
{
"data": {
"bulkEditTrailers": {
"acknowledged": false,
"matchedCount": 987,
"modifiedCount": 987,
"upsertedCount": 123
}
}
}
bulkUpdateContractForShipments
Response
Returns [Shipment!]!
Arguments
| Name | Description |
|---|---|
contractId - ObjectId!
|
|
shipmentIds - [ObjectId!]!
|
Example
Query
mutation BulkUpdateContractForShipments(
$contractId: ObjectId!,
$shipmentIds: [ObjectId!]!
) {
bulkUpdateContractForShipments(
contractId: $contractId,
shipmentIds: $shipmentIds
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"contractId": ObjectId,
"shipmentIds": [ObjectId]
}
Response
{
"data": {
"bulkUpdateContractForShipments": [
{
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": true,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
]
}
}
callExtensionOperation
Response
Returns an ExtensionOperationResponse!
Example
Query
mutation CallExtensionOperation(
$extensionId: String!,
$operationKey: String!,
$recordId: String!
) {
callExtensionOperation(
extensionId: $extensionId,
operationKey: $operationKey,
recordId: $recordId
) {
message
openNewWindow
redirect
}
}
Variables
{
"extensionId": "abc123",
"operationKey": "abc123",
"recordId": "xyz789"
}
Response
{
"data": {
"callExtensionOperation": {
"message": "xyz789",
"openNewWindow": false,
"redirect": "xyz789"
}
}
}
cancelShipmentSplit
Example
Query
mutation CancelShipmentSplit($shipmentId: String!) {
cancelShipmentSplit(shipmentId: $shipmentId) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"shipmentId": "xyz789"}
Response
{
"data": {
"cancelShipmentSplit": {
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": true,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["abc123"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
changeTripStartTime
Response
Returns a Trip
Arguments
| Name | Description |
|---|---|
changeTripStartTimeData - ChangeTripStartTimeInput!
|
Example
Query
mutation ChangeTripStartTime($changeTripStartTimeData: ChangeTripStartTimeInput!) {
changeTripStartTime(changeTripStartTimeData: $changeTripStartTimeData) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{"changeTripStartTimeData": ChangeTripStartTimeInput}
Response
{
"data": {
"changeTripStartTime": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 987.65,
"distanceToStart": 123.45,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 987.65,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 123.45,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 123.45,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["abc123"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
}
}
checkShipmentsCombinability
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
generateTripData - GenerateTripInput!
|
Example
Query
mutation CheckShipmentsCombinability($generateTripData: GenerateTripInput!) {
checkShipmentsCombinability(generateTripData: $generateTripData)
}
Variables
{"generateTripData": GenerateTripInput}
Response
{"data": {"checkShipmentsCombinability": true}}
completeMaintenanceTask
Response
Returns a MaintenanceTask!
Arguments
| Name | Description |
|---|---|
id - ObjectId!
|
Example
Query
mutation CompleteMaintenanceTask($id: ObjectId!) {
completeMaintenanceTask(id: $id) {
_id
assetId
assetType
endDate
label
recurrence {
frequency
interval
}
required
startDate
startMileage
status
}
}
Variables
{"id": ObjectId}
Response
{
"data": {
"completeMaintenanceTask": {
"_id": "abc123",
"assetId": ObjectId,
"assetType": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"label": "xyz789",
"recurrence": MaintenanceTaskRecurrence,
"required": false,
"startDate": "2007-12-03T10:15:30Z",
"startMileage": 987.65,
"status": "CANCELLED"
}
}
}
computeLineHaulForTrip
Example
Query
mutation ComputeLineHaulForTrip($tripId: String!) {
computeLineHaulForTrip(tripId: $tripId) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{"tripId": "xyz789"}
Response
{
"data": {
"computeLineHaulForTrip": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 987.65,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 987.65,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 123.45,
"routeDistance": 123.45,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 987.65,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "xyz789",
"violations": [TripViolation]
}
}
}
consolidateInvoices
Response
Returns an Invoice
Arguments
| Name | Description |
|---|---|
invoiceIds - [ObjectId!]!
|
Example
Query
mutation ConsolidateInvoices($invoiceIds: [ObjectId!]!) {
consolidateInvoices(invoiceIds: $invoiceIds) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{"invoiceIds": [ObjectId]}
Response
{
"data": {
"consolidateInvoices": {
"_id": "xyz789",
"charges": [ShipmentCharge],
"closingNote": "xyz789",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "abc123",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 123.45,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 987.65
}
}
}
deleteAssetLinking
deleteBillingRule
deleteBroker
deleteBusinessEntity
deleteCharge
Example
Query
mutation DeleteCharge(
$chargeId: String!,
$shipmentId: String!
) {
deleteCharge(
chargeId: $chargeId,
shipmentId: $shipmentId
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"chargeId": "xyz789",
"shipmentId": "abc123"
}
Response
{
"data": {
"deleteCharge": {
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": true,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
deleteCustomFieldDefinition
deleteCustomer
deleteCustomerOrder
deleteDeductionRule
deleteDocumentShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
deleteDocumentData - DeleteShipmentDocumentInput!
|
Example
Query
mutation DeleteDocumentShipment($deleteDocumentData: DeleteShipmentDocumentInput!) {
deleteDocumentShipment(deleteDocumentData: $deleteDocumentData) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"deleteDocumentData": DeleteShipmentDocumentInput}
Response
{
"data": {
"deleteDocumentShipment": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": true,
"isFromSplit": false,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
deleteDriver
deleteDriverSettlement
deleteDriverShift
deleteDriverShiftAssignment
deleteGoodProfile
deleteGoodProfileClass
deleteGroup
deleteInvoice
deleteMaintenanceTask
deleteOrder
deleteOrgDoc
deleteOrgUser
deletePaymentRule
deleteQualification
deleteReasonCode
deleteReceiver
deleteReceiverForecast
deleteRelationship
deleteShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
deleteShipmentData - ShipmentDeleteInput
|
|
id - String!
|
Example
Query
mutation DeleteShipment(
$deleteShipmentData: ShipmentDeleteInput,
$id: String!
) {
deleteShipment(
deleteShipmentData: $deleteShipmentData,
id: $id
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"deleteShipmentData": ShipmentDeleteInput,
"id": "abc123"
}
Response
{
"data": {
"deleteShipment": {
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
deleteShipmentEvent
Example
Query
mutation DeleteShipmentEvent(
$eventId: ObjectId!,
$shipmentId: ObjectId!
) {
deleteShipmentEvent(
eventId: $eventId,
shipmentId: $shipmentId
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"eventId": ObjectId,
"shipmentId": ObjectId
}
Response
{
"data": {
"deleteShipmentEvent": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
deleteShipmentNote
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
deleteNoteData - DeleteShipmentNoteInput!
|
Example
Query
mutation DeleteShipmentNote($deleteNoteData: DeleteShipmentNoteInput!) {
deleteShipmentNote(deleteNoteData: $deleteNoteData) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"deleteNoteData": DeleteShipmentNoteInput}
Response
{
"data": {
"deleteShipmentNote": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": true,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
deleteShipper
deleteStorageFacilityReading
deleteSupplierContract
deleteTractor
deleteTrailer
deleteTrailerEvent
deleteTransaction
deleteTrip
Example
Query
mutation DeleteTrip($id: String!) {
deleteTrip(id: $id) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"deleteTrip": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 123.45,
"distanceToEnd": 987.65,
"distanceToStart": 123.45,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 123.45,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 987.65,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["abc123"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "xyz789",
"violations": [TripViolation]
}
}
}
deleteTripPayment
Example
Query
mutation DeleteTripPayment(
$paymentId: String!,
$tripId: String!
) {
deleteTripPayment(
paymentId: $paymentId,
tripId: $tripId
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{
"paymentId": "abc123",
"tripId": "abc123"
}
Response
{
"data": {
"deleteTripPayment": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 987.65,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 987.65,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "abc123",
"predictedLoadedDistance": 987.65,
"routeDistance": 123.45,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "xyz789",
"violations": [TripViolation]
}
}
}
documentSignedUrl
Response
Returns a DocumentSignedUrl!
Arguments
| Name | Description |
|---|---|
newDocumentSignedUrl - DocumentSignedUrlInput!
|
Example
Query
mutation DocumentSignedUrl($newDocumentSignedUrl: DocumentSignedUrlInput!) {
documentSignedUrl(newDocumentSignedUrl: $newDocumentSignedUrl) {
key
url
}
}
Variables
{"newDocumentSignedUrl": DocumentSignedUrlInput}
Response
{
"data": {
"documentSignedUrl": {
"key": "xyz789",
"url": "abc123"
}
}
}
editAssetLinking
Response
Returns an AssetLinking!
Arguments
| Name | Description |
|---|---|
editAssetLinkingData - AssetLinkingUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditAssetLinking(
$editAssetLinkingData: AssetLinkingUpdateInput!,
$id: String!
) {
editAssetLinking(
editAssetLinkingData: $editAssetLinkingData,
id: $id
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
endDate
isHardLinked
startDate
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
}
Variables
{
"editAssetLinkingData": AssetLinkingUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editAssetLinking": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"driver": Driver,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": true,
"startDate": "2007-12-03T10:15:30Z",
"tractor": Tractor,
"trailer": Trailer
}
}
}
editBillingRule
Response
Returns a BillingRule!
Arguments
| Name | Description |
|---|---|
editBillingRuleData - BillingRuleUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditBillingRule(
$editBillingRuleData: BillingRuleUpdateInput!,
$id: String!
) {
editBillingRule(
editBillingRuleData: $editBillingRuleData,
id: $id
) {
_id
amount
condition {
operator
parameters {
...BillingRuleConditionParameterFragment
}
target
value
}
conditions {
operator
parameters {
...BillingRuleConditionParameterFragment
}
target
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
label
method
priority
rates {
amount
label
method
parameters {
...BillingRateParameterFragment
}
referenceNumber
}
referenceNumber
type
}
}
Variables
{
"editBillingRuleData": BillingRuleUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editBillingRule": {
"_id": "abc123",
"amount": 987.65,
"condition": BillingRuleCondition,
"conditions": [BillingRuleCondition],
"customer": BusinessEntity,
"label": "xyz789",
"method": "FLAT_FEE",
"priority": 123.45,
"rates": [BillingRate],
"referenceNumber": "xyz789",
"type": "ACCESSORIAL"
}
}
}
editBroker
Response
Returns a Broker!
Arguments
| Name | Description |
|---|---|
editBrokerData - BusinessEntityUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditBroker(
$editBrokerData: BusinessEntityUpdateInput!,
$id: String!
) {
editBroker(
editBrokerData: $editBrokerData,
id: $id
) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{
"editBrokerData": BusinessEntityUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editBroker": {
"_id": "xyz789",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 123.45,
"code": "xyz789",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "xyz789",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
editBusinessEntity
Response
Returns a BusinessEntity!
Arguments
| Name | Description |
|---|---|
editBusinessEntityData - BusinessEntityUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditBusinessEntity(
$editBusinessEntityData: BusinessEntityUpdateInput!,
$id: String!
) {
editBusinessEntity(
editBusinessEntityData: $editBusinessEntityData,
id: $id
) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{
"editBusinessEntityData": BusinessEntityUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editBusinessEntity": {
"_id": "xyz789",
"accessToken": "xyz789",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 123.45,
"code": "xyz789",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
editCharge
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
editChargeData - ShipmentChargeInput!
|
|
shipmentId - String!
|
Example
Query
mutation EditCharge(
$editChargeData: ShipmentChargeInput!,
$shipmentId: String!
) {
editCharge(
editChargeData: $editChargeData,
shipmentId: $shipmentId
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"editChargeData": ShipmentChargeInput,
"shipmentId": "abc123"
}
Response
{
"data": {
"editCharge": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["abc123"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
editCustomFieldDefinition
Response
Returns a CustomFieldDefinition!
Arguments
| Name | Description |
|---|---|
editCustomFieldDefinitionData - CustomFieldDefinitionUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditCustomFieldDefinition(
$editCustomFieldDefinitionData: CustomFieldDefinitionUpdateInput!,
$id: String!
) {
editCustomFieldDefinition(
editCustomFieldDefinitionData: $editCustomFieldDefinitionData,
id: $id
) {
_id
context
description
isRequirement
key
label
requirementOptions {
isPartial
isRange
isRequired
}
selectOptions {
key
label
}
selectOptionsEndpoint
selectOptionsEntity
type
}
}
Variables
{
"editCustomFieldDefinitionData": CustomFieldDefinitionUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editCustomFieldDefinition": {
"_id": "xyz789",
"context": ["CARRIER"],
"description": "xyz789",
"isRequirement": false,
"key": "xyz789",
"label": "abc123",
"requirementOptions": CustomFieldRequirementOptions,
"selectOptions": [CustomFieldSelectOption],
"selectOptionsEndpoint": "xyz789",
"selectOptionsEntity": "CARRIER",
"type": "BOOLEAN"
}
}
}
editCustomer
Response
Returns a Customer!
Arguments
| Name | Description |
|---|---|
editCustomerData - BusinessEntityUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditCustomer(
$editCustomerData: BusinessEntityUpdateInput!,
$id: String!
) {
editCustomer(
editCustomerData: $editCustomerData,
id: $id
) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{
"editCustomerData": BusinessEntityUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editCustomer": {
"_id": "xyz789",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 987.65,
"code": "abc123",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "xyz789",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
editCustomerOrder
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
editOrderData - OrderUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditCustomerOrder(
$editOrderData: OrderUpdateInput!,
$id: String!
) {
editCustomerOrder(
editOrderData: $editOrderData,
id: $id
) {
_id
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
locations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
orderNumber
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentId
status
}
}
Variables
{
"editOrderData": OrderUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editCustomerOrder": {
"_id": "abc123",
"customer": BusinessEntity,
"customerId": ObjectId,
"locations": [ShipmentLocation],
"orderNumber": "xyz789",
"shipment": Shipment,
"shipmentId": ObjectId,
"status": "ACTIVE"
}
}
}
editDeductionRule
Response
Returns a DeductionRule!
Arguments
| Name | Description |
|---|---|
editDeductionRuleData - DeductionRuleUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditDeductionRule(
$editDeductionRuleData: DeductionRuleUpdateInput!,
$id: String!
) {
editDeductionRule(
editDeductionRuleData: $editDeductionRuleData,
id: $id
) {
_id
amount
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
label
method
period {
end
repeatEvery
start
unit
}
type
}
}
Variables
{
"editDeductionRuleData": DeductionRuleUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editDeductionRule": {
"_id": "xyz789",
"amount": 987.65,
"driver": Driver,
"label": "abc123",
"method": "FLAT_FEE",
"period": DeductionPeriod,
"type": "BONUS"
}
}
}
editDocumentShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
editDocumentData - EditShipmentDocumentInput!
|
Example
Query
mutation EditDocumentShipment($editDocumentData: EditShipmentDocumentInput!) {
editDocumentShipment(editDocumentData: $editDocumentData) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"editDocumentData": EditShipmentDocumentInput}
Response
{
"data": {
"editDocumentShipment": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": true,
"isFromSplit": true,
"isSplit": true,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
editDriver
Response
Returns a Driver!
Arguments
| Name | Description |
|---|---|
editDriverData - DriverUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditDriver(
$editDriverData: DriverUpdateInput!,
$id: String!
) {
editDriver(
editDriverData: $editDriverData,
id: $id
) {
_id
customFields {
key
value
}
dateOfBirth
dateOfPhysicalExamination
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
domicileEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
eldId
firstname
groupIds
hos {
currentDrivingTime
currentOnDutyTime
currentStatus
statusTime
totalDrivingTime
totalOnDutyTime
}
isOwnerOperator
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
lastname
license {
address {
...TextualAddressFragment
}
classification
endorsements
expiryDate
issuedDate
issuedState
licenseNumber
restriction
}
medical {
expiryDate
issuedDate
number
restriction
}
middlename
phoneNumber
status
tags
userId
}
}
Variables
{
"editDriverData": DriverUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editDriver": {
"_id": "xyz789",
"customFields": [CustomField],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocument],
"domicile": Address,
"domicileEntity": BusinessEntity,
"domicileId": ObjectId,
"eldId": "xyz789",
"firstname": "xyz789",
"groupIds": [ObjectId],
"hos": DriverHos,
"isOwnerOperator": false,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"lastname": "xyz789",
"license": DriverLicense,
"medical": DriverMedical,
"middlename": "abc123",
"phoneNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"userId": "xyz789"
}
}
}
editDriverSettlement
Response
Returns a DriverSettlement
Arguments
| Name | Description |
|---|---|
editDriverSettlementData - DriverSettlementUpdateInput!
|
|
id - ObjectId!
|
Example
Query
mutation EditDriverSettlement(
$editDriverSettlementData: DriverSettlementUpdateInput!,
$id: ObjectId!
) {
editDriverSettlement(
editDriverSettlementData: $editDriverSettlementData,
id: $id
) {
_id
deductions {
_id
amount
date
deductionRule {
...DeductionRuleFragment
}
label
type
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverSettlementNumber
endDate
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
pdfDocument {
error
isGenerating
url
}
startDate
status
trips {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{
"editDriverSettlementData": DriverSettlementUpdateInput,
"id": ObjectId
}
Response
{
"data": {
"editDriverSettlement": {
"_id": "xyz789",
"deductions": [Deduction],
"driver": Driver,
"driverSettlementNumber": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"payments": [TripPayment],
"pdfDocument": DriverSettlementPdf,
"startDate": "2007-12-03T10:15:30Z",
"status": "CANCELLED",
"trips": [Trip]
}
}
}
editDriverShift
Response
Returns a DriverShift!
Arguments
| Name | Description |
|---|---|
editDriverShiftData - DriverShiftUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditDriverShift(
$editDriverShiftData: DriverShiftUpdateInput!,
$id: String!
) {
editDriverShift(
editDriverShiftData: $editDriverShiftData,
id: $id
) {
_id
days
domicile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
domicileId
driverIds
endTime {
hour
minute
}
isAdhoc
label
startTime {
hour
minute
}
}
}
Variables
{
"editDriverShiftData": DriverShiftUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editDriverShift": {
"_id": "xyz789",
"days": [987],
"domicile": BusinessEntity,
"domicileId": ObjectId,
"driverIds": [ObjectId],
"endTime": Time,
"isAdhoc": true,
"label": "xyz789",
"startTime": Time
}
}
}
editDriverShiftAssignment
Response
Returns a DriverShiftAssignment!
Arguments
| Name | Description |
|---|---|
editDriverShiftAssignmentData - DriverShiftAssignmentUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditDriverShiftAssignment(
$editDriverShiftAssignmentData: DriverShiftAssignmentUpdateInput!,
$id: String!
) {
editDriverShiftAssignment(
editDriverShiftAssignmentData: $editDriverShiftAssignmentData,
id: $id
) {
_id
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverId
driverShift {
_id
days
domicile {
...BusinessEntityFragment
}
domicileId
driverIds
endTime {
...TimeFragment
}
isAdhoc
label
startTime {
...TimeFragment
}
}
driverShiftId
endDate
startDate
}
}
Variables
{
"editDriverShiftAssignmentData": DriverShiftAssignmentUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editDriverShiftAssignment": {
"_id": "abc123",
"driver": Driver,
"driverId": ObjectId,
"driverShift": DriverShift,
"driverShiftId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"startDate": "2007-12-03T10:15:30Z"
}
}
}
editGoodPinCode
Description
Edit good pin code
Response
Returns a Shipment
Example
Query
mutation EditGoodPinCode(
$goodId: String!,
$id: ObjectId!,
$pinCode: String!
) {
editGoodPinCode(
goodId: $goodId,
id: $id,
pinCode: $pinCode
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"goodId": "abc123",
"id": ObjectId,
"pinCode": "abc123"
}
Response
{
"data": {
"editGoodPinCode": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": true,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
editGoodProfile
Response
Returns a GoodProfile!
Arguments
| Name | Description |
|---|---|
editGoodProfileData - GoodProfileUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditGoodProfile(
$editGoodProfileData: GoodProfileUpdateInput!,
$id: String!
) {
editGoodProfile(
editGoodProfileData: $editGoodProfileData,
id: $id
) {
_id
code
color
customFields {
key
value
}
documents {
_id
name
url
}
equivalences {
conditions {
...GoodProfileEquivalenceConditionFragment
}
equivalentGoodId
}
externalId
goodProfileClass {
_id
description
label
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
type
value
}
shipperIds
supplierIds
tags
unit
weight
}
}
Variables
{
"editGoodProfileData": GoodProfileUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editGoodProfile": {
"_id": "abc123",
"code": "xyz789",
"color": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"equivalences": [GoodProfileEquivalence],
"externalId": "xyz789",
"goodProfileClass": GoodProfileClass,
"goodProfileClassId": ObjectId,
"groupIds": [ObjectId],
"label": "xyz789",
"liquidGravity": 987.65,
"restrictions": [GoodProfileRestriction],
"shipperIds": ["xyz789"],
"supplierIds": ["xyz789"],
"tags": ["abc123"],
"unit": "GALLONS",
"weight": 123.45
}
}
}
editGoodProfileClass
Response
Returns a GoodProfileClass
Arguments
| Name | Description |
|---|---|
editGoodProfileClassData - GoodProfileClassUpdateInput!
|
|
id - ObjectId!
|
Example
Query
mutation EditGoodProfileClass(
$editGoodProfileClassData: GoodProfileClassUpdateInput!,
$id: ObjectId!
) {
editGoodProfileClass(
editGoodProfileClassData: $editGoodProfileClassData,
id: $id
) {
_id
description
label
}
}
Variables
{
"editGoodProfileClassData": GoodProfileClassUpdateInput,
"id": ObjectId
}
Response
{
"data": {
"editGoodProfileClass": {
"_id": ObjectId,
"description": "abc123",
"label": "abc123"
}
}
}
editGoodWeight
Description
Edit good weight
Response
Returns a Shipment
Example
Query
mutation EditGoodWeight(
$goodId: String!,
$id: ObjectId!,
$weight: Float!
) {
editGoodWeight(
goodId: $goodId,
id: $id,
weight: $weight
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"goodId": "abc123",
"id": ObjectId,
"weight": 123.45
}
Response
{
"data": {
"editGoodWeight": {
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": true,
"isFromSplit": false,
"isSplit": true,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
editGroup
Response
Returns a Group!
Arguments
| Name | Description |
|---|---|
editGroupData - GroupUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditGroup(
$editGroupData: GroupUpdateInput!,
$id: String!
) {
editGroup(
editGroupData: $editGroupData,
id: $id
) {
_id
description
memberIds
name
}
}
Variables
{
"editGroupData": GroupUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editGroup": {
"_id": "abc123",
"description": "abc123",
"memberIds": ["abc123"],
"name": "xyz789"
}
}
}
editInvoice
Response
Returns an Invoice
Arguments
| Name | Description |
|---|---|
editInvoiceData - InvoiceUpdateInput!
|
|
id - ObjectId!
|
Example
Query
mutation EditInvoice(
$editInvoiceData: InvoiceUpdateInput!,
$id: ObjectId!
) {
editInvoice(
editInvoiceData: $editInvoiceData,
id: $id
) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{
"editInvoiceData": InvoiceUpdateInput,
"id": ObjectId
}
Response
{
"data": {
"editInvoice": {
"_id": "xyz789",
"charges": [ShipmentCharge],
"closingNote": "xyz789",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "abc123",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 123.45,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 987.65
}
}
}
editMaintenanceTask
Response
Returns a MaintenanceTask!
Arguments
| Name | Description |
|---|---|
editMaintenanceTaskData - MaintenanceTaskUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditMaintenanceTask(
$editMaintenanceTaskData: MaintenanceTaskUpdateInput!,
$id: String!
) {
editMaintenanceTask(
editMaintenanceTaskData: $editMaintenanceTaskData,
id: $id
) {
_id
assetId
assetType
endDate
label
recurrence {
frequency
interval
}
required
startDate
startMileage
status
}
}
Variables
{
"editMaintenanceTaskData": MaintenanceTaskUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editMaintenanceTask": {
"_id": "abc123",
"assetId": ObjectId,
"assetType": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"label": "abc123",
"recurrence": MaintenanceTaskRecurrence,
"required": false,
"startDate": "2007-12-03T10:15:30Z",
"startMileage": 987.65,
"status": "CANCELLED"
}
}
}
editNoteShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
editNoteData - EditShipmentNoteInput!
|
Example
Query
mutation EditNoteShipment($editNoteData: EditShipmentNoteInput!) {
editNoteShipment(editNoteData: $editNoteData) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"editNoteData": EditShipmentNoteInput}
Response
{
"data": {
"editNoteShipment": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": false,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
editOrder
Response
Returns an Order!
Arguments
| Name | Description |
|---|---|
editOrderData - OrderUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditOrder(
$editOrderData: OrderUpdateInput!,
$id: String!
) {
editOrder(
editOrderData: $editOrderData,
id: $id
) {
_id
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
locations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
orderNumber
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentId
status
}
}
Variables
{
"editOrderData": OrderUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editOrder": {
"_id": "xyz789",
"customer": BusinessEntity,
"customerId": ObjectId,
"locations": [ShipmentLocation],
"orderNumber": "abc123",
"shipment": Shipment,
"shipmentId": ObjectId,
"status": "ACTIVE"
}
}
}
editOrgDoc
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
id - ObjectId!
|
|
organizationDocumentData - OrganizationDocumentUpdateInput!
|
Example
Query
mutation EditOrgDoc(
$id: ObjectId!,
$organizationDocumentData: OrganizationDocumentUpdateInput!
) {
editOrgDoc(
id: $id,
organizationDocumentData: $organizationDocumentData
)
}
Variables
{
"id": ObjectId,
"organizationDocumentData": OrganizationDocumentUpdateInput
}
Response
{"data": {"editOrgDoc": "abc123"}}
editOrgUser
Response
Returns an OrgUser!
Arguments
| Name | Description |
|---|---|
editOrgUserData - OrgUserUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditOrgUser(
$editOrgUserData: OrgUserUpdateInput!,
$id: String!
) {
editOrgUser(
editOrgUserData: $editOrgUserData,
id: $id
) {
_id
attributes {
customFields
driverId
freshchatRestoreId
phoneNumber
phoneNumberVerified
promoCode
tags
trialDays
}
email
enabled
firstName
id
lastName
roles {
id
name
}
username
}
}
Variables
{
"editOrgUserData": OrgUserUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editOrgUser": {
"_id": "xyz789",
"attributes": UserAttributes,
"email": "xyz789",
"enabled": true,
"firstName": "xyz789",
"id": "abc123",
"lastName": "xyz789",
"roles": [KeycloakUserRole],
"username": "abc123"
}
}
}
editOrganization
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
organizationSetupData - OrganizationUpdateInput!
|
Example
Query
mutation EditOrganization($organizationSetupData: OrganizationUpdateInput!) {
editOrganization(organizationSetupData: $organizationSetupData)
}
Variables
{"organizationSetupData": OrganizationUpdateInput}
Response
{"data": {"editOrganization": "abc123"}}
editPaymentRule
Response
Returns a PaymentRule
Arguments
| Name | Description |
|---|---|
editPaymentRuleData - PaymentRuleUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditPaymentRule(
$editPaymentRuleData: PaymentRuleUpdateInput!,
$id: String!
) {
editPaymentRule(
editPaymentRuleData: $editPaymentRuleData,
id: $id
) {
_id
amount
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
method
period {
end
repeatEvery
start
unit
}
}
}
Variables
{
"editPaymentRuleData": PaymentRuleUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editPaymentRule": {
"_id": "xyz789",
"amount": 987.65,
"driver": Driver,
"method": "PER_HOUR",
"period": PaymentPeriod
}
}
}
editQualification
Response
Returns a Qualification!
Arguments
| Name | Description |
|---|---|
editQualificationData - QualificationUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditQualification(
$editQualificationData: QualificationUpdateInput!,
$id: String!
) {
editQualification(
editQualificationData: $editQualificationData,
id: $id
) {
_id
assetId
assetType
documents {
_id
name
url
}
endDate
label
number
required
startDate
}
}
Variables
{
"editQualificationData": QualificationUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editQualification": {
"_id": "abc123",
"assetId": ObjectId,
"assetType": "abc123",
"documents": [Document],
"endDate": "2007-12-03T10:15:30Z",
"label": "xyz789",
"number": "xyz789",
"required": false,
"startDate": "2007-12-03T10:15:30Z"
}
}
}
editReasonCode
Response
Returns a ReasonCode!
Arguments
| Name | Description |
|---|---|
editReasonCodeData - ReasonCodeUpdateInput!
|
|
id - ObjectId!
|
Example
Query
mutation EditReasonCode(
$editReasonCodeData: ReasonCodeUpdateInput!,
$id: ObjectId!
) {
editReasonCode(
editReasonCodeData: $editReasonCodeData,
id: $id
) {
_id
createdAt
createdBy
description
locationId
shipmentId
tripId
type
updatedAt
}
}
Variables
{
"editReasonCodeData": ReasonCodeUpdateInput,
"id": ObjectId
}
Response
{
"data": {
"editReasonCode": {
"_id": ObjectId,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": "abc123",
"description": "xyz789",
"locationId": "xyz789",
"shipmentId": ObjectId,
"tripId": ObjectId,
"type": "CUSTOMER",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
editReceiver
Response
Returns a Receiver!
Arguments
| Name | Description |
|---|---|
editReceiverData - BusinessEntityUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditReceiver(
$editReceiverData: BusinessEntityUpdateInput!,
$id: String!
) {
editReceiver(
editReceiverData: $editReceiverData,
id: $id
) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{
"editReceiverData": BusinessEntityUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editReceiver": {
"_id": "xyz789",
"accessToken": "xyz789",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 987.65,
"code": "xyz789",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "xyz789",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
editReceiverForecast
Response
Returns a ReceiverForecast!
Arguments
| Name | Description |
|---|---|
editReceiverForecastData - ReceiverForecastUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditReceiverForecast(
$editReceiverForecastData: ReceiverForecastUpdateInput!,
$id: String!
) {
editReceiverForecast(
editReceiverForecastData: $editReceiverForecastData,
id: $id
) {
_id
models {
_id
contaminates
isExclusive
label
maxCapacity
minCapacity
slots {
...ForecastingModelSlotFragment
}
storageFacilityId
target
threshold
weight
}
readingsFileConfiguration {
dateColumn
dateFormat
levelColumn
readingDeviationCriticalThreshold
readingDeviationDangerThreshold
readingDeviationWarningThreshold
runoutCriticalThreshold
runoutDangerThreshold
runoutWarningThreshold
staleReadingCriticalThreshold
staleReadingDangerThreshold
staleReadingWarningThreshold
storeColumn
tankIdColumn
timeColumn
timeFormat
}
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverId
trailerProfile {
compartments {
...TrailerProfileCompartmentFragment
}
}
}
}
Variables
{
"editReceiverForecastData": ReceiverForecastUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editReceiverForecast": {
"_id": "abc123",
"models": [ForecastingModel],
"readingsFileConfiguration": ReadingsFileConfiguration,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"trailerProfile": TrailerProfile
}
}
}
editRelationship
Response
Returns a Relationship!
Arguments
| Name | Description |
|---|---|
editRelationshipData - RelationshipUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditRelationship(
$editRelationshipData: RelationshipUpdateInput!,
$id: String!
) {
editRelationship(
editRelationshipData: $editRelationshipData,
id: $id
) {
_id
commodities {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
commodityIds
customerIds
customers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverIds
receivers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipperIds
shippers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
supplierIds
suppliers {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
}
}
Variables
{
"editRelationshipData": RelationshipUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editRelationship": {
"_id": "xyz789",
"commodities": [GoodProfile],
"commodityIds": [ObjectId],
"customerIds": [ObjectId],
"customers": [BusinessEntity],
"receiverIds": [ObjectId],
"receivers": [BusinessEntity],
"shipperIds": [ObjectId],
"shippers": [BusinessEntity],
"supplierIds": [ObjectId],
"suppliers": [BusinessEntity]
}
}
}
editShipment
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
editShipmentData - ShipmentUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditShipment(
$editShipmentData: ShipmentUpdateInput!,
$id: String!
) {
editShipment(
editShipmentData: $editShipmentData,
id: $id
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"editShipmentData": ShipmentUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editShipment": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
editShipmentEvent
Response
Returns a ShipmentEvent
Arguments
| Name | Description |
|---|---|
eventId - ObjectId!
|
|
shipmentEventData - UpdateShipmentEventInput!
|
|
shipmentId - ObjectId!
|
Example
Query
mutation EditShipmentEvent(
$eventId: ObjectId!,
$shipmentEventData: UpdateShipmentEventInput!,
$shipmentId: ObjectId!
) {
editShipmentEvent(
eventId: $eventId,
shipmentEventData: $shipmentEventData,
shipmentId: $shipmentId
) {
_id
coordinates {
altitude
heading
latitude
longitude
speed
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
}
Variables
{
"eventId": ObjectId,
"shipmentEventData": UpdateShipmentEventInput,
"shipmentId": ObjectId
}
Response
{
"data": {
"editShipmentEvent": {
"_id": "abc123",
"coordinates": Coordinates,
"createdBy": "abc123",
"date": "2007-12-03T10:15:30Z",
"description": "xyz789",
"label": "xyz789",
"metadata": {},
"shipmentLocation": "xyz789",
"tripShipmentLocation": "xyz789",
"type": "CHECK_CALL"
}
}
}
editShipmentReferences
Description
Edit shipment references
Response
Returns a Shipment
Arguments
| Name | Description |
|---|---|
editReferencesData - ShipmentReferencesUpdateInput!
|
|
id - ObjectId!
|
Example
Query
mutation EditShipmentReferences(
$editReferencesData: ShipmentReferencesUpdateInput!,
$id: ObjectId!
) {
editShipmentReferences(
editReferencesData: $editReferencesData,
id: $id
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"editReferencesData": ShipmentReferencesUpdateInput,
"id": ObjectId
}
Response
{
"data": {
"editShipmentReferences": {
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": false,
"isFromSplit": false,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
editShipper
Response
Returns a Shipper!
Arguments
| Name | Description |
|---|---|
editShipperData - BusinessEntityUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditShipper(
$editShipperData: BusinessEntityUpdateInput!,
$id: String!
) {
editShipper(
editShipperData: $editShipperData,
id: $id
) {
_id
accessToken
additionalContacts {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
additionalTypes
address {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
addressTimezone
billingAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
email
extensionNumber
faxNumber
firstname
includeInInvoicing
lastname
middlename
phoneNumber
title
url
}
creditTerms
customFields {
key
value
}
defaultReferenceNumbers {
referenceNumberType
referenceNumberValue
}
defaultShipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
defaultShipperId
documentRequirements {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
documents {
_id
name
url
}
dotNumber
externalId
federalId
goodInventoryItems {
_id
label
weight
}
groupIds
mcNumber
name
notes {
_id
accessLevel
addToShipment
content
}
openingSchedules {
closingTime
days
openingTime
}
parentBusinessEntity {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
parentBusinessEntityId
payToProfile {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
payToProfileId
referenceNumberTypes
remitAddress {
city
country
googlePlaceId
line1
line2
postalCode
state
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
capacity
commodities {
...GoodProfileFragment
}
commodity {
...GoodProfileFragment
}
commodityId
commodityIds
currentForecastedReading {
...ReadingFragment
}
currentSalesTrend
defaultPinCode
defaultSupplier {
...BusinessEntityFragment
}
defaultSupplierId
identifier
latestReading {
...ReadingFragment
}
linkedStorageFacilityIds
runoutDate
runoutDateAfterNextShipment
safeFillLevel
shutDownLevel
unit
}
tags
trailerTypes
type
}
}
Variables
{
"editShipperData": BusinessEntityUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editShipper": {
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 123.45,
"code": "abc123",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": [
"abc123"
],
"standardCarrierAlphaCode": "xyz789",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
}
}
editStorageFacilityReading
Response
Returns a StorageFacilityReading!
Arguments
| Name | Description |
|---|---|
editStorageFacilityReadingData - StorageFacilityReadingUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditStorageFacilityReading(
$editStorageFacilityReadingData: StorageFacilityReadingUpdateInput!,
$id: String!
) {
editStorageFacilityReading(
editStorageFacilityReadingData: $editStorageFacilityReadingData,
id: $id
) {
_id
date
level
receiver {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
receiverId
storageFacilityId
}
}
Variables
{
"editStorageFacilityReadingData": StorageFacilityReadingUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editStorageFacilityReading": {
"_id": "abc123",
"date": "2007-12-03T10:15:30Z",
"level": 123.45,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"storageFacilityId": "xyz789"
}
}
}
editSupplierContract
Response
Returns a SupplierContract!
Arguments
| Name | Description |
|---|---|
editSupplierContractData - SupplierContractUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditSupplierContract(
$editSupplierContractData: SupplierContractUpdateInput!,
$id: String!
) {
editSupplierContract(
editSupplierContractData: $editSupplierContractData,
id: $id
) {
_id
allocation {
dailyQuantity
monthlyQuantity
totalQuantity
weeklyQuantity
}
conditions {
operator
target
value
}
contractNumber
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
customerId
endDate
goodProfile {
_id
code
color
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
equivalences {
...GoodProfileEquivalenceFragment
}
externalId
goodProfileClass {
...GoodProfileClassFragment
}
goodProfileClassId
groupIds
label
liquidGravity
restrictions {
...GoodProfileRestrictionFragment
}
shipperIds
supplierIds
tags
unit
weight
}
goodProfileId
pinCode
shipper {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
shipperId
startDate
supplier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
supplierId
unitPrice
usedAllocation {
dailyQuantity
monthlyQuantity
totalQuantity
weeklyQuantity
}
}
}
Variables
{
"editSupplierContractData": SupplierContractUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editSupplierContract": {
"_id": "xyz789",
"allocation": SupplierContractAllocation,
"conditions": [SupplierContractCondition],
"contractNumber": "abc123",
"customer": BusinessEntity,
"customerId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"goodProfile": GoodProfile,
"goodProfileId": ObjectId,
"pinCode": "xyz789",
"shipper": BusinessEntity,
"shipperId": ObjectId,
"startDate": "2007-12-03T10:15:30Z",
"supplier": BusinessEntity,
"supplierId": ObjectId,
"unitPrice": 987.65,
"usedAllocation": SupplierContractAllocation
}
}
}
editTractor
Response
Returns a Tractor!
Arguments
| Name | Description |
|---|---|
editTractorData - TractorUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditTractor(
$editTractorData: TractorUpdateInput!,
$id: String!
) {
editTractor(
editTractorData: $editTractorData,
id: $id
) {
_id
currentDriverEldId
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
eldId
groupIds
lastKnownEldLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownEldLocationDate
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
}
Variables
{
"editTractorData": TractorUpdateInput,
"id": "abc123"
}
Response
{
"data": {
"editTractor": {
"_id": "abc123",
"currentDriverEldId": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "abc123",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "abc123",
"make": "abc123",
"mileage": 123.45,
"model": "abc123",
"plateNumber": "xyz789",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"tareWeight": 987.65,
"year": 123.45
}
}
}
editTrailer
Response
Returns a Trailer!
Arguments
| Name | Description |
|---|---|
editTrailerData - TrailerUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditTrailer(
$editTrailerData: TrailerUpdateInput!,
$id: String!
) {
editTrailer(
editTrailerData: $editTrailerData,
id: $id
) {
_id
compartments {
capacity
identifier
unit
}
customFields {
key
value
}
documents {
_id
name
url
}
domicile {
city
coordinates {
...CoordinatesFragment
}
country
googlePlaceId
label
line1
line2
postalCode
state
}
groupIds
height
lastKnownLocation {
altitude
heading
latitude
longitude
speed
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
}
Variables
{
"editTrailerData": TrailerUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editTrailer": {
"_id": "abc123",
"compartments": [TrailerCompartment],
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"groupIds": [ObjectId],
"height": 987.65,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"length": 987.65,
"licenseNumber": "abc123",
"maxTemperature": 987.65,
"maxWeight": 123.45,
"mileage": 123.45,
"minTemperature": 123.45,
"numberOfAxles": 987.65,
"serial": "xyz789",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"type": "AUTO_CARRIER",
"vin": "abc123",
"width": 123.45
}
}
}
editTrailerEvent
Response
Returns a TrailerEvent!
Arguments
| Name | Description |
|---|---|
editTrailerEventData - TrailerEventUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditTrailerEvent(
$editTrailerEventData: TrailerEventUpdateInput!,
$id: String!
) {
editTrailerEvent(
editTrailerEventData: $editTrailerEventData,
id: $id
) {
_id
date
trailerId
type
}
}
Variables
{
"editTrailerEventData": TrailerEventUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editTrailerEvent": {
"_id": "xyz789",
"date": "2007-12-03T10:15:30Z",
"trailerId": ObjectId,
"type": "TRAILER_WASH"
}
}
}
editTransaction
Response
Returns a Transaction!
Arguments
| Name | Description |
|---|---|
editTransactionData - TransactionUpdateInput!
|
|
id - String!
|
Example
Query
mutation EditTransaction(
$editTransactionData: TransactionUpdateInput!,
$id: String!
) {
editTransaction(
editTransactionData: $editTransactionData,
id: $id
) {
_id
customFields {
key
value
}
document {
_id
name
url
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
}
Variables
{
"editTransactionData": TransactionUpdateInput,
"id": "xyz789"
}
Response
{
"data": {
"editTransaction": {
"_id": "xyz789",
"customFields": [CustomField],
"document": TransactionDocument,
"label": "abc123",
"number": "xyz789",
"rate": 123.45,
"reimburseToDriver": false,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": false,
"type": "EXPENSE",
"unit": 987.65,
"unitType": "xyz789"
}
}
}
editTripPayment
Response
Returns a Trip
Arguments
| Name | Description |
|---|---|
payment - TransactionInput!
|
|
paymentId - String!
|
|
tripId - String!
|
Example
Query
mutation EditTripPayment(
$payment: TransactionInput!,
$paymentId: String!,
$tripId: String!
) {
editTripPayment(
payment: $payment,
paymentId: $paymentId,
tripId: $tripId
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{
"payment": TransactionInput,
"paymentId": "abc123",
"tripId": "abc123"
}
Response
{
"data": {
"editTripPayment": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 123.45,
"distanceToStart": 123.45,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 123.45,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 987.65,
"routeDistance": 123.45,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 987.65,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "xyz789",
"violations": [TripViolation]
}
}
}
forecast
Response
Returns a ForecastResult!
Arguments
| Name | Description |
|---|---|
payload - ForecastingPayload!
|
Example
Query
mutation Forecast($payload: ForecastingPayload!) {
forecast(payload: $payload) {
shipments {
_id
additionalTrailerTypes
charges {
...ShipmentChargeFragment
}
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customer {
...BusinessEntityFragment
}
loadType
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
trailerType
}
}
}
Variables
{"payload": ForecastingPayload}
Response
{
"data": {
"forecast": {"shipments": [ForecastedShipment]}
}
}
generateDriverSettlement
Response
Returns a DriverSettlement!
Example
Query
mutation GenerateDriverSettlement(
$driverId: String!,
$driverSettlementNumber: String,
$endDate: DateTime!,
$startDate: DateTime!,
$timezone: String
) {
generateDriverSettlement(
driverId: $driverId,
driverSettlementNumber: $driverSettlementNumber,
endDate: $endDate,
startDate: $startDate,
timezone: $timezone
) {
_id
deductions {
_id
amount
date
deductionRule {
...DeductionRuleFragment
}
label
type
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverSettlementNumber
endDate
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
pdfDocument {
error
isGenerating
url
}
startDate
status
trips {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{
"driverId": "abc123",
"driverSettlementNumber": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"startDate": "2007-12-03T10:15:30Z",
"timezone": "abc123"
}
Response
{
"data": {
"generateDriverSettlement": {
"_id": "xyz789",
"deductions": [Deduction],
"driver": Driver,
"driverSettlementNumber": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"payments": [TripPayment],
"pdfDocument": DriverSettlementPdf,
"startDate": "2007-12-03T10:15:30Z",
"status": "CANCELLED",
"trips": [Trip]
}
}
}
generateDriverSettlementForTrips
Response
Returns a DriverSettlement!
Arguments
| Name | Description |
|---|---|
driverSettlementNumber - String
|
|
timezone - String
|
|
tripIds - [String!]!
|
Example
Query
mutation GenerateDriverSettlementForTrips(
$driverSettlementNumber: String,
$timezone: String,
$tripIds: [String!]!
) {
generateDriverSettlementForTrips(
driverSettlementNumber: $driverSettlementNumber,
timezone: $timezone,
tripIds: $tripIds
) {
_id
deductions {
_id
amount
date
deductionRule {
...DeductionRuleFragment
}
label
type
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverSettlementNumber
endDate
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
pdfDocument {
error
isGenerating
url
}
startDate
status
trips {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{
"driverSettlementNumber": "abc123",
"timezone": "abc123",
"tripIds": ["xyz789"]
}
Response
{
"data": {
"generateDriverSettlementForTrips": {
"_id": "abc123",
"deductions": [Deduction],
"driver": Driver,
"driverSettlementNumber": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"payments": [TripPayment],
"pdfDocument": DriverSettlementPdf,
"startDate": "2007-12-03T10:15:30Z",
"status": "CANCELLED",
"trips": [Trip]
}
}
}
generateInvoice
Example
Query
mutation GenerateInvoice(
$invoiceNumber: String,
$shipmentId: String!
) {
generateInvoice(
invoiceNumber: $invoiceNumber,
shipmentId: $shipmentId
) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{
"invoiceNumber": "xyz789",
"shipmentId": "abc123"
}
Response
{
"data": {
"generateInvoice": {
"_id": "xyz789",
"charges": [ShipmentCharge],
"closingNote": "xyz789",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "abc123",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 123.45,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 123.45
}
}
}
generateReportPdf
Response
Returns a ReportPdf!
Arguments
| Name | Description |
|---|---|
filter - ReportFilter
|
|
lang - String!
|
|
period - PeriodInput!
|
|
reportType - ReportType!
|
|
timezone - String!
|
Example
Query
mutation GenerateReportPdf(
$filter: ReportFilter,
$lang: String!,
$period: PeriodInput!,
$reportType: ReportType!,
$timezone: String!
) {
generateReportPdf(
filter: $filter,
lang: $lang,
period: $period,
reportType: $reportType,
timezone: $timezone
) {
url
}
}
Variables
{
"filter": ReportFilter,
"lang": "xyz789",
"period": PeriodInput,
"reportType": "CUSTOMER_REVENUE",
"timezone": "xyz789"
}
Response
{
"data": {
"generateReportPdf": {"url": "xyz789"}
}
}
generateShipmentRoute
Response
Returns a ShipmentRoute!
Arguments
| Name | Description |
|---|---|
shipmentData - NewShipmentInput!
|
Example
Query
mutation GenerateShipmentRoute($shipmentData: NewShipmentInput!) {
generateShipmentRoute(shipmentData: $shipmentData) {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
predictedLoadedDistance
routeDistance
violations {
cause
duration
locationId
}
}
}
Variables
{"shipmentData": NewShipmentInput}
Response
{
"data": {
"generateShipmentRoute": {
"distanceToEnd": 987.65,
"distanceToStart": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"locations": [TripShipmentLocation],
"predictedLoadedDistance": 987.65,
"routeDistance": 987.65,
"violations": [TripViolation]
}
}
}
generateTrip
Response
Returns a Trip!
Arguments
| Name | Description |
|---|---|
generateTripData - GenerateTripInput!
|
|
ignoreDriverShifts - Boolean
|
Default = false |
Example
Query
mutation GenerateTrip(
$generateTripData: GenerateTripInput!,
$ignoreDriverShifts: Boolean
) {
generateTrip(
generateTripData: $generateTripData,
ignoreDriverShifts: $ignoreDriverShifts
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{
"generateTripData": GenerateTripInput,
"ignoreDriverShifts": false
}
Response
{
"data": {
"generateTrip": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 987.65,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 123.45,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 987.65,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "xyz789",
"violations": [TripViolation]
}
}
}
generateTripsForPendingShipments
Response
Returns a TripGenerationResult!
Example
Query
mutation GenerateTripsForPendingShipments {
generateTripsForPendingShipments {
trips {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
unassignedShipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shipment {
...ShipmentFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
unplannedShipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
}
}
Response
{
"data": {
"generateTripsForPendingShipments": {
"trips": [Trip],
"unassignedShipmentLocations": [
ShipmentLocationWithShipment
],
"unplannedShipments": [Shipment]
}
}
}
generateTripsForShipments
Response
Returns a TripGenerationResult!
Arguments
| Name | Description |
|---|---|
endDate - DateTime!
|
|
shipmentIds - [ObjectId!]!
|
|
startDate - DateTime!
|
Example
Query
mutation GenerateTripsForShipments(
$endDate: DateTime!,
$shipmentIds: [ObjectId!]!,
$startDate: DateTime!
) {
generateTripsForShipments(
endDate: $endDate,
shipmentIds: $shipmentIds,
startDate: $startDate
) {
trips {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
unassignedShipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shipment {
...ShipmentFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
unplannedShipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
}
}
Variables
{
"endDate": "2007-12-03T10:15:30Z",
"shipmentIds": [ObjectId],
"startDate": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"generateTripsForShipments": {
"trips": [Trip],
"unassignedShipmentLocations": [
ShipmentLocationWithShipment
],
"unplannedShipments": [Shipment]
}
}
}
getCheckoutSession
Response
Returns a SubscriptionCheckoutSession!
Example
Query
mutation GetCheckoutSession {
getCheckoutSession {
url
}
}
Response
{
"data": {
"getCheckoutSession": {"url": "xyz789"}
}
}
getSubscriptionPortalSession
Response
Returns a SubscriptionPortalSession!
Example
Query
mutation GetSubscriptionPortalSession {
getSubscriptionPortalSession {
url
}
}
Response
{
"data": {
"getSubscriptionPortalSession": {
"url": "xyz789"
}
}
}
installExtension
Response
Returns an ExtensionInstallWithRedirectUrl!
Arguments
| Name | Description |
|---|---|
configurationValues - [ExtensionConfigurationValueInput!]!
|
|
extensionId - String!
|
Example
Query
mutation InstallExtension(
$configurationValues: [ExtensionConfigurationValueInput!]!,
$extensionId: String!
) {
installExtension(
configurationValues: $configurationValues,
extensionId: $extensionId
) {
configurationValues {
name
value
}
extension {
_id
category
configurationDefinitions {
...ExtensionConfigurationDefinitionFragment
}
coverImage
description
name
settings {
...ExtensionSettingsFragment
}
websiteUrl
}
installedAt
installedBy
redirectUrl
}
}
Variables
{
"configurationValues": [
ExtensionConfigurationValueInput
],
"extensionId": "xyz789"
}
Response
{
"data": {
"installExtension": {
"configurationValues": [
ExtensionConfigurationValue
],
"extension": Extension,
"installedAt": "2007-12-03T10:15:30Z",
"installedBy": "abc123",
"redirectUrl": "abc123"
}
}
}
lockOrder
multipleDocumentSignedUrl
Response
Returns [DocumentSignedUrl!]!
Arguments
| Name | Description |
|---|---|
newMultiDocumentSignedUrl - MultiDocumentSignedUrlInput!
|
Example
Query
mutation MultipleDocumentSignedUrl($newMultiDocumentSignedUrl: MultiDocumentSignedUrlInput!) {
multipleDocumentSignedUrl(newMultiDocumentSignedUrl: $newMultiDocumentSignedUrl) {
key
url
}
}
Variables
{"newMultiDocumentSignedUrl": MultiDocumentSignedUrlInput}
Response
{
"data": {
"multipleDocumentSignedUrl": [
{
"key": "abc123",
"url": "abc123"
}
]
}
}
persistTractorPositions
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - String!
|
|
positions - [TractorPositionInput!]!
|
Example
Query
mutation PersistTractorPositions(
$id: String!,
$positions: [TractorPositionInput!]!
) {
persistTractorPositions(
id: $id,
positions: $positions
)
}
Variables
{
"id": "abc123",
"positions": [TractorPositionInput]
}
Response
{"data": {"persistTractorPositions": false}}
planTripsForDriver
Response
Returns [Trip!]!
Arguments
| Name | Description |
|---|---|
additionalTrailerIds - [ObjectId!]
|
|
driverId - ObjectId!
|
|
planTimezone - String
|
|
tractorId - ObjectId
|
|
trailerId - ObjectId
|
|
trips - [TripForPlanningInput!]!
|
Example
Query
mutation PlanTripsForDriver(
$additionalTrailerIds: [ObjectId!],
$driverId: ObjectId!,
$planTimezone: String,
$tractorId: ObjectId,
$trailerId: ObjectId,
$trips: [TripForPlanningInput!]!
) {
planTripsForDriver(
additionalTrailerIds: $additionalTrailerIds,
driverId: $driverId,
planTimezone: $planTimezone,
tractorId: $tractorId,
trailerId: $trailerId,
trips: $trips
) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{
"additionalTrailerIds": [ObjectId],
"driverId": ObjectId,
"planTimezone": "abc123",
"tractorId": ObjectId,
"trailerId": ObjectId,
"trips": [TripForPlanningInput]
}
Response
{
"data": {
"planTripsForDriver": [
{
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 123.45,
"distanceToEnd": 987.65,
"distanceToStart": 123.45,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 123.45,
"payments": [TripPayment],
"polyline": "abc123",
"predictedLoadedDistance": 987.65,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 123.45,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "xyz789",
"violations": [TripViolation]
}
]
}
}
purgeForecastedOrders
rankSupplierContractsForPurchase
Response
Returns [SupplierContractRanking!]!
Arguments
| Name | Description |
|---|---|
purchase - PurchaseInput!
|
Example
Query
mutation RankSupplierContractsForPurchase($purchase: PurchaseInput!) {
rankSupplierContractsForPurchase(purchase: $purchase) {
costPerMile
mileage
productCost
quantity
shippingCost
supplierContract {
_id
allocation {
...SupplierContractAllocationFragment
}
conditions {
...SupplierContractConditionFragment
}
contractNumber
customer {
...BusinessEntityFragment
}
customerId
endDate
goodProfile {
...GoodProfileFragment
}
goodProfileId
pinCode
shipper {
...BusinessEntityFragment
}
shipperId
startDate
supplier {
...BusinessEntityFragment
}
supplierId
unitPrice
usedAllocation {
...SupplierContractAllocationFragment
}
}
totalCost
unitPrice
}
}
Variables
{"purchase": PurchaseInput}
Response
{
"data": {
"rankSupplierContractsForPurchase": [
{
"costPerMile": 987.65,
"mileage": 123.45,
"productCost": 987.65,
"quantity": 987.65,
"shippingCost": 987.65,
"supplierContract": SupplierContract,
"totalCost": 123.45,
"unitPrice": 123.45
}
]
}
}
rankSupplierContractsForPurchases
Response
Returns [SupplierContractRanking!]!
Arguments
| Name | Description |
|---|---|
purchases - [PurchaseInput!]!
|
Example
Query
mutation RankSupplierContractsForPurchases($purchases: [PurchaseInput!]!) {
rankSupplierContractsForPurchases(purchases: $purchases) {
costPerMile
mileage
productCost
quantity
shippingCost
supplierContract {
_id
allocation {
...SupplierContractAllocationFragment
}
conditions {
...SupplierContractConditionFragment
}
contractNumber
customer {
...BusinessEntityFragment
}
customerId
endDate
goodProfile {
...GoodProfileFragment
}
goodProfileId
pinCode
shipper {
...BusinessEntityFragment
}
shipperId
startDate
supplier {
...BusinessEntityFragment
}
supplierId
unitPrice
usedAllocation {
...SupplierContractAllocationFragment
}
}
totalCost
unitPrice
}
}
Variables
{"purchases": [PurchaseInput]}
Response
{
"data": {
"rankSupplierContractsForPurchases": [
{
"costPerMile": 123.45,
"mileage": 987.65,
"productCost": 123.45,
"quantity": 987.65,
"shippingCost": 123.45,
"supplierContract": SupplierContract,
"totalCost": 987.65,
"unitPrice": 987.65
}
]
}
}
removeShipmentFromTrip
Response
Returns a RemoveShipmentFromTripResult!
Arguments
| Name | Description |
|---|---|
shipmentIds - [ObjectId!]!
|
|
tripId - ObjectId!
|
Example
Query
mutation RemoveShipmentFromTrip(
$shipmentIds: [ObjectId!]!,
$tripId: ObjectId!
) {
removeShipmentFromTrip(
shipmentIds: $shipmentIds,
tripId: $tripId
) {
trip {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{
"shipmentIds": [ObjectId],
"tripId": ObjectId
}
Response
{"data": {"removeShipmentFromTrip": {"trip": Trip}}}
reportShipmentIssue
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
shipmentIssueData - ShipmentIssueInput!
|
Example
Query
mutation ReportShipmentIssue($shipmentIssueData: ShipmentIssueInput!) {
reportShipmentIssue(shipmentIssueData: $shipmentIssueData) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"shipmentIssueData": ShipmentIssueInput}
Response
{
"data": {
"reportShipmentIssue": {
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": true,
"isFromSplit": false,
"isSplit": true,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
restoreLatestSnapshot
Response
Returns a Boolean!
Example
Query
mutation RestoreLatestSnapshot {
restoreLatestSnapshot
}
Response
{"data": {"restoreLatestSnapshot": false}}
restoreShipment
Example
Query
mutation RestoreShipment($id: String!) {
restoreShipment(id: $id) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"restoreShipment": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": true,
"isFromSplit": true,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["abc123"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
saveDataSnapshot
Response
Returns a Snapshot!
Example
Query
mutation SaveDataSnapshot {
saveDataSnapshot {
_id
date
}
}
Response
{
"data": {
"saveDataSnapshot": {
"_id": "abc123",
"date": "2007-12-03T10:15:30Z"
}
}
}
saveOrganizationSettings
Response
Returns an OrganizationSettings
Arguments
| Name | Description |
|---|---|
newOrganizationSettingsData - OrganizationSettingsInput!
|
Example
Query
mutation SaveOrganizationSettings($newOrganizationSettingsData: OrganizationSettingsInput!) {
saveOrganizationSettings(newOrganizationSettingsData: $newOrganizationSettingsData) {
_id
dispatching {
canChangeTripOrder
canConsolidateInProgressShipments
canDriverSetAlternateSupplierPinCode
canUseAdHocAddress
enableCapacityWarnings
}
general {
currency
driversCanSeeFutureTrips
language
measurementSystem
singleClickTripCompletion
useSimpleWorkflow
weekStartsOn
}
invoicing {
companyAddress
companyEmail
companyPhone
enableConsolidatedInvoicing
enableTaxRate
logoUrl
prefix
primaryColor
processes
receiverDocumentationBodyTemplate
receiverDocumentationSubjectTemplate
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
showLoadedDeliveredQuantities
}
name
ratecon {
bodyTemplate
companyAddress
companyEmail
companyPhone
subjectTemplate
termsAndConditions
}
transactionTemplates {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
}
}
Variables
{"newOrganizationSettingsData": OrganizationSettingsInput}
Response
{
"data": {
"saveOrganizationSettings": {
"_id": "abc123",
"dispatching": DispatchingSettings,
"general": GeneralSettings,
"invoicing": InvoicingSettings,
"name": "xyz789",
"ratecon": RateconSettings,
"transactionTemplates": [TransactionInputObject]
}
}
}
saveTrip
Response
Returns a Trip!
Arguments
| Name | Description |
|---|---|
saveTripData - SaveTripInput!
|
Example
Query
mutation SaveTrip($saveTripData: SaveTripInput!) {
saveTrip(saveTripData: $saveTripData) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{"saveTripData": SaveTripInput}
Response
{
"data": {
"saveTrip": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 987.65,
"distanceToStart": 123.45,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 987.65,
"routeDistance": 123.45,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["abc123"],
"totalDistance": 987.65,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
}
}
sendInvoice
Example
Query
mutation SendInvoice($invoiceId: String!) {
sendInvoice(invoiceId: $invoiceId) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{"invoiceId": "xyz789"}
Response
{
"data": {
"sendInvoice": {
"_id": "xyz789",
"charges": [ShipmentCharge],
"closingNote": "abc123",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "abc123",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 987.65,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 123.45
}
}
}
sendRatecon
Response
Returns a SendRateconResult!
Arguments
| Name | Description |
|---|---|
tripId - String!
|
Example
Query
mutation SendRatecon($tripId: String!) {
sendRatecon(tripId: $tripId) {
success
}
}
Variables
{"tripId": "abc123"}
Response
{"data": {"sendRatecon": {"success": false}}}
sendReportPdf
Response
Returns a SendReportResult!
Arguments
| Name | Description |
|---|---|
email - String!
|
|
filter - ReportFilter
|
|
lang - String!
|
|
period - PeriodInput!
|
|
reportType - ReportType!
|
|
timezone - String!
|
Example
Query
mutation SendReportPdf(
$email: String!,
$filter: ReportFilter,
$lang: String!,
$period: PeriodInput!,
$reportType: ReportType!,
$timezone: String!
) {
sendReportPdf(
email: $email,
filter: $filter,
lang: $lang,
period: $period,
reportType: $reportType,
timezone: $timezone
) {
success
}
}
Variables
{
"email": "xyz789",
"filter": ReportFilter,
"lang": "xyz789",
"period": PeriodInput,
"reportType": "CUSTOMER_REVENUE",
"timezone": "xyz789"
}
Response
{"data": {"sendReportPdf": {"success": true}}}
setupOrganization
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
organizationSetupData - NewOrganizationInput!
|
Example
Query
mutation SetupOrganization($organizationSetupData: NewOrganizationInput!) {
setupOrganization(organizationSetupData: $organizationSetupData)
}
Variables
{"organizationSetupData": NewOrganizationInput}
Response
{"data": {"setupOrganization": "abc123"}}
splitShipment
Response
Returns [Shipment!]
Arguments
| Name | Description |
|---|---|
locations - [SplitShipmentLocationInput!]!
|
|
shipmentId - String!
|
Example
Query
mutation SplitShipment(
$locations: [SplitShipmentLocationInput!]!,
$shipmentId: String!
) {
splitShipment(
locations: $locations,
shipmentId: $shipmentId
) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{
"locations": [SplitShipmentLocationInput],
"shipmentId": "xyz789"
}
Response
{
"data": {
"splitShipment": [
{
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": true,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "abc123",
"referenceNumbers": ["xyz789"],
"rotationIndex": 123.45,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
]
}
}
startTrip
Response
Returns a Trip!
Arguments
| Name | Description |
|---|---|
startTripData - StartTripInput!
|
Example
Query
mutation StartTrip($startTripData: StartTripInput!) {
startTrip(startTripData: $startTripData) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{"startTripData": StartTripInput}
Response
{
"data": {
"startTrip": {
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 123.45,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "abc123",
"predictedLoadedDistance": 123.45,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 987.65,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
}
}
uninstallExtension
updateAccountStatus
Example
Query
mutation UpdateAccountStatus(
$enabled: Boolean!,
$id: String!
) {
updateAccountStatus(
enabled: $enabled,
id: $id
)
}
Variables
{"enabled": false, "id": "xyz789"}
Response
{"data": {"updateAccountStatus": true}}
updateDriverSettlementStatus
Response
Returns a DriverSettlement
Arguments
| Name | Description |
|---|---|
driverSettlementId - String!
|
|
status - DriverSettlementStatus!
|
Example
Query
mutation UpdateDriverSettlementStatus(
$driverSettlementId: String!,
$status: DriverSettlementStatus!
) {
updateDriverSettlementStatus(
driverSettlementId: $driverSettlementId,
status: $status
) {
_id
deductions {
_id
amount
date
deductionRule {
...DeductionRuleFragment
}
label
type
}
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverSettlementNumber
endDate
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
pdfDocument {
error
isGenerating
url
}
startDate
status
trips {
_id
additionalTrailers {
...TrailerFragment
}
carrier {
...BusinessEntityFragment
}
chassis {
...ChassisFragment
}
customFields {
...CustomFieldFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
...DriverFragment
}
driverPositions {
...TripDriverPositionFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
...CoordinatesFragment
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
...LoadStateFragment
}
loadedDistance
payments {
...TripPaymentFragment
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
shipments {
...ShipmentFragment
}
status
tags
totalDistance
tractor {
...TractorFragment
}
trailer {
...TrailerFragment
}
trailerCompartmentAssignments {
...TrailerCompartmentAssignmentFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
}
}
Variables
{
"driverSettlementId": "abc123",
"status": "CANCELLED"
}
Response
{
"data": {
"updateDriverSettlementStatus": {
"_id": "abc123",
"deductions": [Deduction],
"driver": Driver,
"driverSettlementNumber": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"payments": [TripPayment],
"pdfDocument": DriverSettlementPdf,
"startDate": "2007-12-03T10:15:30Z",
"status": "CANCELLED",
"trips": [Trip]
}
}
}
updateGoodDeliveredQuantity
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
input - UpdateGoodDeliveredQuantityInput!
|
Example
Query
mutation UpdateGoodDeliveredQuantity($input: UpdateGoodDeliveredQuantityInput!) {
updateGoodDeliveredQuantity(input: $input) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"input": UpdateGoodDeliveredQuantityInput}
Response
{
"data": {
"updateGoodDeliveredQuantity": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": true,
"isFromSplit": false,
"isSplit": false,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "xyz789",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["abc123"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
}
}
updateGoodLoadedQuantity
Response
Returns a Shipment!
Arguments
| Name | Description |
|---|---|
input - UpdateGoodLoadedQuantityInput!
|
Example
Query
mutation UpdateGoodLoadedQuantity($input: UpdateGoodLoadedQuantityInput!) {
updateGoodLoadedQuantity(input: $input) {
_id
additionalTrailerTypes
assignedCarriers {
accepted
idCarrier
}
billOfLadingNumber
billOfLadingNumbers
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
childShipmentIds
commodityType
constraints {
type
unit
value
}
createdBy
customFields {
key
value
}
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
dailyRotationCount
documents {
_id
accessLevel
associatedCharge
createdAt
createdBy
isBillable
lastUpdatedBy
name
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
type
updatedAt
url
}
events {
_id
coordinates {
...CoordinatesFragment
}
createdBy
date
description
label
metadata
shipmentLocation
tripShipmentLocation
type
}
expenses {
_id
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
type
unit
unitType
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
_id
attachedDocuments
content
coordinates {
...CoordinatesFragment
}
createdBy
date
delayAmount
shipmentLocation
type
}
loadType
notes {
_id
accessLevel
content
createdAt
createdBy
lastUpdatedBy
receiver {
...BusinessEntityFragment
}
shipper {
...BusinessEntityFragment
}
updatedAt
}
order {
_id
customer {
...BusinessEntityFragment
}
customerId
locations {
...ShipmentLocationFragment
}
orderNumber
shipment {
...ShipmentFragment
}
shipmentId
status
}
orderId
parentShipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
_id
byhour
byminute
bymonth
bymonthday
bynmonthday
bysecond
bysetpos
byweekday {
...ShipmentRecurrenceWeekdayFragment
}
byweekno
byyearday
count
dtstart
freq
interval
tzid
until
}
referenceNumber
referenceNumbers
rotationIndex
route {
distanceToEnd
distanceToStart
firstPickupTime
lastDropoffTime
locations {
...TripShipmentLocationFragment
}
predictedLoadedDistance
routeDistance
violations {
...TripViolationFragment
}
}
shipmentLocations {
_id
addressLabel
addressTimezone
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
weatherInfo {
...LocationWeatherFragment
}
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
_id
additionalTrailers
carrier
carrierEntity {
...CarrierFragment
}
deadheadDistance
distanceToEnd
distanceToStart
driver
driverEntity {
...DriverFragment
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
loadedDistance
polyline
routeDistance
shipmentLocations {
...TripShipmentLocationFragment
}
status
totalDistance
tractor
tractorEntity {
...TractorFragment
}
trailer
trailerEntity {
...TrailerFragment
}
tripNumber
violations {
...TripViolationFragment
}
}
tripId
}
}
Variables
{"input": UpdateGoodLoadedQuantityInput}
Response
{
"data": {
"updateGoodLoadedQuantity": {
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["xyz789"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "abc123",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": false,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": true,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "abc123",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"ticketNumbers": ["xyz789"],
"trackingEmailsSent": false,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "xyz789"
}
}
}
updateInvoiceStatus
Response
Returns an Invoice
Arguments
| Name | Description |
|---|---|
closingNote - String
|
|
invoiceId - String!
|
|
paidAmount - Float
|
|
status - InvoiceStatus!
|
Example
Query
mutation UpdateInvoiceStatus(
$closingNote: String,
$invoiceId: String!,
$paidAmount: Float,
$status: InvoiceStatus!
) {
updateInvoiceStatus(
closingNote: $closingNote,
invoiceId: $invoiceId,
paidAmount: $paidAmount,
status: $status
) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{
"closingNote": "abc123",
"invoiceId": "abc123",
"paidAmount": 987.65,
"status": "CANCELLED"
}
Response
{
"data": {
"updateInvoiceStatus": {
"_id": "xyz789",
"charges": [ShipmentCharge],
"closingNote": "xyz789",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "abc123",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 987.65,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 123.45
}
}
}
updateInvoiceTaxRate
Example
Query
mutation UpdateInvoiceTaxRate(
$invoiceId: String!,
$taxRate: Float
) {
updateInvoiceTaxRate(
invoiceId: $invoiceId,
taxRate: $taxRate
) {
_id
charges {
_id
billingRule {
...BillingRuleFragment
}
chargeType
customFields {
...CustomFieldFragment
}
document {
...TransactionDocumentFragment
}
label
number
rate
reimburseToDriver
relatedTransactionId
shipmentId
taxable
total
type
unit
unitType
}
closingNote
customer {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
groupIds
invoiceNumber
missingRequiredDocuments {
attachToInvoice
documentName
documentType
requiredForInvoicing
}
paidAmount
payments {
_id
amount
date
note
paymentMethod
}
pdfDocument {
error
isGenerating
url
}
shipment {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
shipmentIds
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
taxRate
}
}
Variables
{"invoiceId": "xyz789", "taxRate": 123.45}
Response
{
"data": {
"updateInvoiceTaxRate": {
"_id": "abc123",
"charges": [ShipmentCharge],
"closingNote": "abc123",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "abc123",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 987.65,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 123.45
}
}
}
updateMyAccount
Response
Returns an OrgUser!
Arguments
| Name | Description |
|---|---|
accountData - UpdateAccountInput!
|
Example
Query
mutation UpdateMyAccount($accountData: UpdateAccountInput!) {
updateMyAccount(accountData: $accountData) {
_id
attributes {
customFields
driverId
freshchatRestoreId
phoneNumber
phoneNumberVerified
promoCode
tags
trialDays
}
email
enabled
firstName
id
lastName
roles {
id
name
}
username
}
}
Variables
{"accountData": UpdateAccountInput}
Response
{
"data": {
"updateMyAccount": {
"_id": "abc123",
"attributes": UserAttributes,
"email": "xyz789",
"enabled": false,
"firstName": "xyz789",
"id": "abc123",
"lastName": "xyz789",
"roles": [KeycloakUserRole],
"username": "xyz789"
}
}
}
updatePassword
Example
Query
mutation UpdatePassword(
$id: String!,
$temporaryPassword: String!
) {
updatePassword(
id: $id,
temporaryPassword: $temporaryPassword
)
}
Variables
{
"id": "xyz789",
"temporaryPassword": "xyz789"
}
Response
{"data": {"updatePassword": false}}
updateTripOrder
Response
Returns a Trip
Arguments
| Name | Description |
|---|---|
updateTripOrderData - UpdateTripOrderInput!
|
Example
Query
mutation UpdateTripOrder($updateTripOrderData: UpdateTripOrderInput!) {
updateTripOrder(updateTripOrderData: $updateTripOrderData) {
_id
additionalTrailers {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
carrier {
_id
accessToken
additionalContacts {
...ContactFragment
}
additionalTypes
address {
...AddressFragment
}
addressTimezone
billingAddress {
...TextualAddressFragment
}
billingEmail
billingInvoiceConsolidationCriteria
billingTermsDay
billingWeekStartsOn
code
contact {
...ContactFragment
}
creditTerms
customFields {
...CustomFieldFragment
}
defaultReferenceNumbers {
...DefaultReferenceNumberFragment
}
defaultShipper {
...BusinessEntityFragment
}
defaultShipperId
documentRequirements {
...DocumentRequirementFragment
}
documents {
...DocumentFragment
}
dotNumber
externalId
federalId
goodInventoryItems {
...GoodInventoryItemFragment
}
groupIds
mcNumber
name
notes {
...BusinessEntityNoteFragment
}
openingSchedules {
...OpeningScheduleFragment
}
parentBusinessEntity {
...BusinessEntityFragment
}
parentBusinessEntityId
payToProfile {
...BusinessEntityFragment
}
payToProfileId
referenceNumberTypes
remitAddress {
...TextualAddressFragment
}
remitCompanyName
remitEmail
shipmentDocumentsToReceive
standardCarrierAlphaCode
status
storageFacilities {
...StorageFacilityFragment
}
tags
trailerTypes
type
}
chassis {
_id
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
serialNumber
status
}
customFields {
key
value
}
deadheadDistance
distanceToEnd
distanceToStart
driver {
_id
customFields {
...CustomFieldFragment
}
dateOfBirth
dateOfPhysicalExamination
documents {
...DriverDocumentFragment
}
domicile {
...AddressFragment
}
domicileEntity {
...BusinessEntityFragment
}
domicileId
eldId
firstname
groupIds
hos {
...DriverHosFragment
}
isOwnerOperator
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
lastname
license {
...DriverLicenseFragment
}
medical {
...DriverMedicalFragment
}
middlename
phoneNumber
status
tags
userId
}
driverPositions {
activity {
...ActivityFragment
}
battery {
...BatteryFragment
}
coords {
...CoordinatesFragment
}
event
extras {
...ExtrasFragment
}
is_moving
odometer
timestamp
trip
uuid
}
etaFromPreviousTrip
etaToNextTrip
firstPickupTime
lastDropoffTime
lastTrafficCheck
lastTrailerLocation {
altitude
heading
latitude
longitude
speed
}
lastTrailerLocationDate
lastWeatherCheck
loadStates {
distance
endPosition {
...TripDriverPositionFragment
}
event {
...ShipmentEventFragment
}
goods {
...GoodFragment
}
startDate
startPosition {
...TripDriverPositionFragment
}
}
loadedDistance
payments {
_id
label
paymentRule {
...PaymentRuleFragment
}
rate
trip
unit
unitType
}
polyline
predictedLoadedDistance
routeDistance
shipmentLocations {
_id
addressLabel
addressTimezone
arrivalTime
distanceTo
location {
...CoordinatesFragment
}
locationType
name
receivedGoods {
...GoodDistributionFragment
}
receiver {
...BusinessEntityFragment
}
rotationIndex
serviceDuration
setupDuration
shipmentId
shippedGoods {
...GoodFragment
}
shipper {
...BusinessEntityFragment
}
timeWindows {
...DateTimeWindowFragment
}
trafficInfo {
...LocationTrafficFragment
}
tripShipmentLocationId
waitingDuration
weatherInfo {
...LocationWeatherFragment
}
}
shipments {
_id
additionalTrailerTypes
assignedCarriers {
...ShipmentCarrierAssignmentFragment
}
billOfLadingNumber
billOfLadingNumbers
charges {
...ShipmentChargeFragment
}
childShipmentIds
commodityType
constraints {
...ShipmentConstraintFragment
}
createdBy
customFields {
...CustomFieldFragment
}
customer {
...BusinessEntityFragment
}
dailyRotationCount
documents {
...ShipmentDocumentFragment
}
events {
...ShipmentEventFragment
}
expenses {
...TransactionFragment
}
groupIds
isApplicableChargeOrderCancellation
isFromRotation
isFromSplit
isSplit
issues {
...ShipmentIssueFragment
}
loadType
notes {
...ShipmentNoteFragment
}
order {
...OrderFragment
}
orderId
parentShipment {
...ShipmentFragment
}
postOfficeNumber
purchaseOrderNumbers
rateConNumbers
reasonForCancellation
recurrence {
...ShipmentRecurrenceFragment
}
referenceNumber
referenceNumbers
rotationIndex
route {
...ShipmentRouteFragment
}
shipmentLocations {
...ShipmentLocationFragment
}
shipmentNumber
status
tags
ticketNumbers
trackingEmailsSent
trailerType
trip {
...ShipmentTripFragment
}
tripId
}
status
tags
totalDistance
tractor {
_id
currentDriverEldId
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
eldId
groupIds
lastKnownEldLocation {
...CoordinatesFragment
}
lastKnownEldLocationDate
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
licenseNumber
make
mileage
model
plateNumber
serialNumber
status
tags
tareWeight
year
}
trailer {
_id
compartments {
...TrailerCompartmentFragment
}
customFields {
...CustomFieldFragment
}
documents {
...DocumentFragment
}
domicile {
...AddressFragment
}
groupIds
height
lastKnownLocation {
...CoordinatesFragment
}
lastKnownLocationDate
length
licenseNumber
maxTemperature
maxWeight
mileage
minTemperature
numberOfAxles
serial
serialNumber
status
tags
type
vin
width
}
trailerCompartmentAssignments {
commodityId
compartmentId
quantity
targetStorageFacilityId
trailerId
}
tripNumber
violations {
cause
duration
locationId
}
}
}
Variables
{"updateTripOrderData": UpdateTripOrderInput}
Response
{
"data": {
"updateTripOrder": {
"_id": "abc123",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 123.45,
"distanceToEnd": 123.45,
"distanceToStart": 987.65,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 987.65,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 987.65,
"routeDistance": 123.45,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["abc123"],
"totalDistance": 987.65,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "xyz789",
"violations": [TripViolation]
}
}
}
uploadStorageFacilityReadingsCsvData
Example
Query
mutation UploadStorageFacilityReadingsCsvData(
$data: JSON!,
$receiverId: ObjectId!
) {
uploadStorageFacilityReadingsCsvData(
data: $data,
receiverId: $receiverId
)
}
Variables
{"data": {}, "receiverId": ObjectId}
Response
{"data": {"uploadStorageFacilityReadingsCsvData": false}}
validateAssetCustomFields
Response
Returns [AssetCustomFieldError!]!
Arguments
| Name | Description |
|---|---|
assetId - ObjectId!
|
|
assetType - TripAssetTypes!
|
|
shipmentId - ObjectId!
|
Example
Query
mutation ValidateAssetCustomFields(
$assetId: ObjectId!,
$assetType: TripAssetTypes!,
$shipmentId: ObjectId!
) {
validateAssetCustomFields(
assetId: $assetId,
assetType: $assetType,
shipmentId: $shipmentId
) {
assetId
assetType
isRequired
message
}
}
Variables
{
"assetId": ObjectId,
"assetType": "ADDITIONAL_TRAILERS",
"shipmentId": ObjectId
}
Response
{
"data": {
"validateAssetCustomFields": [
{
"assetId": "abc123",
"assetType": "abc123",
"isRequired": true,
"message": "xyz789"
}
]
}
}
validateTripOrder
Response
Returns [TripViolation!]
Arguments
| Name | Description |
|---|---|
validateTripOrderData - UpdateTripOrderInput!
|
Example
Query
mutation ValidateTripOrder($validateTripOrderData: UpdateTripOrderInput!) {
validateTripOrder(validateTripOrderData: $validateTripOrderData) {
cause
duration
locationId
}
}
Variables
{"validateTripOrderData": UpdateTripOrderInput}
Response
{
"data": {
"validateTripOrder": [
{
"cause": "BREAK_DELAY",
"duration": 987.65,
"locationId": "xyz789"
}
]
}
}
Types
Activity
Address
Description
Address with coordinates
Example
{
"city": "xyz789",
"coordinates": Coordinates,
"country": "xyz789",
"googlePlaceId": "abc123",
"label": "abc123",
"line1": "xyz789",
"line2": "xyz789",
"postalCode": "abc123",
"state": "abc123"
}
AssetCustomFieldError
AssetLinking
Example
{
"_id": "abc123",
"additionalTrailers": [Trailer],
"driver": Driver,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": false,
"startDate": "2007-12-03T10:15:30Z",
"tractor": Tractor,
"trailer": Trailer
}
AssetLinkingInput
Example
{
"additionalTrailers": [ObjectId],
"driver": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": true,
"startDate": "2007-12-03T10:15:30Z",
"tractor": ObjectId,
"trailer": ObjectId
}
AssetLinkingPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [AssetLinking!]!
|
Example
{"count": 987, "data": [AssetLinking]}
AssetLinkingUpdateInput
Example
{
"additionalTrailers": [ObjectId],
"driver": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"isHardLinked": false,
"startDate": "2007-12-03T10:15:30Z",
"tractor": ObjectId,
"trailer": ObjectId
}
AssetStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
AverageSales
Battery
BillingMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FLAT_FEE"
BillingRate
Description
A billing rate
Fields
| Field Name | Description |
|---|---|
amount - Float!
|
|
label - String
|
|
method - BillingMethod!
|
|
parameters - [BillingRateParameter!]
|
|
referenceNumber - String
|
Example
{
"amount": 987.65,
"label": "abc123",
"method": "FLAT_FEE",
"parameters": [BillingRateParameter],
"referenceNumber": "xyz789"
}
BillingRateInput
Fields
| Input Field | Description |
|---|---|
amount - Float!
|
|
label - String
|
|
method - BillingMethod!
|
|
parameters - [BillingRateParameterInput!]
|
|
referenceNumber - String
|
Example
{
"amount": 123.45,
"label": "abc123",
"method": "FLAT_FEE",
"parameters": [BillingRateParameterInput],
"referenceNumber": "abc123"
}
BillingRateParameter
Fields
| Field Name | Description |
|---|---|
type - BillingRateParameterType!
|
|
value - ConditionValue
|
Example
{"type": "FREE_LOCATION_COUNT", "value": ConditionValue}
BillingRateParameterInput
Fields
| Input Field | Description |
|---|---|
type - BillingRateParameterType!
|
|
value - ConditionValue
|
Example
{"type": "FREE_LOCATION_COUNT", "value": ConditionValue}
BillingRateParameterType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FREE_LOCATION_COUNT"
BillingRule
Description
A customer billing rule
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
amount - Float
|
Use rates instead |
condition - BillingRuleCondition!
|
Use conditions instead |
conditions - [BillingRuleCondition!]!
|
|
customer - BusinessEntity
|
|
label - String
|
|
method - BillingMethod
|
Use rates instead |
priority - Float
|
|
rates - [BillingRate!]
|
|
referenceNumber - String
|
|
type - BillingRuleType!
|
Example
{
"_id": "abc123",
"amount": 123.45,
"condition": BillingRuleCondition,
"conditions": [BillingRuleCondition],
"customer": BusinessEntity,
"label": "abc123",
"method": "FLAT_FEE",
"priority": 123.45,
"rates": [BillingRate],
"referenceNumber": "abc123",
"type": "ACCESSORIAL"
}
BillingRuleCondition
Fields
| Field Name | Description |
|---|---|
operator - BillingRuleConditionOperator!
|
|
parameters - [BillingRuleConditionParameter!]
|
|
target - BillingRuleConditionTarget!
|
|
value - ConditionValue
|
Example
{
"operator": "EQUALS",
"parameters": [BillingRuleConditionParameter],
"target": "CUSTOMER_STATE",
"value": ConditionValue
}
BillingRuleConditionInput
Fields
| Input Field | Description |
|---|---|
operator - BillingRuleConditionOperator!
|
|
parameters - [BillingRuleConditionParameterInput!]
|
|
target - BillingRuleConditionTarget!
|
|
value - ConditionValue
|
Example
{
"operator": "EQUALS",
"parameters": [BillingRuleConditionParameterInput],
"target": "CUSTOMER_STATE",
"value": ConditionValue
}
BillingRuleConditionOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQUALS"
BillingRuleConditionParameter
Fields
| Field Name | Description |
|---|---|
type - BillingRuleConditionParameterType!
|
|
value - ConditionValue
|
Example
{"type": "FUEL_COST_AREA", "value": ConditionValue}
BillingRuleConditionParameterInput
Fields
| Input Field | Description |
|---|---|
type - BillingRuleConditionParameterType!
|
|
value - ConditionValue
|
Example
{"type": "FUEL_COST_AREA", "value": ConditionValue}
BillingRuleConditionParameterType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FUEL_COST_AREA"
BillingRuleConditionTarget
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOMER_STATE"
BillingRulePaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [BillingRule!]!
|
Example
{"count": 987, "data": [BillingRule]}
BillingRuleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCESSORIAL"
BillingRuleUpdateInput
Fields
| Input Field | Description |
|---|---|
amount - Float
|
|
condition - BillingRuleConditionInput
|
|
conditions - [BillingRuleConditionInput!]
|
|
customer - String
|
|
label - String
|
|
method - BillingMethod
|
|
priority - Float
|
|
rates - [BillingRateInput!]
|
|
referenceNumber - String
|
|
type - BillingRuleType
|
Example
{
"amount": 987.65,
"condition": BillingRuleConditionInput,
"conditions": [BillingRuleConditionInput],
"customer": "xyz789",
"label": "abc123",
"method": "FLAT_FEE",
"priority": 123.45,
"rates": [BillingRateInput],
"referenceNumber": "xyz789",
"type": "ACCESSORIAL"
}
Boolean
Description
The Boolean scalar type represents true or false.
Broker
Description
A Broker Business entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
accessToken - String
|
Token used for access to the customer portal |
additionalContacts - [Contact!]
|
Additional contacts for the business entity. |
additionalTypes - [BusinessEntityType!]
|
Additional types for the business entity (e.g. a business entity could be both a customer and shipper). |
address - Address!
|
Physical address of the business entity. |
addressTimezone - String
|
Timezone of the business entity address. If not provided, it will be inferred from the address. |
billingAddress - TextualAddress
|
Billing address for the business entity. |
billingEmail - String
|
Billing email for the business entity. Invoices are sent here |
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
Billing terms for the business entity in days. |
billingWeekStartsOn - Float
|
|
code - String
|
Unique code identifying the business entity. |
contact - Contact!
|
Primary contact for the business entity. |
creditTerms - String
|
For carriers only, the credit terms they offer. |
customFields - [CustomField!]
|
Custom fields for the business entity |
defaultReferenceNumbers - [DefaultReferenceNumber!]
|
|
defaultShipper - BusinessEntity
|
The default shipper for this business entity |
defaultShipperId - ObjectId
|
ID of the default shipper for this business entity. This is used by default when a shipment is sent to this business entity |
documentRequirements - [DocumentRequirement!]
|
Document requirements for invoicing for this business entity |
documents - [Document!]
|
Documents for the business entity |
dotNumber - String
|
DOT Number for carriers and brokers |
externalId - String
|
ID of the business entity in an external system. |
federalId - String
|
Federal ID for carriers |
goodInventoryItems - [GoodInventoryItem!]
|
|
groupIds - [ObjectId!]
|
IDs of the groups that this business entity belongs to |
mcNumber - String
|
MC Number for carriers |
name - String!
|
Legal name of the business entity. |
notes - [BusinessEntityNote!]
|
|
openingSchedules - [OpeningSchedule!]
|
Opening schedules for the business entity. |
parentBusinessEntity - BusinessEntity
|
The business entity that this business entity belongs to |
parentBusinessEntityId - ObjectId
|
ID of the business entity that this business entity belongs to. Used for receiver/customer relations for example |
payToProfile - BusinessEntity
|
The business entity that we need to pay to. Used for carriers |
payToProfileId - ObjectId
|
ID of the business entity that we need to pay to. Used for carriers |
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
For customers and brokers, the types of reference numbers they use in orders. |
remitAddress - TextualAddress
|
Remit address for the business entity. Where payments are sent. |
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
Remit email for the business entity |
shipmentDocumentsToReceive - [String!]
|
Shipmentp documents to receive via email on completion |
standardCarrierAlphaCode - String
|
SCAC code for carriers |
status - AssetStatus!
|
|
storageFacilities - [StorageFacility!]
|
Storage facilities for the business entity. Used for tanks, warehouses, etc |
Arguments
|
|
tags - [String!]
|
Tags for the business entity |
trailerTypes - [TrailerType!]
|
For carriers only, the types of trailers they have. |
type - BusinessEntityType!
|
The type of business entity. |
Example
{
"_id": "xyz789",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 987.65,
"code": "xyz789",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": ["abc123"],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
BrokerPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Broker!]!
|
Example
{"count": 987, "data": [Broker]}
BulkEditDriverInput
Fields
| Input Field | Description |
|---|---|
groupIds - [ObjectId!]
|
Example
{"groupIds": [ObjectId]}
BulkUpdateResult
BusinessEntity
Description
Business entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
accessToken - String
|
Token used for access to the customer portal |
additionalContacts - [Contact!]
|
Additional contacts for the business entity. |
additionalTypes - [BusinessEntityType!]
|
Additional types for the business entity (e.g. a business entity could be both a customer and shipper). |
address - Address!
|
Physical address of the business entity. |
addressTimezone - String
|
Timezone of the business entity address. If not provided, it will be inferred from the address. |
billingAddress - TextualAddress
|
Billing address for the business entity. |
billingEmail - String
|
Billing email for the business entity. Invoices are sent here |
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
Billing terms for the business entity in days. |
billingWeekStartsOn - Float
|
|
code - String
|
Unique code identifying the business entity. |
contact - Contact!
|
Primary contact for the business entity. |
creditTerms - String
|
For carriers only, the credit terms they offer. |
customFields - [CustomField!]
|
Custom fields for the business entity |
defaultReferenceNumbers - [DefaultReferenceNumber!]
|
|
defaultShipper - BusinessEntity
|
The default shipper for this business entity |
defaultShipperId - ObjectId
|
ID of the default shipper for this business entity. This is used by default when a shipment is sent to this business entity |
documentRequirements - [DocumentRequirement!]
|
Document requirements for invoicing for this business entity |
documents - [Document!]
|
Documents for the business entity |
dotNumber - String
|
DOT Number for carriers and brokers |
externalId - String
|
ID of the business entity in an external system. |
federalId - String
|
Federal ID for carriers |
goodInventoryItems - [GoodInventoryItem!]
|
|
groupIds - [ObjectId!]
|
IDs of the groups that this business entity belongs to |
mcNumber - String
|
MC Number for carriers |
name - String!
|
Legal name of the business entity. |
notes - [BusinessEntityNote!]
|
|
openingSchedules - [OpeningSchedule!]
|
Opening schedules for the business entity. |
parentBusinessEntity - BusinessEntity
|
The business entity that this business entity belongs to |
parentBusinessEntityId - ObjectId
|
ID of the business entity that this business entity belongs to. Used for receiver/customer relations for example |
payToProfile - BusinessEntity
|
The business entity that we need to pay to. Used for carriers |
payToProfileId - ObjectId
|
ID of the business entity that we need to pay to. Used for carriers |
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
For customers and brokers, the types of reference numbers they use in orders. |
remitAddress - TextualAddress
|
Remit address for the business entity. Where payments are sent. |
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
Remit email for the business entity |
shipmentDocumentsToReceive - [String!]
|
Shipmentp documents to receive via email on completion |
standardCarrierAlphaCode - String
|
SCAC code for carriers |
status - AssetStatus!
|
|
storageFacilities - [StorageFacility!]
|
Storage facilities for the business entity. Used for tanks, warehouses, etc |
Arguments
|
|
tags - [String!]
|
Tags for the business entity |
trailerTypes - [TrailerType!]
|
For carriers only, the types of trailers they have. |
type - BusinessEntityType!
|
The type of business entity. |
Example
{
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 123.45,
"code": "abc123",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "xyz789",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": ["abc123"],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
BusinessEntityNote
Fields
| Field Name | Description |
|---|---|
_id - ObjectId
|
|
accessLevel - [NoteAccessLevel!]
|
|
addToShipment - Boolean!
|
|
content - String!
|
Example
{
"_id": ObjectId,
"accessLevel": ["CARRIER"],
"addToShipment": true,
"content": "abc123"
}
BusinessEntityNoteInput
Fields
| Input Field | Description |
|---|---|
_id - ObjectId
|
|
accessLevel - [NoteAccessLevel!]
|
|
addToShipment - Boolean
|
|
content - String!
|
Example
{
"_id": ObjectId,
"accessLevel": ["CARRIER"],
"addToShipment": false,
"content": "xyz789"
}
BusinessEntityPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [BusinessEntity!]!
|
Example
{"count": 987, "data": [BusinessEntity]}
BusinessEntityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BROKER"
BusinessEntityUpdateInput
Fields
| Input Field | Description |
|---|---|
accessToken - String
|
|
additionalContacts - [NewContactInput!]
|
|
additionalTypes - [BusinessEntityType!]
|
|
address - NewAddressInput
|
|
billingAddress - NewTextualAddressInput
|
|
billingEmail - String
|
|
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
|
billingWeekStartsOn - Float
|
|
code - String
|
|
contact - NewContactInput
|
|
creditTerms - String
|
|
customFields - [CustomFieldInput!]
|
|
defaultReferenceNumbers - [DefaultReferenceNumberInput!]
|
|
defaultShipperId - ObjectId
|
|
documentRequirements - [DocumentRequirementInput!]
|
Document requirements for invoicing for this business entity |
documents - [DocumentInput!]
|
|
dotNumber - String
|
|
externalId - String
|
|
federalId - String
|
|
goodInventoryItems - [GoodInventoryItemInput!]
|
|
groupIds - [ObjectId!]
|
|
mcNumber - String
|
|
name - String
|
|
notes - [BusinessEntityNoteInput!]
|
|
openingSchedules - [OpeningScheduleInput!]
|
|
parentBusinessEntityId - ObjectId
|
|
payToProfileId - ObjectId
|
|
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
|
remitAddress - NewTextualAddressInput
|
|
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
|
shipmentDocumentsToReceive - [String!]
|
|
standardCarrierAlphaCode - String
|
|
status - AssetStatus
|
|
storageFacilities - [StorageFacilityInput!]
|
|
tags - [String!]
|
|
trailerTypes - [TrailerType!]
|
|
type - String
|
Example
{
"accessToken": "abc123",
"additionalContacts": [NewContactInput],
"additionalTypes": ["BROKER"],
"address": NewAddressInput,
"billingAddress": NewTextualAddressInput,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 123.45,
"code": "xyz789",
"contact": NewContactInput,
"creditTerms": "abc123",
"customFields": [CustomFieldInput],
"defaultReferenceNumbers": [
DefaultReferenceNumberInput
],
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirementInput],
"documents": [DocumentInput],
"dotNumber": "xyz789",
"externalId": "xyz789",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItemInput],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "xyz789",
"notes": [BusinessEntityNoteInput],
"openingSchedules": [OpeningScheduleInput],
"parentBusinessEntityId": ObjectId,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": NewTextualAddressInput,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": ["xyz789"],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacilityInput],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "abc123"
}
Carrier
Description
A Carrier Business entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
accessToken - String
|
Token used for access to the customer portal |
additionalContacts - [Contact!]
|
Additional contacts for the business entity. |
additionalTypes - [BusinessEntityType!]
|
Additional types for the business entity (e.g. a business entity could be both a customer and shipper). |
address - Address!
|
Physical address of the business entity. |
addressTimezone - String
|
Timezone of the business entity address. If not provided, it will be inferred from the address. |
billingAddress - TextualAddress
|
Billing address for the business entity. |
billingEmail - String
|
Billing email for the business entity. Invoices are sent here |
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
Billing terms for the business entity in days. |
billingWeekStartsOn - Float
|
|
code - String
|
Unique code identifying the business entity. |
contact - Contact!
|
Primary contact for the business entity. |
creditTerms - String
|
For carriers only, the credit terms they offer. |
customFields - [CustomField!]
|
Custom fields for the business entity |
defaultReferenceNumbers - [DefaultReferenceNumber!]
|
|
defaultShipper - BusinessEntity
|
The default shipper for this business entity |
defaultShipperId - ObjectId
|
ID of the default shipper for this business entity. This is used by default when a shipment is sent to this business entity |
documentRequirements - [DocumentRequirement!]
|
Document requirements for invoicing for this business entity |
documents - [Document!]
|
Documents for the business entity |
dotNumber - String
|
DOT Number for carriers and brokers |
externalId - String
|
ID of the business entity in an external system. |
federalId - String
|
Federal ID for carriers |
goodInventoryItems - [GoodInventoryItem!]
|
|
groupIds - [ObjectId!]
|
IDs of the groups that this business entity belongs to |
mcNumber - String
|
MC Number for carriers |
name - String!
|
Legal name of the business entity. |
notes - [BusinessEntityNote!]
|
|
openingSchedules - [OpeningSchedule!]
|
Opening schedules for the business entity. |
parentBusinessEntity - BusinessEntity
|
The business entity that this business entity belongs to |
parentBusinessEntityId - ObjectId
|
ID of the business entity that this business entity belongs to. Used for receiver/customer relations for example |
payToProfile - BusinessEntity
|
The business entity that we need to pay to. Used for carriers |
payToProfileId - ObjectId
|
ID of the business entity that we need to pay to. Used for carriers |
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
For customers and brokers, the types of reference numbers they use in orders. |
remitAddress - TextualAddress
|
Remit address for the business entity. Where payments are sent. |
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
Remit email for the business entity |
shipmentDocumentsToReceive - [String!]
|
Shipmentp documents to receive via email on completion |
standardCarrierAlphaCode - String
|
SCAC code for carriers |
status - AssetStatus!
|
|
storageFacilities - [StorageFacility!]
|
Storage facilities for the business entity. Used for tanks, warehouses, etc |
Arguments
|
|
tags - [String!]
|
Tags for the business entity |
trailerTypes - [TrailerType!]
|
For carriers only, the types of trailers they have. |
type - BusinessEntityType!
|
The type of business entity. |
Example
{
"_id": "abc123",
"accessToken": "xyz789",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "xyz789",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 987.65,
"code": "xyz789",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "xyz789",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "abc123",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": ["xyz789"],
"standardCarrierAlphaCode": "xyz789",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
ChangeTripStartTimeInput
Fields
| Input Field | Description |
|---|---|
etaFromPreviousTrip - Float
|
|
etaToNextTrip - Float
|
|
startTime - DateTime!
|
|
tripId - ObjectId!
|
|
violations - [TripViolationInput!]
|
Example
{
"etaFromPreviousTrip": 987.65,
"etaToNextTrip": 123.45,
"startTime": "2007-12-03T10:15:30Z",
"tripId": ObjectId,
"violations": [TripViolationInput]
}
ChargeType
Description
Different types of charges for a shipment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCESSORIAL"
Chassis
Description
A Chassis entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
lastKnownLocation - Coordinates
|
|
lastKnownLocationDate - DateTime
|
|
serialNumber - String!
|
|
status - AssetStatus!
|
Example
{
"_id": "abc123",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"serialNumber": "xyz789",
"status": "ACTIVE"
}
ChassisPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Chassis!]!
|
Example
{"count": 123, "data": [Chassis]}
ConditionValue
Description
The value for a billing rule condition
Example
ConditionValue
Contact
Description
Business entity contact
Example
{
"email": "abc123",
"extensionNumber": "xyz789",
"faxNumber": "abc123",
"firstname": "abc123",
"includeInInvoicing": false,
"lastname": "abc123",
"middlename": "xyz789",
"phoneNumber": "abc123",
"title": "abc123",
"url": "xyz789"
}
Coordinates
CoordinatesInput
Currency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CAD"
CustomField
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
value - CustomFieldValue
|
Example
{
"key": "abc123",
"value": CustomFieldValue
}
CustomFieldContext
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CARRIER"
CustomFieldDefinition
Description
Custom field
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
context - [CustomFieldContext!]!
|
|
description - String!
|
|
isRequirement - Boolean
|
|
key - String!
|
|
label - String!
|
|
requirementOptions - CustomFieldRequirementOptions
|
|
selectOptions - [CustomFieldSelectOption!]
|
|
selectOptionsEndpoint - String
|
|
selectOptionsEntity - CustomFieldSelectOptionEntity
|
|
type - CustomFieldType!
|
Example
{
"_id": "xyz789",
"context": ["CARRIER"],
"description": "abc123",
"isRequirement": true,
"key": "xyz789",
"label": "abc123",
"requirementOptions": CustomFieldRequirementOptions,
"selectOptions": [CustomFieldSelectOption],
"selectOptionsEndpoint": "abc123",
"selectOptionsEntity": "CARRIER",
"type": "BOOLEAN"
}
CustomFieldDefinitionPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [CustomFieldDefinition!]!
|
Example
{"count": 987, "data": [CustomFieldDefinition]}
CustomFieldDefinitionUpdateInput
Fields
| Input Field | Description |
|---|---|
context - [CustomFieldContext!]
|
|
description - String
|
|
isRequirement - Boolean
|
|
key - String
|
|
label - String
|
|
requirementOptions - CustomFieldRequirementOptionsInput
|
|
selectOptions - [CustomFieldSelectOptionInput!]
|
|
selectOptionsEndpoint - String
|
|
selectOptionsEntity - CustomFieldSelectOptionEntity
|
|
type - CustomFieldType
|
Example
{
"context": ["CARRIER"],
"description": "abc123",
"isRequirement": false,
"key": "xyz789",
"label": "abc123",
"requirementOptions": CustomFieldRequirementOptionsInput,
"selectOptions": [CustomFieldSelectOptionInput],
"selectOptionsEndpoint": "abc123",
"selectOptionsEntity": "CARRIER",
"type": "BOOLEAN"
}
CustomFieldInput
Fields
| Input Field | Description |
|---|---|
key - String!
|
|
value - CustomFieldValue
|
Example
{
"key": "xyz789",
"value": CustomFieldValue
}
CustomFieldRequirementOptions
CustomFieldRequirementOptionsInput
CustomFieldSelectOption
CustomFieldSelectOptionEntity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CARRIER"
CustomFieldSelectOptionInput
CustomFieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOOLEAN"
CustomFieldValue
Description
The value for a custom field
Example
CustomFieldValue
Customer
Description
A Customer Business entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
accessToken - String
|
Token used for access to the customer portal |
additionalContacts - [Contact!]
|
Additional contacts for the business entity. |
additionalTypes - [BusinessEntityType!]
|
Additional types for the business entity (e.g. a business entity could be both a customer and shipper). |
address - Address!
|
Physical address of the business entity. |
addressTimezone - String
|
Timezone of the business entity address. If not provided, it will be inferred from the address. |
billingAddress - TextualAddress
|
Billing address for the business entity. |
billingEmail - String
|
Billing email for the business entity. Invoices are sent here |
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
Billing terms for the business entity in days. |
billingWeekStartsOn - Float
|
|
code - String
|
Unique code identifying the business entity. |
contact - Contact!
|
Primary contact for the business entity. |
creditTerms - String
|
For carriers only, the credit terms they offer. |
customFields - [CustomField!]
|
Custom fields for the business entity |
defaultReferenceNumbers - [DefaultReferenceNumber!]
|
|
defaultShipper - BusinessEntity
|
The default shipper for this business entity |
defaultShipperId - ObjectId
|
ID of the default shipper for this business entity. This is used by default when a shipment is sent to this business entity |
documentRequirements - [DocumentRequirement!]
|
Document requirements for invoicing for this business entity |
documents - [Document!]
|
Documents for the business entity |
dotNumber - String
|
DOT Number for carriers and brokers |
externalId - String
|
ID of the business entity in an external system. |
federalId - String
|
Federal ID for carriers |
goodInventoryItems - [GoodInventoryItem!]
|
|
groupIds - [ObjectId!]
|
IDs of the groups that this business entity belongs to |
mcNumber - String
|
MC Number for carriers |
name - String!
|
Legal name of the business entity. |
notes - [BusinessEntityNote!]
|
|
openingSchedules - [OpeningSchedule!]
|
Opening schedules for the business entity. |
parentBusinessEntity - BusinessEntity
|
The business entity that this business entity belongs to |
parentBusinessEntityId - ObjectId
|
ID of the business entity that this business entity belongs to. Used for receiver/customer relations for example |
payToProfile - BusinessEntity
|
The business entity that we need to pay to. Used for carriers |
payToProfileId - ObjectId
|
ID of the business entity that we need to pay to. Used for carriers |
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
For customers and brokers, the types of reference numbers they use in orders. |
remitAddress - TextualAddress
|
Remit address for the business entity. Where payments are sent. |
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
Remit email for the business entity |
shipmentDocumentsToReceive - [String!]
|
Shipmentp documents to receive via email on completion |
standardCarrierAlphaCode - String
|
SCAC code for carriers |
status - AssetStatus!
|
|
storageFacilities - [StorageFacility!]
|
Storage facilities for the business entity. Used for tanks, warehouses, etc |
Arguments
|
|
tags - [String!]
|
Tags for the business entity |
trailerTypes - [TrailerType!]
|
For carriers only, the types of trailers they have. |
type - BusinessEntityType!
|
The type of business entity. |
Example
{
"_id": "abc123",
"accessToken": "xyz789",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 123.45,
"code": "abc123",
"contact": Contact,
"creditTerms": "abc123",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "xyz789",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": ["abc123"],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
CustomerPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Customer!]!
|
Example
{"count": 123, "data": [Customer]}
DailyForecastingModelSlot
Fields
| Field Name | Description |
|---|---|
dayOfWeek - Float!
|
Example
{"dayOfWeek": 987.65}
DailyForecastingModelSlotInput
Fields
| Input Field | Description |
|---|---|
dayOfWeek - Float!
|
Example
{"dayOfWeek": 123.45}
DateRangeInput
DateTime
Description
A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
Example
"2007-12-03T10:15:30Z"
DateTimeWindow
DateTimeWindowInput
Deduction
Description
A deduction/bonus from a driver settlement
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
amount - Float!
|
|
date - DateTime!
|
|
deductionRule - DeductionRule
|
|
label - String!
|
|
type - DeductionType!
|
Example
{
"_id": "abc123",
"amount": 987.65,
"date": "2007-12-03T10:15:30Z",
"deductionRule": DeductionRule,
"label": "xyz789",
"type": "BONUS"
}
DeductionInput
Description
A deduction/bonus from a driver settlement
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
amount - Float!
|
|
date - DateTime!
|
|
label - String!
|
|
type - DeductionType!
|
Example
{
"_id": "xyz789",
"amount": 123.45,
"date": "2007-12-03T10:15:30Z",
"label": "xyz789",
"type": "BONUS"
}
DeductionPeriod
Description
The period over which a deduction applies
Fields
| Field Name | Description |
|---|---|
end - DateTime!
|
|
repeatEvery - Float!
|
|
start - DateTime!
|
|
unit - DeductionPeriodUnit!
|
Example
{
"end": "2007-12-03T10:15:30Z",
"repeatEvery": 987.65,
"start": "2007-12-03T10:15:30Z",
"unit": "DAY"
}
DeductionPeriodInput
Fields
| Input Field | Description |
|---|---|
end - DateTime!
|
|
repeatEvery - Float!
|
|
start - DateTime!
|
|
unit - DeductionPeriodUnit!
|
Example
{
"end": "2007-12-03T10:15:30Z",
"repeatEvery": 123.45,
"start": "2007-12-03T10:15:30Z",
"unit": "DAY"
}
DeductionPeriodUnit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAY"
DeductionRule
Description
A driver deduction/bonus rule
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
amount - Float!
|
|
driver - Driver
|
|
label - String!
|
|
method - DriverDeductionMethod!
|
|
period - DeductionPeriod!
|
|
type - DeductionType!
|
Example
{
"_id": "xyz789",
"amount": 123.45,
"driver": Driver,
"label": "abc123",
"method": "FLAT_FEE",
"period": DeductionPeriod,
"type": "BONUS"
}
DeductionRulePaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [DeductionRule!]!
|
Example
{"count": 987, "data": [DeductionRule]}
DeductionRuleUpdateInput
Fields
| Input Field | Description |
|---|---|
amount - Float
|
|
driver - String
|
|
label - String
|
|
method - DriverDeductionMethod
|
|
period - DeductionPeriodInput
|
|
type - DeductionType
|
Example
{
"amount": 987.65,
"driver": "xyz789",
"label": "xyz789",
"method": "FLAT_FEE",
"period": DeductionPeriodInput,
"type": "BONUS"
}
DeductionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BONUS"
DefaultReferenceNumber
Fields
| Field Name | Description |
|---|---|
referenceNumberType - ShipmentReferenceNumberType!
|
|
referenceNumberValue - String!
|
Example
{
"referenceNumberType": "BILL_OF_LADING_NUMBER",
"referenceNumberValue": "abc123"
}
DefaultReferenceNumberInput
Fields
| Input Field | Description |
|---|---|
referenceNumberType - ShipmentReferenceNumberType!
|
|
referenceNumberValue - String!
|
Example
{
"referenceNumberType": "BILL_OF_LADING_NUMBER",
"referenceNumberValue": "xyz789"
}
DeleteShipmentDocumentInput
DeleteShipmentNoteInput
DispatchingSettings
Fields
| Field Name | Description |
|---|---|
canChangeTripOrder - Boolean
|
|
canConsolidateInProgressShipments - Boolean
|
|
canDriverSetAlternateSupplierPinCode - Boolean
|
|
canUseAdHocAddress - Boolean
|
|
enableCapacityWarnings - Boolean
|
Enable warnings when delivery quantity exceeds tank capacity in order entry for monitored tanks |
Example
{
"canChangeTripOrder": true,
"canConsolidateInProgressShipments": false,
"canDriverSetAlternateSupplierPinCode": false,
"canUseAdHocAddress": false,
"enableCapacityWarnings": true
}
DispatchingSettingsInput
Fields
| Input Field | Description |
|---|---|
canChangeTripOrder - Boolean
|
|
canConsolidateInProgressShipments - Boolean
|
|
canDriverSetAlternateSupplierPinCode - Boolean
|
|
canUseAdHocAddress - Boolean
|
|
enableCapacityWarnings - Boolean
|
Enable warnings when delivery quantity exceeds tank capacity in order entry for monitored tanks |
Example
{
"canChangeTripOrder": false,
"canConsolidateInProgressShipments": false,
"canDriverSetAlternateSupplierPinCode": true,
"canUseAdHocAddress": false,
"enableCapacityWarnings": false
}
Document
DocumentInput
DocumentRequirement
Description
Document requirement for invoicing
Fields
| Field Name | Description |
|---|---|
attachToInvoice - Boolean!
|
|
documentName - String
|
|
documentType - DocumentType!
|
|
requiredForInvoicing - Boolean!
|
Example
{
"attachToInvoice": false,
"documentName": "xyz789",
"documentType": "CUSTOMS_FORM",
"requiredForInvoicing": true
}
DocumentRequirementInput
Fields
| Input Field | Description |
|---|---|
attachToInvoice - Boolean
|
|
documentName - String
|
|
documentType - DocumentType!
|
|
requiredForInvoicing - Boolean
|
Example
{
"attachToInvoice": true,
"documentName": "xyz789",
"documentType": "CUSTOMS_FORM",
"requiredForInvoicing": true
}
DocumentSignedUrl
DocumentSignedUrlInput
Fields
| Input Field | Description |
|---|---|
extension - String
|
|
key - String
|
|
operation - S3_OPERATION!
|
Example
{
"extension": "abc123",
"key": "abc123",
"operation": "getObject"
}
DocumentType
Description
Types of documents that can be required by customers
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOMS_FORM"
Driver
Description
Driver entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
customFields - [CustomField!]
|
|
dateOfBirth - DateTime
|
|
dateOfPhysicalExamination - DateTime
|
|
documents - [DriverDocument!]
|
|
domicile - Address
|
Where the driver starts his journey everyday |
domicileEntity - BusinessEntity
|
|
domicileId - ObjectId
|
|
eldId - String
|
|
firstname - String!
|
|
groupIds - [ObjectId!]
|
|
hos - DriverHos
|
|
isOwnerOperator - Boolean
|
|
lastKnownLocation - Coordinates
|
|
lastKnownLocationDate - DateTime
|
|
lastname - String!
|
|
license - DriverLicense
|
|
medical - DriverMedical
|
|
middlename - String
|
|
phoneNumber - String
|
|
status - AssetStatus!
|
|
tags - [String!]
|
|
userId - String
|
Example
{
"_id": "xyz789",
"customFields": [CustomField],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocument],
"domicile": Address,
"domicileEntity": BusinessEntity,
"domicileId": ObjectId,
"eldId": "abc123",
"firstname": "abc123",
"groupIds": [ObjectId],
"hos": DriverHos,
"isOwnerOperator": false,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"lastname": "xyz789",
"license": DriverLicense,
"medical": DriverMedical,
"middlename": "abc123",
"phoneNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"userId": "xyz789"
}
DriverDeductionMethod
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FLAT_FEE"
DriverDocument
DriverDocumentInput
DriverHos
Example
{
"currentDrivingTime": 987.65,
"currentOnDutyTime": 987.65,
"currentStatus": "DRIVING",
"statusTime": "2007-12-03T10:15:30Z",
"totalDrivingTime": 123.45,
"totalOnDutyTime": 987.65
}
DriverHosInput
Example
{
"currentDrivingTime": 987.65,
"currentOnDutyTime": 123.45,
"currentStatus": "DRIVING",
"statusTime": "2007-12-03T10:15:30Z",
"totalDrivingTime": 123.45,
"totalOnDutyTime": 987.65
}
DriverHosStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRIVING"
DriverLicense
Fields
| Field Name | Description |
|---|---|
address - TextualAddress
|
|
classification - DriverLicenseClassification
|
|
endorsements - [DriverLicenseEndorsement!]
|
|
expiryDate - DateTime
|
|
issuedDate - DateTime
|
|
issuedState - String
|
|
licenseNumber - String
|
|
restriction - DriverLicenseRestriction
|
Example
{
"address": TextualAddress,
"classification": "CLASS_A",
"endorsements": ["COMBINATION"],
"expiryDate": "2007-12-03T10:15:30Z",
"issuedDate": "2007-12-03T10:15:30Z",
"issuedState": "xyz789",
"licenseNumber": "xyz789",
"restriction": "B"
}
DriverLicenseClassification
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLASS_A"
DriverLicenseEndorsement
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMBINATION"
DriverLicenseInput
Fields
| Input Field | Description |
|---|---|
address - TextualAddressInput
|
|
classification - DriverLicenseClassification
|
|
endorsements - [DriverLicenseEndorsement!]
|
|
expiryDate - DateTime
|
|
issuedDate - DateTime
|
|
issuedState - String
|
|
licenseNumber - String
|
|
restriction - DriverLicenseRestriction
|
Example
{
"address": TextualAddressInput,
"classification": "CLASS_A",
"endorsements": ["COMBINATION"],
"expiryDate": "2007-12-03T10:15:30Z",
"issuedDate": "2007-12-03T10:15:30Z",
"issuedState": "abc123",
"licenseNumber": "abc123",
"restriction": "B"
}
DriverLicenseRestriction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"B"
DriverMedical
DriverMedicalInput
DriverPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Driver!]!
|
Example
{"count": 123, "data": [Driver]}
DriverPaymentMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PER_HOUR"
DriverSettlement
Description
A driver settlement
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
deductions - [Deduction!]!
|
|
driver - Driver
|
|
driverSettlementNumber - String!
|
|
endDate - DateTime!
|
|
payments - [TripPayment!]!
|
|
pdfDocument - DriverSettlementPdf!
|
|
startDate - DateTime!
|
|
status - DriverSettlementStatus!
|
|
trips - [Trip!]
|
Example
{
"_id": "abc123",
"deductions": [Deduction],
"driver": Driver,
"driverSettlementNumber": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"payments": [TripPayment],
"pdfDocument": DriverSettlementPdf,
"startDate": "2007-12-03T10:15:30Z",
"status": "CANCELLED",
"trips": [Trip]
}
DriverSettlementPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [DriverSettlement!]!
|
Example
{"count": 123, "data": [DriverSettlement]}
DriverSettlementPdf
DriverSettlementStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
DriverSettlementUpdateInput
Fields
| Input Field | Description |
|---|---|
deductions - [DeductionInput!]
|
|
payments - [TripPaymentInput!]
|
Example
{
"deductions": [DeductionInput],
"payments": [TripPaymentInput]
}
DriverShift
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
days - [Int!]!
|
|
domicile - BusinessEntity
|
|
domicileId - ObjectId
|
|
driverIds - [ObjectId!]
|
|
endTime - Time!
|
|
isAdhoc - Boolean
|
Ad hoc driver shifts are one time shifts that have been assigned directly from the planning tool |
label - String
|
|
startTime - Time!
|
Example
{
"_id": "abc123",
"days": [987],
"domicile": BusinessEntity,
"domicileId": ObjectId,
"driverIds": [ObjectId],
"endTime": Time,
"isAdhoc": true,
"label": "abc123",
"startTime": Time
}
DriverShiftAssignment
Example
{
"_id": "xyz789",
"driver": Driver,
"driverId": ObjectId,
"driverShift": DriverShift,
"driverShiftId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"startDate": "2007-12-03T10:15:30Z"
}
DriverShiftAssignmentPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [DriverShiftAssignment!]!
|
Example
{"count": 987, "data": [DriverShiftAssignment]}
DriverShiftAssignmentUpdateInput
DriverShiftPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [DriverShift!]!
|
Example
{"count": 987, "data": [DriverShift]}
DriverShiftUpdateInput
Example
{
"days": [123],
"domicileId": ObjectId,
"driverIds": [ObjectId],
"endTime": TimeInput,
"isAdhoc": false,
"label": "xyz789",
"startTime": TimeInput
}
DriverUpdateInput
Fields
| Input Field | Description |
|---|---|
customFields - [CustomFieldInput!]
|
|
dateOfBirth - DateTime
|
|
dateOfPhysicalExamination - DateTime
|
|
documents - [DriverDocumentInput!]
|
|
domicile - NewAddressInput
|
Where the driver starts his journey everyday |
domicileId - ObjectId
|
|
eldId - String
|
|
email - String
|
|
firstname - String
|
|
groupIds - [ObjectId!]
|
|
hos - DriverHosInput
|
|
isOwnerOperator - Boolean
|
|
lastname - String
|
|
license - DriverLicenseInput
|
|
medical - DriverMedicalInput
|
|
middlename - String
|
|
password - String
|
|
phoneNumber - String
|
|
status - AssetStatus
|
|
tags - [String!]
|
|
userId - String
|
|
username - String
|
Example
{
"customFields": [CustomFieldInput],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocumentInput],
"domicile": NewAddressInput,
"domicileId": ObjectId,
"eldId": "xyz789",
"email": "abc123",
"firstname": "xyz789",
"groupIds": [ObjectId],
"hos": DriverHosInput,
"isOwnerOperator": true,
"lastname": "xyz789",
"license": DriverLicenseInput,
"medical": DriverMedicalInput,
"middlename": "abc123",
"password": "abc123",
"phoneNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"userId": "xyz789",
"username": "xyz789"
}
DriverWhere
Fields
| Input Field | Description |
|---|---|
domicile - String
|
|
status - AssetStatus
|
Example
{"domicile": "abc123", "status": "ACTIVE"}
EditShipmentDocumentInput
Example
{
"_id": "xyz789",
"accessLevel": ["CARRIER"],
"associatedCharge": "abc123",
"isBillable": false,
"name": "xyz789",
"receiver": "xyz789",
"shipment": "xyz789",
"shipper": "abc123",
"type": "abc123",
"url": "abc123"
}
EditShipmentNoteInput
Example
Email
Events
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRIVER_CREATED"
Extension
Description
Extension
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
category - String!
|
|
configurationDefinitions - [ExtensionConfigurationDefinition!]!
|
|
coverImage - String
|
|
description - String!
|
|
name - String!
|
|
settings - ExtensionSettings!
|
|
websiteUrl - String
|
Example
{
"_id": "abc123",
"category": "xyz789",
"configurationDefinitions": [
ExtensionConfigurationDefinition
],
"coverImage": "xyz789",
"description": "abc123",
"name": "xyz789",
"settings": ExtensionSettings,
"websiteUrl": "xyz789"
}
ExtensionAction
Description
Extension action
Fields
| Field Name | Description |
|---|---|
text - String!
|
|
type - ExtensionActionType!
|
|
url - String!
|
Example
{
"text": "abc123",
"type": "URL",
"url": "abc123"
}
ExtensionActionType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"URL"
ExtensionConfigurationDefinition
ExtensionConfigurationValue
ExtensionConfigurationValueInput
ExtensionCustomFieldContext
Values
| Enum Value | Description |
|---|---|
|
|
Example
"EXPENSE"
ExtensionCustomFieldDefinition
Description
Extension custom field
Fields
| Field Name | Description |
|---|---|
context - String!
|
|
description - String!
|
|
key - String!
|
|
label - String!
|
|
selectOptions - [ExtensionCustomFieldSelectOption!]
|
|
selectOptionsEndpoint - String
|
|
type - ExtensionCustomFieldType!
|
Example
{
"context": "abc123",
"description": "abc123",
"key": "abc123",
"label": "xyz789",
"selectOptions": [ExtensionCustomFieldSelectOption],
"selectOptionsEndpoint": "abc123",
"type": "BOOLEAN"
}
ExtensionCustomFieldSelectOption
ExtensionCustomFieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOOLEAN"
ExtensionCustomFieldWithExtensionId
Fields
| Field Name | Description |
|---|---|
context - String!
|
|
description - String!
|
|
extensionId - String!
|
|
key - String!
|
|
label - String!
|
|
selectOptions - [ExtensionCustomFieldSelectOption!]
|
|
selectOptionsEndpoint - String
|
|
type - ExtensionCustomFieldType!
|
Example
{
"context": "xyz789",
"description": "abc123",
"extensionId": "xyz789",
"key": "abc123",
"label": "abc123",
"selectOptions": [ExtensionCustomFieldSelectOption],
"selectOptionsEndpoint": "abc123",
"type": "BOOLEAN"
}
ExtensionEventHandler
ExtensionHook
Description
Extension hook
Fields
| Field Name | Description |
|---|---|
endpoint - String!
|
|
operation - ExtensionHookOperation!
|
Example
{
"endpoint": "abc123",
"operation": "GET_INVOICE_TEMPLATE"
}
ExtensionHookOperation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GET_INVOICE_TEMPLATE"
ExtensionInstallWithRedirectUrl
Fields
| Field Name | Description |
|---|---|
configurationValues - [ExtensionConfigurationValue!]!
|
|
extension - Extension!
|
|
installedAt - DateTime!
|
|
installedBy - String!
|
|
redirectUrl - String
|
Example
{
"configurationValues": [ExtensionConfigurationValue],
"extension": Extension,
"installedAt": "2007-12-03T10:15:30Z",
"installedBy": "xyz789",
"redirectUrl": "xyz789"
}
ExtensionMessage
Description
Extension message
Fields
| Field Name | Description |
|---|---|
actions - [ExtensionAction!]
|
|
context - ExtensionMessageContext
|
|
extensionId - String!
|
|
extensionName - String!
|
|
text - String!
|
|
type - ExtensionMessageType!
|
Example
{
"actions": [ExtensionAction],
"context": "ORDERS_LIST",
"extensionId": "xyz789",
"extensionName": "abc123",
"text": "abc123",
"type": "ERROR"
}
ExtensionMessageContext
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ORDERS_LIST"
ExtensionMessageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ERROR"
ExtensionOperation
Description
Extension operation
Example
{
"context": "BUSINESS_ENTITY",
"description": "xyz789",
"endpoint": "abc123",
"icon": "xyz789",
"key": "xyz789",
"name": "abc123"
}
ExtensionOperationContext
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BUSINESS_ENTITY"
ExtensionOperationResponse
ExtensionOperationWithExtensionId
Example
{
"context": "BUSINESS_ENTITY",
"description": "abc123",
"endpoint": "xyz789",
"extensionId": "xyz789",
"icon": "xyz789",
"key": "xyz789",
"name": "abc123"
}
ExtensionPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [ExtensionWithStatus!]!
|
Example
{"count": 987, "data": [ExtensionWithStatus]}
ExtensionSettings
Description
Extension settings
Fields
| Field Name | Description |
|---|---|
authEndpoint - String!
|
|
configureEndpoint - String
|
|
customFields - [ExtensionCustomFieldDefinition!]!
|
|
eventHandlers - [ExtensionEventHandler!]!
|
|
hooks - [ExtensionHook!]!
|
|
installEndpoint - String!
|
|
messagesEndpoint - String
|
|
operations - [ExtensionOperation!]!
|
|
rootUrl - String!
|
|
uninstallEndpoint - String!
|
|
widgets - [ExtensionWidget!]!
|
Example
{
"authEndpoint": "abc123",
"configureEndpoint": "xyz789",
"customFields": [ExtensionCustomFieldDefinition],
"eventHandlers": [ExtensionEventHandler],
"hooks": [ExtensionHook],
"installEndpoint": "abc123",
"messagesEndpoint": "abc123",
"operations": [ExtensionOperation],
"rootUrl": "abc123",
"uninstallEndpoint": "xyz789",
"widgets": [ExtensionWidget]
}
ExtensionWidget
Description
Extension widget
Fields
| Field Name | Description |
|---|---|
context - ExtensionWidgetContext!
|
|
endpoint - String!
|
|
label - String!
|
Example
{
"context": "PLANNING_TOOL_HEADER",
"endpoint": "xyz789",
"label": "abc123"
}
ExtensionWidgetContext
Values
| Enum Value | Description |
|---|---|
|
|
Example
"PLANNING_TOOL_HEADER"
ExtensionWidgetWithExtensionInfo
Fields
| Field Name | Description |
|---|---|
context - ExtensionWidgetContext!
|
|
endpoint - String!
|
|
extensionId - String!
|
|
label - String!
|
|
rootUrl - String!
|
Example
{
"context": "PLANNING_TOOL_HEADER",
"endpoint": "abc123",
"extensionId": "abc123",
"label": "xyz789",
"rootUrl": "xyz789"
}
ExtensionWithStatus
Fields
| Field Name | Description |
|---|---|
extension - Extension!
|
|
installed - Boolean!
|
Example
{"extension": Extension, "installed": false}
Extras
Fields
| Field Name | Description |
|---|---|
tripId - String!
|
Example
{"tripId": "abc123"}
FeelsLike
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
ForecastResult
Fields
| Field Name | Description |
|---|---|
shipments - [ForecastedShipment!]!
|
Example
{"shipments": [ForecastedShipment]}
ForecastedShipment
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
additionalTrailerTypes - [TrailerType!]
|
Additional trailer types that can be used for the shipment |
charges - [ShipmentCharge!]!
|
Charges associated with the shipment. This is used to bill the customer |
commodityType - ShipmentCommodityType
|
Type of commodity being shipped. This affects what trailer types can be used |
constraints - [ShipmentConstraint!]
|
Constraints that must be satisfied for the shipment |
createdBy - String!
|
ID of the user who created the shipment |
customer - BusinessEntity!
|
ID of the customer for whom the shipment is created |
loadType - LoadType!
|
Full truck load or less than truck load shipment type. Full truck load shipments can't be mixed with other shipments on the same trip |
route - ShipmentRoute
|
Route information for the shipment |
shipmentLocations - [ShipmentLocation!]!
|
Locations that need to be visited for the shipment |
shipmentNumber - String!
|
Auto incremented number for the shipment |
status - Status!
|
Current status of the shipment |
trailerType - TrailerType!
|
Type of trailer required for the shipment |
Example
{
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"charges": [ShipmentCharge],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customer": BusinessEntity,
"loadType": "FULL_TRUCK_LOAD",
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "xyz789",
"status": "ACTIVE",
"trailerType": "AUTO_CARRIER"
}
ForecastingModel
Example
{
"_id": "xyz789",
"contaminates": true,
"isExclusive": true,
"label": "xyz789",
"maxCapacity": 123.45,
"minCapacity": 987.65,
"slots": [ForecastingModelSlot],
"storageFacilityId": "abc123",
"target": 987.65,
"threshold": 987.65,
"weight": 987.65
}
ForecastingModelInput
Example
{
"_id": "xyz789",
"contaminates": false,
"isExclusive": false,
"label": "abc123",
"maxCapacity": 987.65,
"minCapacity": 123.45,
"slots": [ForecastingModelSlotInput],
"storageFacilityId": "xyz789",
"target": 987.65,
"threshold": 987.65,
"weight": 123.45
}
ForecastingModelSlot
Fields
| Field Name | Description |
|---|---|
daily - DailyForecastingModelSlot
|
|
hourly - HourlyForecastingModelSlot
|
|
monthly - MonthlyForecastingModelSlot
|
|
salesAmount - Float!
|
|
type - ForecastingModelSlotType!
|
Example
{
"daily": DailyForecastingModelSlot,
"hourly": HourlyForecastingModelSlot,
"monthly": MonthlyForecastingModelSlot,
"salesAmount": 123.45,
"type": "DAILY"
}
ForecastingModelSlotInput
Fields
| Input Field | Description |
|---|---|
daily - DailyForecastingModelSlotInput
|
|
hourly - HourlyForecastingModelSlotInput
|
|
monthly - MonthlyForecastingModelSlotInput
|
|
salesAmount - Float!
|
|
type - ForecastingModelSlotType!
|
Example
{
"daily": DailyForecastingModelSlotInput,
"hourly": HourlyForecastingModelSlotInput,
"monthly": MonthlyForecastingModelSlotInput,
"salesAmount": 123.45,
"type": "DAILY"
}
ForecastingModelSlotType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAILY"
ForecastingNotification
Fields
| Field Name | Description |
|---|---|
level - ForecastingNotificationLevel!
|
|
message - String!
|
|
receiverForecastId - ObjectId!
|
|
receiverId - ObjectId!
|
|
storageFacilityId - String!
|
Example
{
"level": "CRITICAL",
"message": "xyz789",
"receiverForecastId": ObjectId,
"receiverId": ObjectId,
"storageFacilityId": "xyz789"
}
ForecastingNotificationLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CRITICAL"
ForecastingPayload
Fields
| Input Field | Description |
|---|---|
endDate - DateTime!
|
|
receiverForecastId - ObjectId!
|
|
startDate - DateTime!
|
|
upticks - [ForecastingUptickInput!]
|
Example
{
"endDate": "2007-12-03T10:15:30Z",
"receiverForecastId": ObjectId,
"startDate": "2007-12-03T10:15:30Z",
"upticks": [ForecastingUptickInput]
}
ForecastingUptickInput
Frequency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAILY"
GeneralSettings
Example
{
"currency": "CAD",
"driversCanSeeFutureTrips": true,
"language": "EN",
"measurementSystem": "IMPERIAL",
"singleClickTripCompletion": true,
"useSimpleWorkflow": true,
"weekStartsOn": 987.65
}
GeneralSettingsInput
Example
{
"currency": "CAD",
"driversCanSeeFutureTrips": true,
"language": "EN",
"measurementSystem": "IMPERIAL",
"singleClickTripCompletion": false,
"useSimpleWorkflow": false,
"weekStartsOn": 987.65
}
GenerateTripInput
Fields
| Input Field | Description |
|---|---|
additionalTrailers - [ObjectId!]
|
|
carrier - String
|
|
chassis - String
|
|
customFields - [CustomFieldInput!]
|
|
driver - String
|
|
etaFromPreviousTrip - Float
|
|
etaToNextTrip - Float
|
|
shipments - [String!]!
|
|
startTime - DateTime
|
|
tags - [String!]
|
|
tractor - String
|
|
trailer - String
|
|
trailerCompartmentAssignments - [TrailerCompartmentAssignmentInput!]
|
|
violations - [TripViolationInput!]
|
Example
{
"additionalTrailers": [ObjectId],
"carrier": "abc123",
"chassis": "abc123",
"customFields": [CustomFieldInput],
"driver": "xyz789",
"etaFromPreviousTrip": 987.65,
"etaToNextTrip": 123.45,
"shipments": ["abc123"],
"startTime": "2007-12-03T10:15:30Z",
"tags": ["xyz789"],
"tractor": "abc123",
"trailer": "xyz789",
"trailerCompartmentAssignments": [
TrailerCompartmentAssignmentInput
],
"violations": [TripViolationInput]
}
Good
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
alternativePinCodes - [String!]
|
|
goodProfileId - ObjectId
|
|
label - String!
|
|
loadedQuantity - Float
|
The quantity that was loaded by the driver |
pallet - Float
|
|
pieces - Float
|
|
pinCode - String
|
|
quantity - Float!
|
|
supplierId - ObjectId
|
|
unit - GoodUnits
|
|
unitPrice - Float
|
|
weight - Float
|
Example
{
"_id": "xyz789",
"alternativePinCodes": ["abc123"],
"goodProfileId": ObjectId,
"label": "xyz789",
"loadedQuantity": 987.65,
"pallet": 123.45,
"pieces": 987.65,
"pinCode": "abc123",
"quantity": 123.45,
"supplierId": ObjectId,
"unit": "GALLONS",
"unitPrice": 123.45,
"weight": 987.65
}
GoodDistribution
Fields
| Field Name | Description |
|---|---|
alternativePinCodes - [String!]
|
|
deliveredQuantity - Float
|
The quantity that was actually delivered to the customer |
goodId - String!
|
|
goodProfile - GoodProfile
|
|
goodProfileId - ObjectId
|
|
pinCode - String
|
|
quantity - Float
|
|
shipperId - ObjectId
|
|
storageFacilityId - String
|
|
supplierId - ObjectId
|
|
unitPrice - Float
|
Example
{
"alternativePinCodes": ["xyz789"],
"deliveredQuantity": 123.45,
"goodId": "xyz789",
"goodProfile": GoodProfile,
"goodProfileId": ObjectId,
"pinCode": "xyz789",
"quantity": 123.45,
"shipperId": ObjectId,
"storageFacilityId": "abc123",
"supplierId": ObjectId,
"unitPrice": 123.45
}
GoodDistributionInput
Fields
| Input Field | Description |
|---|---|
alternativePinCodes - [String!]
|
|
deliveredQuantity - Float
|
The quantity that was actually delivered to the customer |
goodId - String!
|
|
goodProfileId - ObjectId
|
|
pinCode - String
|
|
quantity - Float
|
|
shipperId - ObjectId
|
|
storageFacilityId - String
|
|
supplierId - ObjectId
|
|
unitPrice - Float
|
Example
{
"alternativePinCodes": ["abc123"],
"deliveredQuantity": 123.45,
"goodId": "xyz789",
"goodProfileId": ObjectId,
"pinCode": "xyz789",
"quantity": 123.45,
"shipperId": ObjectId,
"storageFacilityId": "abc123",
"supplierId": ObjectId,
"unitPrice": 123.45
}
GoodInput
Fields
| Input Field | Description |
|---|---|
_id - String!
|
|
alternativePinCodes - [String!]
|
|
goodProfileId - ObjectId
|
|
label - String!
|
|
loadedQuantity - Float
|
The quantity that was loaded by the driver |
pallet - Float
|
|
pieces - Float
|
|
pinCode - String
|
|
quantity - Float!
|
|
supplierId - ObjectId
|
|
unit - GoodUnits
|
|
unitPrice - Float
|
|
weight - Float
|
Example
{
"_id": "xyz789",
"alternativePinCodes": ["abc123"],
"goodProfileId": ObjectId,
"label": "abc123",
"loadedQuantity": 987.65,
"pallet": 123.45,
"pieces": 123.45,
"pinCode": "abc123",
"quantity": 123.45,
"supplierId": ObjectId,
"unit": "GALLONS",
"unitPrice": 987.65,
"weight": 987.65
}
GoodInventoryItem
GoodInventoryItemInput
GoodProfile
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
code - String
|
|
color - String
|
|
customFields - [CustomField!]
|
|
documents - [Document!]
|
|
equivalences - [GoodProfileEquivalence!]
|
|
externalId - String
|
ID of the commodity profile in an external system. |
goodProfileClass - GoodProfileClass
|
|
goodProfileClassId - ObjectId
|
|
groupIds - [ObjectId!]
|
|
label - String!
|
|
liquidGravity - Float
|
|
restrictions - [GoodProfileRestriction!]
|
|
shipperIds - [String!]
|
|
supplierIds - [String!]
|
|
tags - [String!]
|
|
unit - GoodUnits!
|
|
weight - Float!
|
Example
{
"_id": "xyz789",
"code": "abc123",
"color": "abc123",
"customFields": [CustomField],
"documents": [Document],
"equivalences": [GoodProfileEquivalence],
"externalId": "xyz789",
"goodProfileClass": GoodProfileClass,
"goodProfileClassId": ObjectId,
"groupIds": [ObjectId],
"label": "abc123",
"liquidGravity": 987.65,
"restrictions": [GoodProfileRestriction],
"shipperIds": ["abc123"],
"supplierIds": ["abc123"],
"tags": ["abc123"],
"unit": "GALLONS",
"weight": 123.45
}
GoodProfileClass
GoodProfileClassPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [GoodProfileClass!]!
|
Example
{"count": 123, "data": [GoodProfileClass]}
GoodProfileClassUpdateInput
GoodProfileEquivalence
Fields
| Field Name | Description |
|---|---|
conditions - [GoodProfileEquivalenceCondition!]!
|
|
equivalentGoodId - ObjectId!
|
Example
{
"conditions": [GoodProfileEquivalenceCondition],
"equivalentGoodId": ObjectId
}
GoodProfileEquivalenceCondition
Fields
| Field Name | Description |
|---|---|
operator - GoodProfileEquivalenceConditionOperator!
|
|
target - GoodProfileEquivalenceConditionTarget!
|
|
value - ConditionValue
|
Example
{
"operator": "EQUALS",
"target": "DATE",
"value": ConditionValue
}
GoodProfileEquivalenceConditionInput
Fields
| Input Field | Description |
|---|---|
operator - GoodProfileEquivalenceConditionOperator!
|
|
target - GoodProfileEquivalenceConditionTarget!
|
|
value - ConditionValue
|
Example
{
"operator": "EQUALS",
"target": "DATE",
"value": ConditionValue
}
GoodProfileEquivalenceConditionOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQUALS"
GoodProfileEquivalenceConditionTarget
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATE"
GoodProfileEquivalenceInput
Fields
| Input Field | Description |
|---|---|
conditions - [GoodProfileEquivalenceConditionInput!]!
|
|
equivalentGoodId - ObjectId!
|
Example
{
"conditions": [GoodProfileEquivalenceConditionInput],
"equivalentGoodId": ObjectId
}
GoodProfilePaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [GoodProfile!]!
|
Example
{"count": 123, "data": [GoodProfile]}
GoodProfileRestriction
Fields
| Field Name | Description |
|---|---|
type - GoodProfileRestrictionType!
|
|
value - ConditionValue
|
Example
{"type": "DRIVER_ENDORSEMENT", "value": ConditionValue}
GoodProfileRestrictionInput
Fields
| Input Field | Description |
|---|---|
type - GoodProfileRestrictionType!
|
|
value - ConditionValue
|
Example
{"type": "DRIVER_ENDORSEMENT", "value": ConditionValue}
GoodProfileRestrictionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DRIVER_ENDORSEMENT"
GoodProfileUpdateInput
Fields
| Input Field | Description |
|---|---|
code - String
|
|
color - String
|
|
customFields - [CustomFieldInput!]
|
|
documents - [DocumentInput!]
|
|
equivalences - [GoodProfileEquivalenceInput!]
|
|
externalId - String
|
ID of the commodity profile in an external system. |
goodProfileClassId - ObjectId
|
|
groupIds - [ObjectId!]
|
|
label - String
|
|
liquidGravity - Float
|
|
restrictions - [GoodProfileRestrictionInput!]
|
|
shipperIds - [String!]
|
|
supplierIds - [String!]
|
|
tags - [String!]
|
|
unit - GoodUnits
|
|
weight - Float
|
Example
{
"code": "xyz789",
"color": "xyz789",
"customFields": [CustomFieldInput],
"documents": [DocumentInput],
"equivalences": [GoodProfileEquivalenceInput],
"externalId": "abc123",
"goodProfileClassId": ObjectId,
"groupIds": [ObjectId],
"label": "abc123",
"liquidGravity": 123.45,
"restrictions": [GoodProfileRestrictionInput],
"shipperIds": ["abc123"],
"supplierIds": ["xyz789"],
"tags": ["xyz789"],
"unit": "GALLONS",
"weight": 987.65
}
GoodUnits
Description
The units of measure for a good
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GALLONS"
Group
Description
Group
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
description - String
|
|
memberIds - [String!]!
|
|
name - String!
|
Example
{
"_id": "abc123",
"description": "abc123",
"memberIds": ["abc123"],
"name": "abc123"
}
GroupPaginatedResult
GroupUpdateInput
HourlyForecastingModelSlot
HourlyForecastingModelSlotInput
Fields
| Input Field | Description |
|---|---|
dayOfWeek - Float!
|
|
endTime - TimeInput!
|
|
startTime - TimeInput!
|
Example
{
"dayOfWeek": 123.45,
"endTime": TimeInput,
"startTime": TimeInput
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Invoice
Description
An invoice
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
charges - [ShipmentCharge!]!
|
|
closingNote - String
|
|
customer - BusinessEntity
|
|
groupIds - [ObjectId!]
|
IDs of the groups the invoice is associated with |
invoiceNumber - String!
|
|
missingRequiredDocuments - [DocumentRequirement!]
|
|
paidAmount - Float
|
|
payments - [InvoicePayment!]
|
|
pdfDocument - InvoicePdf!
|
|
shipment - Shipment
|
|
shipmentIds - [ObjectId!]
|
|
shipments - [Shipment!]
|
|
status - InvoiceStatus!
|
|
taxRate - Float
|
Example
{
"_id": "xyz789",
"charges": [ShipmentCharge],
"closingNote": "xyz789",
"customer": BusinessEntity,
"groupIds": [ObjectId],
"invoiceNumber": "xyz789",
"missingRequiredDocuments": [DocumentRequirement],
"paidAmount": 987.65,
"payments": [InvoicePayment],
"pdfDocument": InvoicePdf,
"shipment": Shipment,
"shipmentIds": [ObjectId],
"shipments": [Shipment],
"status": "CANCELLED",
"taxRate": 123.45
}
InvoiceBatchResult
Fields
| Field Name | Description |
|---|---|
invoicesUpdated - [Invoice!]!
|
|
textError - String!
|
Example
{
"invoicesUpdated": [Invoice],
"textError": "abc123"
}
InvoiceConsolidationCriteria
Description
Criteria for invoice consolidation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOL_NUMBER"
InvoicePaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Invoice!]!
|
Example
{"count": 987, "data": [Invoice]}
InvoicePayment
Description
An invoice payment
Fields
| Field Name | Description |
|---|---|
_id - ObjectId!
|
|
amount - Float!
|
|
date - DateTime!
|
|
note - String
|
|
paymentMethod - PaymentMethod
|
Example
{
"_id": ObjectId,
"amount": 987.65,
"date": "2007-12-03T10:15:30Z",
"note": "abc123",
"paymentMethod": "BANK_TRANSFER"
}
InvoicePaymentInput
Fields
| Input Field | Description |
|---|---|
_id - ObjectId!
|
|
amount - Float!
|
|
date - DateTime!
|
|
note - String
|
|
paymentMethod - PaymentMethod
|
Example
{
"_id": ObjectId,
"amount": 987.65,
"date": "2007-12-03T10:15:30Z",
"note": "xyz789",
"paymentMethod": "BANK_TRANSFER"
}
InvoicePdf
InvoiceStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
InvoiceUpdateInput
Fields
| Input Field | Description |
|---|---|
charges - [ShipmentChargeInput!]!
|
|
closingNote - String
|
|
groupIds - [ObjectId!]
|
IDs of the groups the invoice is associated with |
missingRequiredDocuments - [DocumentRequirementInput!]
|
|
paidAmount - Float
|
|
payments - [InvoicePaymentInput!]
|
|
status - InvoiceStatus
|
|
taxRate - Float
|
Example
{
"charges": [ShipmentChargeInput],
"closingNote": "abc123",
"groupIds": [ObjectId],
"missingRequiredDocuments": [DocumentRequirementInput],
"paidAmount": 123.45,
"payments": [InvoicePaymentInput],
"status": "CANCELLED",
"taxRate": 987.65
}
InvoicingProcess
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LOAD_BASED"
InvoicingSettings
Fields
| Field Name | Description |
|---|---|
companyAddress - String
|
Use Organization.address instead |
companyEmail - String
|
Use Organization.email instead |
companyPhone - String
|
Use Organization.phoneNumber instead |
enableConsolidatedInvoicing - Boolean
|
|
enableTaxRate - Boolean
|
|
logoUrl - String
|
|
prefix - String
|
|
primaryColor - String
|
|
processes - [InvoicingProcess!]
|
|
receiverDocumentationBodyTemplate - String
|
|
receiverDocumentationSubjectTemplate - String
|
|
remitAddress - TextualAddress
|
|
remitCompanyName - String
|
|
remitEmail - String
|
|
showLoadedDeliveredQuantities - Boolean
|
Example
{
"companyAddress": "xyz789",
"companyEmail": "abc123",
"companyPhone": "abc123",
"enableConsolidatedInvoicing": true,
"enableTaxRate": false,
"logoUrl": "xyz789",
"prefix": "xyz789",
"primaryColor": "abc123",
"processes": ["LOAD_BASED"],
"receiverDocumentationBodyTemplate": "xyz789",
"receiverDocumentationSubjectTemplate": "abc123",
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "abc123",
"showLoadedDeliveredQuantities": false
}
InvoicingSettingsInput
Fields
| Input Field | Description |
|---|---|
companyAddress - String
|
|
companyEmail - String
|
|
companyPhone - String
|
|
enableConsolidatedInvoicing - Boolean
|
|
enableTaxRate - Boolean
|
|
logoUrl - String
|
|
prefix - String
|
|
primaryColor - String
|
|
processes - [InvoicingProcess!]
|
|
receiverDocumentationBodyTemplate - String
|
|
receiverDocumentationSubjectTemplate - String
|
|
remitAddress - TextualAddressInput
|
|
remitCompanyName - String
|
|
remitEmail - String
|
|
showLoadedDeliveredQuantities - Boolean
|
Example
{
"companyAddress": "abc123",
"companyEmail": "xyz789",
"companyPhone": "xyz789",
"enableConsolidatedInvoicing": true,
"enableTaxRate": false,
"logoUrl": "abc123",
"prefix": "abc123",
"primaryColor": "abc123",
"processes": ["LOAD_BASED"],
"receiverDocumentationBodyTemplate": "xyz789",
"receiverDocumentationSubjectTemplate": "abc123",
"remitAddress": TextualAddressInput,
"remitCompanyName": "xyz789",
"remitEmail": "xyz789",
"showLoadedDeliveredQuantities": true
}
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
KeycloakOrganizationAttributes
KeycloakUserRole
KeycloakUserRoleInput
Language
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EN"
LoadBoardSearchCriteria
Fields
| Input Field | Description |
|---|---|
destinationCity - String
|
|
destinationCountry - String
|
|
destinationLatitude - Float
|
|
destinationLongitude - Float
|
|
destinationRadius - Float
|
|
destinationState - String
|
|
fromDate - DateTime
|
|
hoursOld - Float
|
|
loadType - LoadType
|
|
originCity - String
|
|
originCountry - String
|
|
originLatitude - Float
|
|
originLongitude - Float
|
|
originRadius - Float
|
|
originState - String
|
|
skip - Float
|
|
sortBy - String
|
|
take - Float
|
|
toDate - DateTime
|
|
trailerType - TrailerType
|
Example
{
"destinationCity": "xyz789",
"destinationCountry": "xyz789",
"destinationLatitude": 987.65,
"destinationLongitude": 123.45,
"destinationRadius": 123.45,
"destinationState": "xyz789",
"fromDate": "2007-12-03T10:15:30Z",
"hoursOld": 123.45,
"loadType": "FULL_TRUCK_LOAD",
"originCity": "xyz789",
"originCountry": "abc123",
"originLatitude": 123.45,
"originLongitude": 987.65,
"originRadius": 987.65,
"originState": "abc123",
"skip": 987.65,
"sortBy": "xyz789",
"take": 123.45,
"toDate": "2007-12-03T10:15:30Z",
"trailerType": "AUTO_CARRIER"
}
LoadBoardSearchResult
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
additionalTrailerTypes - [TrailerType!]
|
Additional trailer types that can be used for the shipment |
charges - [ShipmentCharge!]!
|
Charges associated with the shipment. This is used to bill the customer |
constraints - [ShipmentConstraint!]
|
Constraints that must be satisfied for the shipment |
customer - BusinessEntity!
|
ID of the customer for whom the shipment is created |
loadType - LoadType!
|
Full truck load or less than truck load shipment type. Full truck load shipments can't be mixed with other shipments on the same trip |
shipmentLocations - [ShipmentLocation!]!
|
Locations that need to be visited for the shipment |
trailerType - TrailerType!
|
Type of trailer required for the shipment |
Example
{
"_id": "xyz789",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"charges": [ShipmentCharge],
"constraints": [ShipmentConstraint],
"customer": BusinessEntity,
"loadType": "FULL_TRUCK_LOAD",
"shipmentLocations": [ShipmentLocation],
"trailerType": "AUTO_CARRIER"
}
LoadBoardSearchResultPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [LoadBoardSearchResult!]!
|
Example
{"count": 987, "data": [LoadBoardSearchResult]}
LoadState
Description
Load state of a given trip
Fields
| Field Name | Description |
|---|---|
distance - Float!
|
|
endPosition - TripDriverPosition
|
|
event - ShipmentEvent
|
|
goods - [Good!]!
|
|
startDate - DateTime!
|
|
startPosition - TripDriverPosition
|
Example
{
"distance": 987.65,
"endPosition": TripDriverPosition,
"event": ShipmentEvent,
"goods": [Good],
"startDate": "2007-12-03T10:15:30Z",
"startPosition": TripDriverPosition
}
LoadType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FULL_TRUCK_LOAD"
LocationTraffic
Example
{
"arrivalLocationTime": "2007-12-03T10:15:30Z",
"baseDuration": 987.65,
"duration": 987.65,
"lastUpdate": "2007-12-03T10:15:30Z",
"length": 987.65,
"typicalDuration": 987.65
}
LocationWeather
Fields
| Field Name | Description |
|---|---|
clouds - Float
|
|
dew_point - Float
|
|
dt - Float
|
|
feels_like - FeelsLike
|
|
humidity - Float
|
|
lastUpdate - DateTime!
|
|
moon_phase - Float
|
|
moonrise - Float
|
|
moonset - Float
|
|
pop - Float
|
|
pressure - Float
|
|
rain - Float
|
|
snow - Float
|
|
sunrise - Float
|
|
sunset - Float
|
|
temp - Temp
|
|
timezone - String!
|
|
timezone_offset - Float!
|
|
uvi - Float
|
|
weather - [WeatherInfo!]
|
|
wind_deg - Float
|
|
wind_gust - Float
|
|
wind_speed - Float
|
Example
{
"clouds": 987.65,
"dew_point": 987.65,
"dt": 987.65,
"feels_like": FeelsLike,
"humidity": 123.45,
"lastUpdate": "2007-12-03T10:15:30Z",
"moon_phase": 123.45,
"moonrise": 987.65,
"moonset": 123.45,
"pop": 987.65,
"pressure": 123.45,
"rain": 987.65,
"snow": 987.65,
"sunrise": 987.65,
"sunset": 987.65,
"temp": Temp,
"timezone": "xyz789",
"timezone_offset": 123.45,
"uvi": 123.45,
"weather": [WeatherInfo],
"wind_deg": 987.65,
"wind_gust": 123.45,
"wind_speed": 123.45
}
MaintenanceTask
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
assetId - ObjectId!
|
|
assetType - String!
|
|
endDate - DateTime
|
|
label - String!
|
|
recurrence - MaintenanceTaskRecurrence
|
|
required - Boolean
|
|
startDate - DateTime
|
|
startMileage - Float
|
|
status - MaintenanceTaskStatus
|
Example
{
"_id": "abc123",
"assetId": ObjectId,
"assetType": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"label": "xyz789",
"recurrence": MaintenanceTaskRecurrence,
"required": true,
"startDate": "2007-12-03T10:15:30Z",
"startMileage": 987.65,
"status": "CANCELLED"
}
MaintenanceTaskPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [MaintenanceTask!]!
|
Example
{"count": 123, "data": [MaintenanceTask]}
MaintenanceTaskRecurrence
Fields
| Field Name | Description |
|---|---|
frequency - MaintenanceTaskRecurrenceFrequency!
|
|
interval - Float!
|
Example
{"frequency": "DAILY", "interval": 123.45}
MaintenanceTaskRecurrenceFrequency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAILY"
MaintenanceTaskRecurrenceInput
Fields
| Input Field | Description |
|---|---|
frequency - MaintenanceTaskRecurrenceFrequency!
|
|
interval - Float!
|
Example
{"frequency": "DAILY", "interval": 123.45}
MaintenanceTaskStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CANCELLED"
MaintenanceTaskUpdateInput
Fields
| Input Field | Description |
|---|---|
assetId - ObjectId
|
|
assetType - String
|
|
endDate - DateTime
|
|
label - String
|
|
recurrence - MaintenanceTaskRecurrenceInput
|
|
required - Boolean
|
|
startDate - DateTime
|
|
startMileage - Float
|
|
status - MaintenanceTaskStatus
|
Example
{
"assetId": ObjectId,
"assetType": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"label": "abc123",
"recurrence": MaintenanceTaskRecurrenceInput,
"required": false,
"startDate": "2007-12-03T10:15:30Z",
"startMileage": 123.45,
"status": "CANCELLED"
}
MeasurementSystem
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IMPERIAL"
Metric
MetricType
Description
The type of metric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DELIVERY_COST"
Mixed
Description
A mixed scalar value (number, string or boolean)
Example
Mixed
MonthlyForecastingModelSlot
Fields
| Field Name | Description |
|---|---|
month - Float!
|
Example
{"month": 987.65}
MonthlyForecastingModelSlotInput
Fields
| Input Field | Description |
|---|---|
month - Float!
|
Example
{"month": 123.45}
MultiDocumentSignedUrlInput
Fields
| Input Field | Description |
|---|---|
documents - [DocumentSignedUrlInput!]!
|
Example
{"documents": [DocumentSignedUrlInput]}
MultiShipmentNotesInput
Fields
| Input Field | Description |
|---|---|
notes - [ShipmentNoteInput!]!
|
|
shipment - String
|
Example
{
"notes": [ShipmentNoteInput],
"shipment": "abc123"
}
MyDriverSettlementPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [DriverSettlement!]!
|
Example
{"count": 123, "data": [DriverSettlement]}
NewAddressInput
Example
{
"city": "abc123",
"coordinates": CoordinatesInput,
"country": "abc123",
"googlePlaceId": "xyz789",
"label": "abc123",
"line1": "abc123",
"line2": "xyz789",
"postalCode": "abc123",
"state": "abc123"
}
NewBillingRuleInput
Fields
| Input Field | Description |
|---|---|
amount - Float
|
|
condition - BillingRuleConditionInput
|
|
conditions - [BillingRuleConditionInput!]
|
|
customer - String
|
|
label - String
|
|
method - BillingMethod
|
|
priority - Float
|
|
rates - [BillingRateInput!]
|
|
referenceNumber - String
|
|
type - BillingRuleType!
|
Example
{
"amount": 987.65,
"condition": BillingRuleConditionInput,
"conditions": [BillingRuleConditionInput],
"customer": "abc123",
"label": "abc123",
"method": "FLAT_FEE",
"priority": 123.45,
"rates": [BillingRateInput],
"referenceNumber": "xyz789",
"type": "ACCESSORIAL"
}
NewBusinessEntityInput
Fields
| Input Field | Description |
|---|---|
accessToken - String
|
|
additionalContacts - [NewContactInput!]
|
|
additionalTypes - [BusinessEntityType!]
|
|
address - NewAddressInput!
|
|
billingAddress - NewTextualAddressInput
|
|
billingEmail - String
|
|
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
|
billingWeekStartsOn - Float
|
|
code - String
|
|
contact - NewContactInput
|
|
creditTerms - String
|
|
customFields - [CustomFieldInput!]
|
|
defaultReferenceNumbers - [DefaultReferenceNumberInput!]
|
|
defaultShipperId - ObjectId
|
|
documentRequirements - [DocumentRequirementInput!]
|
Document requirements for invoicing for this business entity |
documents - [DocumentInput!]
|
|
dotNumber - String
|
|
externalId - String
|
|
federalId - String
|
|
goodInventoryItems - [GoodInventoryItemInput!]
|
|
groupIds - [ObjectId!]
|
|
mcNumber - String
|
|
name - String!
|
|
notes - [BusinessEntityNoteInput!]
|
|
openingSchedules - [OpeningScheduleInput!]
|
|
parentBusinessEntityId - ObjectId
|
|
payToProfileId - ObjectId
|
|
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
|
remitAddress - NewTextualAddressInput
|
|
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
|
shipmentDocumentsToReceive - [String!]
|
|
standardCarrierAlphaCode - String
|
|
status - AssetStatus
|
|
storageFacilities - [StorageFacilityInput!]
|
|
tags - [String!]
|
|
trailerTypes - [TrailerType!]
|
Example
{
"accessToken": "abc123",
"additionalContacts": [NewContactInput],
"additionalTypes": ["BROKER"],
"address": NewAddressInput,
"billingAddress": NewTextualAddressInput,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 123.45,
"code": "abc123",
"contact": NewContactInput,
"creditTerms": "xyz789",
"customFields": [CustomFieldInput],
"defaultReferenceNumbers": [
DefaultReferenceNumberInput
],
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirementInput],
"documents": [DocumentInput],
"dotNumber": "xyz789",
"externalId": "xyz789",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItemInput],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNoteInput],
"openingSchedules": [OpeningScheduleInput],
"parentBusinessEntityId": ObjectId,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": NewTextualAddressInput,
"remitCompanyName": "abc123",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": ["abc123"],
"standardCarrierAlphaCode": "xyz789",
"status": "ACTIVE",
"storageFacilities": [StorageFacilityInput],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"]
}
NewBusinessEntityInputWithType
Fields
| Input Field | Description |
|---|---|
accessToken - String
|
|
additionalContacts - [NewContactInput!]
|
|
additionalTypes - [BusinessEntityType!]
|
|
address - NewAddressInput!
|
|
billingAddress - NewTextualAddressInput
|
|
billingEmail - String
|
|
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
|
billingWeekStartsOn - Float
|
|
code - String
|
|
contact - NewContactInput
|
|
creditTerms - String
|
|
customFields - [CustomFieldInput!]
|
|
defaultReferenceNumbers - [DefaultReferenceNumberInput!]
|
|
defaultShipperId - ObjectId
|
|
documentRequirements - [DocumentRequirementInput!]
|
Document requirements for invoicing for this business entity |
documents - [DocumentInput!]
|
|
dotNumber - String
|
|
externalId - String
|
|
federalId - String
|
|
goodInventoryItems - [GoodInventoryItemInput!]
|
|
groupIds - [ObjectId!]
|
|
mcNumber - String
|
|
name - String!
|
|
notes - [BusinessEntityNoteInput!]
|
|
openingSchedules - [OpeningScheduleInput!]
|
|
parentBusinessEntityId - ObjectId
|
|
payToProfileId - ObjectId
|
|
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
|
remitAddress - NewTextualAddressInput
|
|
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
|
shipmentDocumentsToReceive - [String!]
|
|
standardCarrierAlphaCode - String
|
|
status - AssetStatus
|
|
storageFacilities - [StorageFacilityInput!]
|
|
tags - [String!]
|
|
trailerTypes - [TrailerType!]
|
|
type - BusinessEntityType!
|
Example
{
"accessToken": "xyz789",
"additionalContacts": [NewContactInput],
"additionalTypes": ["BROKER"],
"address": NewAddressInput,
"billingAddress": NewTextualAddressInput,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 987.65,
"billingWeekStartsOn": 123.45,
"code": "abc123",
"contact": NewContactInput,
"creditTerms": "xyz789",
"customFields": [CustomFieldInput],
"defaultReferenceNumbers": [
DefaultReferenceNumberInput
],
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirementInput],
"documents": [DocumentInput],
"dotNumber": "xyz789",
"externalId": "xyz789",
"federalId": "xyz789",
"goodInventoryItems": [GoodInventoryItemInput],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNoteInput],
"openingSchedules": [OpeningScheduleInput],
"parentBusinessEntityId": ObjectId,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": NewTextualAddressInput,
"remitCompanyName": "abc123",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": ["xyz789"],
"standardCarrierAlphaCode": "xyz789",
"status": "ACTIVE",
"storageFacilities": [StorageFacilityInput],
"tags": ["abc123"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
NewContactInput
Example
{
"email": "abc123",
"extensionNumber": "xyz789",
"faxNumber": "abc123",
"firstname": "abc123",
"includeInInvoicing": true,
"lastname": "xyz789",
"middlename": "abc123",
"phoneNumber": "xyz789",
"title": "abc123",
"url": "abc123"
}
NewCustomFieldDefinitionInput
Fields
| Input Field | Description |
|---|---|
context - [CustomFieldContext!]!
|
|
description - String!
|
|
isRequirement - Boolean
|
|
key - String!
|
|
label - String!
|
|
requirementOptions - CustomFieldRequirementOptionsInput
|
|
selectOptions - [CustomFieldSelectOptionInput!]
|
|
selectOptionsEndpoint - String
|
|
selectOptionsEntity - CustomFieldSelectOptionEntity
|
|
type - CustomFieldType!
|
Example
{
"context": ["CARRIER"],
"description": "xyz789",
"isRequirement": false,
"key": "abc123",
"label": "xyz789",
"requirementOptions": CustomFieldRequirementOptionsInput,
"selectOptions": [CustomFieldSelectOptionInput],
"selectOptionsEndpoint": "abc123",
"selectOptionsEntity": "CARRIER",
"type": "BOOLEAN"
}
NewDeductionRuleInput
Fields
| Input Field | Description |
|---|---|
amount - Float!
|
|
driver - String
|
|
label - String!
|
|
method - DriverDeductionMethod!
|
|
period - DeductionPeriodInput!
|
|
type - DeductionType!
|
Example
{
"amount": 987.65,
"driver": "abc123",
"label": "abc123",
"method": "FLAT_FEE",
"period": DeductionPeriodInput,
"type": "BONUS"
}
NewDriverInput
Fields
| Input Field | Description |
|---|---|
customFields - [CustomFieldInput!]
|
|
dateOfBirth - DateTime
|
|
dateOfPhysicalExamination - DateTime
|
|
documents - [DriverDocumentInput!]
|
|
domicile - NewAddressInput
|
Where the driver starts his journey everyday |
domicileId - ObjectId
|
|
eldId - String
|
|
email - String
|
|
firstname - String!
|
|
groupIds - [ObjectId!]
|
|
hos - DriverHosInput
|
|
isOwnerOperator - Boolean
|
|
lastname - String!
|
|
license - DriverLicenseInput
|
|
medical - DriverMedicalInput
|
|
middlename - String
|
|
password - String
|
|
phoneNumber - String
|
|
status - AssetStatus
|
|
tags - [String!]
|
|
userId - String
|
|
username - String
|
Example
{
"customFields": [CustomFieldInput],
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfPhysicalExamination": "2007-12-03T10:15:30Z",
"documents": [DriverDocumentInput],
"domicile": NewAddressInput,
"domicileId": ObjectId,
"eldId": "xyz789",
"email": "abc123",
"firstname": "xyz789",
"groupIds": [ObjectId],
"hos": DriverHosInput,
"isOwnerOperator": false,
"lastname": "xyz789",
"license": DriverLicenseInput,
"medical": DriverMedicalInput,
"middlename": "xyz789",
"password": "abc123",
"phoneNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"userId": "abc123",
"username": "abc123"
}
NewDriverShiftAssignmentInput
NewDriverShiftInput
Fields
| Input Field | Description |
|---|---|
days - [Int!]!
|
|
domicileId - ObjectId
|
|
driverIds - [ObjectId!]
|
|
endTime - TimeInput!
|
|
isAdhoc - Boolean
|
Ad hoc driver shifts are one time shifts that have been assigned directly from the planning tool |
label - String
|
|
startTime - TimeInput!
|
Example
{
"days": [123],
"domicileId": ObjectId,
"driverIds": [ObjectId],
"endTime": TimeInput,
"isAdhoc": true,
"label": "xyz789",
"startTime": TimeInput
}
NewGoodProfileClassInput
NewGoodProfileInput
Fields
| Input Field | Description |
|---|---|
code - String
|
|
color - String
|
|
customFields - [CustomFieldInput!]
|
|
documents - [DocumentInput!]
|
|
equivalences - [GoodProfileEquivalenceInput!]
|
|
externalId - String
|
ID of the commodity profile in an external system. |
goodProfileClassId - ObjectId
|
|
groupIds - [ObjectId!]
|
|
label - String!
|
|
liquidGravity - Float
|
|
restrictions - [GoodProfileRestrictionInput!]
|
|
shipperIds - [String!]
|
|
supplierIds - [String!]
|
|
tags - [String!]
|
|
unit - GoodUnits!
|
|
weight - Float!
|
Example
{
"code": "abc123",
"color": "xyz789",
"customFields": [CustomFieldInput],
"documents": [DocumentInput],
"equivalences": [GoodProfileEquivalenceInput],
"externalId": "xyz789",
"goodProfileClassId": ObjectId,
"groupIds": [ObjectId],
"label": "abc123",
"liquidGravity": 123.45,
"restrictions": [GoodProfileRestrictionInput],
"shipperIds": ["abc123"],
"supplierIds": ["abc123"],
"tags": ["abc123"],
"unit": "GALLONS",
"weight": 987.65
}
NewGroupInput
Fields
| Input Field | Description |
|---|---|
description - String
|
|
memberIds - [String!]!
|
|
name - String!
|
Example
{
"description": "abc123",
"memberIds": ["xyz789"],
"name": "xyz789"
}
NewMaintenanceTaskInput
Fields
| Input Field | Description |
|---|---|
assetId - ObjectId!
|
|
assetType - String!
|
|
endDate - DateTime
|
|
label - String!
|
|
recurrence - MaintenanceTaskRecurrenceInput
|
|
required - Boolean
|
|
startDate - DateTime
|
|
startMileage - Float
|
|
status - MaintenanceTaskStatus
|
Example
{
"assetId": ObjectId,
"assetType": "abc123",
"endDate": "2007-12-03T10:15:30Z",
"label": "xyz789",
"recurrence": MaintenanceTaskRecurrenceInput,
"required": true,
"startDate": "2007-12-03T10:15:30Z",
"startMileage": 987.65,
"status": "CANCELLED"
}
NewOrderInput
Fields
| Input Field | Description |
|---|---|
customerId - ObjectId!
|
|
locations - [ShipmentLocationInput!]!
|
|
orderNumber - String
|
|
status - Status!
|
Example
{
"customerId": ObjectId,
"locations": [ShipmentLocationInput],
"orderNumber": "abc123",
"status": "ACTIVE"
}
NewOrgUserInput
Fields
| Input Field | Description |
|---|---|
attributes - UserAttributesInput
|
|
email - String
|
|
firstName - String
|
|
lastName - String
|
|
password - String
|
|
roles - [KeycloakUserRoleInput!]!
|
|
username - String!
|
Example
{
"attributes": UserAttributesInput,
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"password": "xyz789",
"roles": [KeycloakUserRoleInput],
"username": "abc123"
}
NewOrganizationDocumentInput
NewOrganizationInput
NewPaymentRuleInput
Fields
| Input Field | Description |
|---|---|
amount - Float!
|
|
driver - String
|
|
method - DriverPaymentMethod!
|
|
period - PaymentPeriodInput
|
Example
{
"amount": 987.65,
"driver": "xyz789",
"method": "PER_HOUR",
"period": PaymentPeriodInput
}
NewQualificationInput
Example
{
"assetId": ObjectId,
"assetType": "abc123",
"documents": [DocumentInput],
"endDate": "2007-12-03T10:15:30Z",
"label": "abc123",
"number": "xyz789",
"required": true,
"startDate": "2007-12-03T10:15:30Z"
}
NewReasonCodeInput
Fields
| Input Field | Description |
|---|---|
description - String
|
|
locationId - String
|
|
shipmentId - ObjectId
|
|
tripId - ObjectId
|
|
type - ReasonCodeType!
|
Example
{
"description": "xyz789",
"locationId": "abc123",
"shipmentId": ObjectId,
"tripId": ObjectId,
"type": "CUSTOMER"
}
NewReceiverForecastInput
Fields
| Input Field | Description |
|---|---|
models - [ForecastingModelInput!]!
|
|
readingsFileConfiguration - ReadingsFileConfigurationInput
|
|
receiverId - ObjectId!
|
|
trailerProfile - TrailerProfileInput!
|
Example
{
"models": [ForecastingModelInput],
"readingsFileConfiguration": ReadingsFileConfigurationInput,
"receiverId": ObjectId,
"trailerProfile": TrailerProfileInput
}
NewRelationshipInput
Fields
| Input Field | Description |
|---|---|
commodityIds - [ObjectId!]
|
|
customerIds - [ObjectId!]
|
|
receiverIds - [ObjectId!]
|
|
shipperIds - [ObjectId!]
|
|
supplierIds - [ObjectId!]
|
Example
{
"commodityIds": [ObjectId],
"customerIds": [ObjectId],
"receiverIds": [ObjectId],
"shipperIds": [ObjectId],
"supplierIds": [ObjectId]
}
NewShipmentInput
Fields
| Input Field | Description |
|---|---|
additionalTrailerTypes - [TrailerType!]
|
|
assignedCarriers - [ShipmentCarrierAssignmentInput!]
|
|
billOfLadingNumber - String
|
|
billOfLadingNumbers - [String!]
|
|
charges - [ShipmentChargeInput!]!
|
|
commodityType - ShipmentCommodityType
|
|
constraints - [ShipmentConstraintInput!]
|
|
createdBy - String
|
|
customFields - [CustomFieldInput!]
|
|
customer - ObjectId!
|
|
dailyRotationCount - Float
|
|
documents - [ShipmentDocumentInput!]
|
|
expenses - [TransactionInput!]
|
|
groupIds - [ObjectId!]
|
|
loadType - LoadType!
|
|
notes - [SingleShipmentNoteInput!]
|
|
orderId - ObjectId
|
|
postOfficeNumber - String
|
|
purchaseOrderNumbers - [String!]
|
|
rateConNumbers - [String!]
|
|
recurrence - ShipmentRecurrenceInput
|
|
referenceNumber - String
|
|
referenceNumbers - [String!]
|
|
shipmentLocations - [ShipmentLocationInput!]!
|
|
status - Status
|
|
tags - [String!]
|
|
ticketNumbers - [String!]
|
|
trailerType - TrailerType!
|
Example
{
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignmentInput],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentChargeInput],
"commodityType": "DRY",
"constraints": [ShipmentConstraintInput],
"createdBy": "abc123",
"customFields": [CustomFieldInput],
"customer": ObjectId,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocumentInput],
"expenses": [TransactionInput],
"groupIds": [ObjectId],
"loadType": "FULL_TRUCK_LOAD",
"notes": [SingleShipmentNoteInput],
"orderId": ObjectId,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"recurrence": ShipmentRecurrenceInput,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"shipmentLocations": [ShipmentLocationInput],
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["xyz789"],
"trailerType": "AUTO_CARRIER"
}
NewStorageFacilityReadingInput
NewSupplierContractInput
Fields
| Input Field | Description |
|---|---|
allocation - SupplierContractAllocationInput
|
The maximum quantities of product allowed by the contract |
conditions - [SupplierContractConditionInput!]
|
The conditions that must be met for the contract to apply |
contractNumber - String!
|
The identifier of the contract |
customerId - ObjectId
|
The id of the customer that the contract is for |
endDate - DateTime!
|
The end date of the contract. The contract cannot be used after this date |
goodProfileId - ObjectId!
|
The id of the commodity that the contract is for |
pinCode - String
|
The pin code to use the contract |
shipperId - ObjectId
|
The id of the shipper where the commodity can be picked up at |
startDate - DateTime!
|
The start date of the contract. The contract cannot be used before this date |
supplierId - ObjectId!
|
The id of the supplier that the contract is with |
unitPrice - Float!
|
The price per unit of the commodity |
usedAllocation - SupplierContractAllocationInput
|
The quantities of product used through this contract |
Example
{
"allocation": SupplierContractAllocationInput,
"conditions": [SupplierContractConditionInput],
"contractNumber": "xyz789",
"customerId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"goodProfileId": ObjectId,
"pinCode": "xyz789",
"shipperId": ObjectId,
"startDate": "2007-12-03T10:15:30Z",
"supplierId": ObjectId,
"unitPrice": 987.65,
"usedAllocation": SupplierContractAllocationInput
}
NewTextualAddressInput
Example
{
"city": "xyz789",
"country": "xyz789",
"googlePlaceId": "abc123",
"line1": "xyz789",
"line2": "abc123",
"postalCode": "abc123",
"state": "abc123"
}
NewTractorInput
Fields
| Input Field | Description |
|---|---|
customFields - [CustomFieldInput!]
|
|
documents - [DocumentInput!]
|
|
domicile - NewAddressInput
|
|
eldId - String
|
|
groupIds - [ObjectId!]
|
|
licenseNumber - String
|
|
make - String
|
|
mileage - Float
|
|
model - String
|
|
plateNumber - String
|
|
serialNumber - String!
|
|
status - AssetStatus
|
|
tags - [String!]
|
|
tareWeight - Float
|
|
year - Float
|
Example
{
"customFields": [CustomFieldInput],
"documents": [DocumentInput],
"domicile": NewAddressInput,
"eldId": "xyz789",
"groupIds": [ObjectId],
"licenseNumber": "xyz789",
"make": "abc123",
"mileage": 987.65,
"model": "xyz789",
"plateNumber": "xyz789",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"tareWeight": 987.65,
"year": 987.65
}
NewTrailerEventInput
Fields
| Input Field | Description |
|---|---|
date - DateTime!
|
|
trailerId - ObjectId!
|
|
type - TrailerEventType!
|
Example
{
"date": "2007-12-03T10:15:30Z",
"trailerId": ObjectId,
"type": "TRAILER_WASH"
}
NewTrailerInput
Fields
| Input Field | Description |
|---|---|
compartments - [TrailerCompartmentInput!]
|
|
customFields - [CustomFieldInput!]
|
|
documents - [DocumentInput!]
|
|
domicile - NewAddressInput
|
|
groupIds - [ObjectId!]
|
|
height - Float
|
|
lastKnownLocation - CoordinatesInput
|
|
length - Float
|
|
licenseNumber - String
|
|
maxTemperature - Float
|
|
maxWeight - Float
|
|
mileage - Float
|
|
minTemperature - Float
|
|
numberOfAxles - Float
|
|
serial - String
|
|
serialNumber - String!
|
|
status - AssetStatus
|
|
tags - [String!]
|
|
type - TrailerType!
|
|
vin - String
|
|
width - Float
|
Example
{
"compartments": [TrailerCompartmentInput],
"customFields": [CustomFieldInput],
"documents": [DocumentInput],
"domicile": NewAddressInput,
"groupIds": [ObjectId],
"height": 123.45,
"lastKnownLocation": CoordinatesInput,
"length": 987.65,
"licenseNumber": "abc123",
"maxTemperature": 987.65,
"maxWeight": 987.65,
"mileage": 123.45,
"minTemperature": 987.65,
"numberOfAxles": 123.45,
"serial": "abc123",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["abc123"],
"type": "AUTO_CARRIER",
"vin": "abc123",
"width": 987.65
}
NewTripInput
Fields
| Input Field | Description |
|---|---|
additionalTrailers - [ObjectId!]
|
|
carrier - String
|
|
chassis - String
|
|
customFields - [CustomFieldInput!]
|
|
driver - String
|
|
etaFromPreviousTrip - Float
|
|
etaToNextTrip - Float
|
|
shipments - [String!]!
|
|
startTime - DateTime
|
|
tags - [String!]
|
|
tractor - String
|
|
trailer - String
|
|
trailerCompartmentAssignments - [TrailerCompartmentAssignmentInput!]
|
|
violations - [TripViolationInput!]
|
Example
{
"additionalTrailers": [ObjectId],
"carrier": "xyz789",
"chassis": "xyz789",
"customFields": [CustomFieldInput],
"driver": "abc123",
"etaFromPreviousTrip": 987.65,
"etaToNextTrip": 987.65,
"shipments": ["abc123"],
"startTime": "2007-12-03T10:15:30Z",
"tags": ["abc123"],
"tractor": "abc123",
"trailer": "xyz789",
"trailerCompartmentAssignments": [
TrailerCompartmentAssignmentInput
],
"violations": [TripViolationInput]
}
NoteAccessLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CARRIER"
ObjectId
Description
A MongoDB ObjectId (hex string representation)
Example
ObjectId
OpeningSchedule
OpeningScheduleInput
Order
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
customer - BusinessEntity
|
|
customerId - ObjectId!
|
|
locations - [ShipmentLocation!]!
|
|
orderNumber - String!
|
|
shipment - Shipment
|
|
shipmentId - ObjectId
|
|
status - Status!
|
Example
{
"_id": "abc123",
"customer": BusinessEntity,
"customerId": ObjectId,
"locations": [ShipmentLocation],
"orderNumber": "abc123",
"shipment": Shipment,
"shipmentId": ObjectId,
"status": "ACTIVE"
}
OrderByDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
OrderByItem
Fields
| Input Field | Description |
|---|---|
direction - OrderByDirection!
|
|
field - String!
|
Example
{"direction": "ASC", "field": "xyz789"}
OrderPaginatedResult
OrderUpdateInput
Fields
| Input Field | Description |
|---|---|
customerId - ObjectId
|
|
locations - [ShipmentLocationInput!]
|
|
orderNumber - String
|
|
status - Status
|
Example
{
"customerId": ObjectId,
"locations": [ShipmentLocationInput],
"orderNumber": "xyz789",
"status": "ACTIVE"
}
OrgUser
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
attributes - UserAttributes!
|
|
email - String
|
|
enabled - Boolean
|
|
firstName - String
|
|
id - String!
|
|
lastName - String
|
|
roles - [KeycloakUserRole!]!
|
|
username - String!
|
Example
{
"_id": "abc123",
"attributes": UserAttributes,
"email": "xyz789",
"enabled": true,
"firstName": "abc123",
"id": "xyz789",
"lastName": "abc123",
"roles": [KeycloakUserRole],
"username": "xyz789"
}
OrgUserPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [OrgUser!]!
|
Example
{"count": 123, "data": [OrgUser]}
OrgUserUpdateInput
Fields
| Input Field | Description |
|---|---|
attributes - UserAttributesInput
|
|
email - String
|
|
firstName - String
|
|
id - String
|
|
lastName - String
|
|
password - String
|
|
roles - [KeycloakUserRoleInput!]
|
|
username - String
|
Example
{
"attributes": UserAttributesInput,
"email": "abc123",
"firstName": "xyz789",
"id": "abc123",
"lastName": "xyz789",
"password": "xyz789",
"roles": [KeycloakUserRoleInput],
"username": "abc123"
}
Organization
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
address - String
|
|
attributes - KeycloakOrganizationAttributes!
|
Use company fields directly |
contactFullname - String
|
|
displayName - String!
|
This field is the same as name |
dotNumber - String!
|
|
email - Email
|
|
id - String
|
Use _id instead |
name - String!
|
|
phoneNumber - String
|
|
realm - String!
|
This field should not be used by any client. The realm is the same accross all orgs |
Example
{
"_id": "xyz789",
"address": "xyz789",
"attributes": KeycloakOrganizationAttributes,
"contactFullname": "xyz789",
"displayName": "xyz789",
"dotNumber": "xyz789",
"email": Email,
"id": "abc123",
"name": "xyz789",
"phoneNumber": "xyz789",
"realm": "xyz789"
}
OrganizationDocument
OrganizationDocumentUpdateInput
OrganizationSettings
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
dispatching - DispatchingSettings
|
|
general - GeneralSettings
|
|
invoicing - InvoicingSettings
|
|
name - String
|
|
ratecon - RateconSettings
|
|
transactionTemplates - [TransactionInputObject!]
|
Example
{
"_id": "xyz789",
"dispatching": DispatchingSettings,
"general": GeneralSettings,
"invoicing": InvoicingSettings,
"name": "xyz789",
"ratecon": RateconSettings,
"transactionTemplates": [TransactionInputObject]
}
OrganizationSettingsInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
dispatching - DispatchingSettingsInput
|
|
general - GeneralSettingsInput
|
|
invoicing - InvoicingSettingsInput
|
|
name - String
|
|
ratecon - RateconSettingsInput
|
|
transactionTemplates - [TransactionInput!]
|
Example
{
"_id": "abc123",
"dispatching": DispatchingSettingsInput,
"general": GeneralSettingsInput,
"invoicing": InvoicingSettingsInput,
"name": "xyz789",
"ratecon": RateconSettingsInput,
"transactionTemplates": [TransactionInput]
}
OrganizationUpdateInput
PaymentMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BANK_TRANSFER"
PaymentPeriod
Description
The period over which a payment applies
Fields
| Field Name | Description |
|---|---|
end - DateTime
|
|
repeatEvery - Float!
|
|
start - DateTime!
|
|
unit - PaymentPeriodUnit!
|
Example
{
"end": "2007-12-03T10:15:30Z",
"repeatEvery": 987.65,
"start": "2007-12-03T10:15:30Z",
"unit": "DAY"
}
PaymentPeriodInput
Fields
| Input Field | Description |
|---|---|
end - DateTime
|
|
repeatEvery - Float!
|
|
start - DateTime!
|
|
unit - PaymentPeriodUnit!
|
Example
{
"end": "2007-12-03T10:15:30Z",
"repeatEvery": 123.45,
"start": "2007-12-03T10:15:30Z",
"unit": "DAY"
}
PaymentPeriodUnit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAY"
PaymentRule
Description
A driver payment rule
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
amount - Float!
|
|
driver - Driver
|
|
method - DriverPaymentMethod!
|
|
period - PaymentPeriod
|
Example
{
"_id": "abc123",
"amount": 123.45,
"driver": Driver,
"method": "PER_HOUR",
"period": PaymentPeriod
}
PaymentRulePaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [PaymentRule!]!
|
Example
{"count": 123, "data": [PaymentRule]}
PaymentRuleUpdateInput
Fields
| Input Field | Description |
|---|---|
amount - Float
|
|
driver - String
|
|
method - DriverPaymentMethod
|
|
period - PaymentPeriodInput
|
Example
{
"amount": 987.65,
"driver": "xyz789",
"method": "PER_HOUR",
"period": PaymentPeriodInput
}
Period
PeriodInput
PurchaseInput
Example
{
"customerId": ObjectId,
"date": "2007-12-03T10:15:30Z",
"dropoffLocation": CoordinatesInput,
"goodProfileId": ObjectId,
"quantity": 123.45,
"shipperId": ObjectId,
"supplierId": ObjectId
}
Qualification
Example
{
"_id": "abc123",
"assetId": ObjectId,
"assetType": "abc123",
"documents": [Document],
"endDate": "2007-12-03T10:15:30Z",
"label": "xyz789",
"number": "abc123",
"required": false,
"startDate": "2007-12-03T10:15:30Z"
}
QualificationPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Qualification!]!
|
Example
{"count": 123, "data": [Qualification]}
QualificationUpdateInput
Example
{
"assetId": ObjectId,
"assetType": "xyz789",
"documents": [DocumentInput],
"endDate": "2007-12-03T10:15:30Z",
"label": "abc123",
"number": "xyz789",
"required": true,
"startDate": "2007-12-03T10:15:30Z"
}
RateconSettings
Example
{
"bodyTemplate": "abc123",
"companyAddress": "xyz789",
"companyEmail": "abc123",
"companyPhone": "xyz789",
"subjectTemplate": "xyz789",
"termsAndConditions": "xyz789"
}
RateconSettingsInput
Example
{
"bodyTemplate": "abc123",
"companyAddress": "xyz789",
"companyEmail": "abc123",
"companyPhone": "xyz789",
"subjectTemplate": "xyz789",
"termsAndConditions": "xyz789"
}
Reading
ReadingsFileConfiguration
Fields
| Field Name | Description |
|---|---|
dateColumn - String!
|
|
dateFormat - String!
|
|
levelColumn - String!
|
|
readingDeviationCriticalThreshold - Float
|
The threshold for the difference between the last reading and the expected reading to trigger an error, in percentage |
readingDeviationDangerThreshold - Float
|
The threshold for the difference between the last reading and the expected reading to trigger an error, in percentage |
readingDeviationWarningThreshold - Float
|
The threshold for the difference between the last reading and the expected reading to trigger a warning, in percentage |
runoutCriticalThreshold - Float
|
|
runoutDangerThreshold - Float
|
|
runoutWarningThreshold - Float
|
|
staleReadingCriticalThreshold - Float
|
The threshold for the difference between the last reading and the current reading to trigger an error, in minutes |
staleReadingDangerThreshold - Float
|
The threshold for the difference between the last reading and the current reading to trigger an error, in minutes |
staleReadingWarningThreshold - Float
|
The threshold for the difference between the last reading and the current reading to trigger a warning, in minutes |
storeColumn - String
|
|
tankIdColumn - String!
|
|
timeColumn - String!
|
|
timeFormat - String!
|
Example
{
"dateColumn": "xyz789",
"dateFormat": "xyz789",
"levelColumn": "abc123",
"readingDeviationCriticalThreshold": 123.45,
"readingDeviationDangerThreshold": 987.65,
"readingDeviationWarningThreshold": 123.45,
"runoutCriticalThreshold": 987.65,
"runoutDangerThreshold": 123.45,
"runoutWarningThreshold": 987.65,
"staleReadingCriticalThreshold": 987.65,
"staleReadingDangerThreshold": 123.45,
"staleReadingWarningThreshold": 123.45,
"storeColumn": "abc123",
"tankIdColumn": "xyz789",
"timeColumn": "abc123",
"timeFormat": "abc123"
}
ReadingsFileConfigurationInput
Fields
| Input Field | Description |
|---|---|
dateColumn - String!
|
|
dateFormat - String!
|
|
levelColumn - String!
|
|
readingDeviationCriticalThreshold - Float
|
The threshold for the difference between the last reading and the expected reading to trigger an error, in percentage |
readingDeviationDangerThreshold - Float
|
The threshold for the difference between the last reading and the expected reading to trigger an error, in percentage |
readingDeviationWarningThreshold - Float
|
The threshold for the difference between the last reading and the expected reading to trigger a warning, in percentage |
runoutCriticalThreshold - Float
|
|
runoutDangerThreshold - Float
|
|
runoutWarningThreshold - Float
|
|
staleReadingCriticalThreshold - Float
|
The threshold for the difference between the last reading and the current reading to trigger an error, in minutes |
staleReadingDangerThreshold - Float
|
The threshold for the difference between the last reading and the current reading to trigger an error, in minutes |
staleReadingWarningThreshold - Float
|
The threshold for the difference between the last reading and the current reading to trigger a warning, in minutes |
storeColumn - String
|
|
tankIdColumn - String!
|
|
timeColumn - String!
|
|
timeFormat - String!
|
Example
{
"dateColumn": "abc123",
"dateFormat": "abc123",
"levelColumn": "abc123",
"readingDeviationCriticalThreshold": 123.45,
"readingDeviationDangerThreshold": 123.45,
"readingDeviationWarningThreshold": 987.65,
"runoutCriticalThreshold": 123.45,
"runoutDangerThreshold": 123.45,
"runoutWarningThreshold": 123.45,
"staleReadingCriticalThreshold": 123.45,
"staleReadingDangerThreshold": 123.45,
"staleReadingWarningThreshold": 123.45,
"storeColumn": "xyz789",
"tankIdColumn": "abc123",
"timeColumn": "abc123",
"timeFormat": "abc123"
}
ReasonCode
Example
{
"_id": ObjectId,
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": "xyz789",
"description": "abc123",
"locationId": "xyz789",
"shipmentId": ObjectId,
"tripId": ObjectId,
"type": "CUSTOMER",
"updatedAt": "2007-12-03T10:15:30Z"
}
ReasonCodePaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [ReasonCode!]!
|
Example
{"count": 987, "data": [ReasonCode]}
ReasonCodeType
Description
Types of reason codes for exceptional situations
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOMER"
ReasonCodeUpdateInput
Receiver
Description
A Receiver Business entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
accessToken - String
|
Token used for access to the customer portal |
additionalContacts - [Contact!]
|
Additional contacts for the business entity. |
additionalTypes - [BusinessEntityType!]
|
Additional types for the business entity (e.g. a business entity could be both a customer and shipper). |
address - Address!
|
Physical address of the business entity. |
addressTimezone - String
|
Timezone of the business entity address. If not provided, it will be inferred from the address. |
billingAddress - TextualAddress
|
Billing address for the business entity. |
billingEmail - String
|
Billing email for the business entity. Invoices are sent here |
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
Billing terms for the business entity in days. |
billingWeekStartsOn - Float
|
|
code - String
|
Unique code identifying the business entity. |
contact - Contact!
|
Primary contact for the business entity. |
creditTerms - String
|
For carriers only, the credit terms they offer. |
customFields - [CustomField!]
|
Custom fields for the business entity |
defaultReferenceNumbers - [DefaultReferenceNumber!]
|
|
defaultShipper - BusinessEntity
|
The default shipper for this business entity |
defaultShipperId - ObjectId
|
ID of the default shipper for this business entity. This is used by default when a shipment is sent to this business entity |
documentRequirements - [DocumentRequirement!]
|
Document requirements for invoicing for this business entity |
documents - [Document!]
|
Documents for the business entity |
dotNumber - String
|
DOT Number for carriers and brokers |
externalId - String
|
ID of the business entity in an external system. |
federalId - String
|
Federal ID for carriers |
goodInventoryItems - [GoodInventoryItem!]
|
|
groupIds - [ObjectId!]
|
IDs of the groups that this business entity belongs to |
mcNumber - String
|
MC Number for carriers |
name - String!
|
Legal name of the business entity. |
notes - [BusinessEntityNote!]
|
|
openingSchedules - [OpeningSchedule!]
|
Opening schedules for the business entity. |
parentBusinessEntity - BusinessEntity
|
The business entity that this business entity belongs to |
parentBusinessEntityId - ObjectId
|
ID of the business entity that this business entity belongs to. Used for receiver/customer relations for example |
payToProfile - BusinessEntity
|
The business entity that we need to pay to. Used for carriers |
payToProfileId - ObjectId
|
ID of the business entity that we need to pay to. Used for carriers |
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
For customers and brokers, the types of reference numbers they use in orders. |
remitAddress - TextualAddress
|
Remit address for the business entity. Where payments are sent. |
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
Remit email for the business entity |
shipmentDocumentsToReceive - [String!]
|
Shipmentp documents to receive via email on completion |
standardCarrierAlphaCode - String
|
SCAC code for carriers |
status - AssetStatus!
|
|
storageFacilities - [StorageFacility!]
|
Storage facilities for the business entity. Used for tanks, warehouses, etc |
Arguments
|
|
tags - [String!]
|
Tags for the business entity |
trailerTypes - [TrailerType!]
|
For carriers only, the types of trailers they have. |
type - BusinessEntityType!
|
The type of business entity. |
Example
{
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "abc123",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 123.45,
"code": "xyz789",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "abc123",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "abc123",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "xyz789",
"remitEmail": "abc123",
"shipmentDocumentsToReceive": ["xyz789"],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
ReceiverForecast
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
models - [ForecastingModel!]!
|
|
readingsFileConfiguration - ReadingsFileConfiguration
|
|
receiver - BusinessEntity
|
|
receiverId - ObjectId!
|
|
trailerProfile - TrailerProfile!
|
Example
{
"_id": "abc123",
"models": [ForecastingModel],
"readingsFileConfiguration": ReadingsFileConfiguration,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"trailerProfile": TrailerProfile
}
ReceiverForecastPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [ReceiverForecast!]!
|
Example
{"count": 987, "data": [ReceiverForecast]}
ReceiverForecastUpdateInput
Fields
| Input Field | Description |
|---|---|
models - [ForecastingModelInput!]
|
|
readingsFileConfiguration - ReadingsFileConfigurationInput
|
|
receiverId - ObjectId
|
|
trailerProfile - TrailerProfileInput
|
Example
{
"models": [ForecastingModelInput],
"readingsFileConfiguration": ReadingsFileConfigurationInput,
"receiverId": ObjectId,
"trailerProfile": TrailerProfileInput
}
ReceiverPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Receiver!]!
|
Example
{"count": 123, "data": [Receiver]}
Relationship
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
commodities - [GoodProfile!]
|
|
commodityIds - [ObjectId!]
|
|
customerIds - [ObjectId!]
|
|
customers - [BusinessEntity!]
|
|
receiverIds - [ObjectId!]
|
|
receivers - [BusinessEntity!]
|
|
shipperIds - [ObjectId!]
|
|
shippers - [BusinessEntity!]
|
|
supplierIds - [ObjectId!]
|
|
suppliers - [BusinessEntity!]
|
Example
{
"_id": "abc123",
"commodities": [GoodProfile],
"commodityIds": [ObjectId],
"customerIds": [ObjectId],
"customers": [BusinessEntity],
"receiverIds": [ObjectId],
"receivers": [BusinessEntity],
"shipperIds": [ObjectId],
"shippers": [BusinessEntity],
"supplierIds": [ObjectId],
"suppliers": [BusinessEntity]
}
RelationshipPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Relationship!]!
|
Example
{"count": 123, "data": [Relationship]}
RelationshipUpdateInput
Fields
| Input Field | Description |
|---|---|
commodityIds - [ObjectId!]
|
|
customerIds - [ObjectId!]
|
|
receiverIds - [ObjectId!]
|
|
shipperIds - [ObjectId!]
|
|
supplierIds - [ObjectId!]
|
Example
{
"commodityIds": [ObjectId],
"customerIds": [ObjectId],
"receiverIds": [ObjectId],
"shipperIds": [ObjectId],
"supplierIds": [ObjectId]
}
RemoveShipmentFromTripResult
Fields
| Field Name | Description |
|---|---|
trip - Trip
|
Example
{"trip": Trip}
ReportData
Fields
| Field Name | Description |
|---|---|
data - [ReportItem!]!
|
|
period - Period
|
|
xAxisLabel - String!
|
Example
{
"data": [ReportItem],
"period": Period,
"xAxisLabel": "abc123"
}
ReportFilter
Description
A MongoDB like filter to apply to the documents before generating the report
Example
ReportFilter
ReportItem
Fields
| Field Name | Description |
|---|---|
_id - ReportItemId!
|
|
values - ReportItemValue!
|
Example
{
"_id": ReportItemId,
"values": ReportItemValue
}
ReportItemId
ReportItemValue
Description
The value for a report item
Example
ReportItemValue
ReportPdf
Fields
| Field Name | Description |
|---|---|
url - String!
|
Example
{"url": "abc123"}
ReportType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOMER_REVENUE"
S3_OPERATION
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"getObject"
SaveTripInput
Fields
| Input Field | Description |
|---|---|
additionalTrailers - [ObjectId!]
|
|
carrier - ObjectId
|
|
chassis - ObjectId
|
|
customFields - [CustomFieldInput!]
|
|
deadheadDistance - Float
|
|
distanceToEnd - Float!
|
|
distanceToStart - Float!
|
|
driver - ObjectId
|
|
etaFromPreviousTrip - Float
|
|
etaToNextTrip - Float
|
|
firstPickupTime - DateTime
|
|
lastDropoffTime - DateTime
|
|
lastTrafficCheck - DateTime
|
|
lastTrailerLocation - CoordinatesInput
|
|
lastTrailerLocationDate - DateTime
|
|
lastWeatherCheck - DateTime
|
|
loadedDistance - Float
|
|
polyline - String!
|
|
predictedLoadedDistance - Float
|
|
routeDistance - Float!
|
|
shipmentLocations - [TripShipmentLocationInput!]!
|
|
shipments - [ObjectId!]
|
|
status - Status!
|
|
tags - [String!]
|
|
totalDistance - Float
|
|
tractor - ObjectId
|
|
trailer - ObjectId
|
|
trailerCompartmentAssignments - [TrailerCompartmentAssignmentInput!]
|
|
violations - [TripViolationInput!]
|
Example
{
"additionalTrailers": [ObjectId],
"carrier": ObjectId,
"chassis": ObjectId,
"customFields": [CustomFieldInput],
"deadheadDistance": 987.65,
"distanceToEnd": 123.45,
"distanceToStart": 987.65,
"driver": ObjectId,
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": CoordinatesInput,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadedDistance": 987.65,
"polyline": "xyz789",
"predictedLoadedDistance": 123.45,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocationInput],
"shipments": [ObjectId],
"status": "ACTIVE",
"tags": ["xyz789"],
"totalDistance": 987.65,
"tractor": ObjectId,
"trailer": ObjectId,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignmentInput
],
"violations": [TripViolationInput]
}
SendRateconResult
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
Example
{"success": true}
SendReportResult
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
Example
{"success": true}
Shipment
Description
Shipment entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
additionalTrailerTypes - [TrailerType!]
|
Additional trailer types that can be used for the shipment |
assignedCarriers - [ShipmentCarrierAssignment!]
|
Carriers assigned to the shipment |
billOfLadingNumber - String
|
Bill of lading number for the shipment Use billfOfLadingNumbers instead |
billOfLadingNumbers - [String!]
|
Bill of lading numbers for the shipment |
charges - [ShipmentCharge!]!
|
Charges associated with the shipment. This is used to bill the customer |
childShipmentIds - [String!]
|
For a recurrent or split shipment, the IDs of the child shipments |
commodityType - ShipmentCommodityType
|
Type of commodity being shipped. This affects what trailer types can be used |
constraints - [ShipmentConstraint!]
|
Constraints that must be satisfied for the shipment |
createdBy - String!
|
ID of the user who created the shipment |
customFields - [CustomField!]
|
Custom fields associated with the shipment |
customer - BusinessEntity!
|
ID of the customer for whom the shipment is created |
dailyRotationCount - Float
|
For shipments recurring daily, the number of rotations per day |
documents - [ShipmentDocument!]
|
Documents associated with the shipment |
events - [ShipmentEvent!]
|
Events loged by the driver for this shipment |
expenses - [Transaction!]
|
Expenses associated with the shipment |
groupIds - [ObjectId!]
|
IDs of the groups the shipment is associated with |
isApplicableChargeOrderCancellation - Boolean
|
Whether the shipment is applicable for charge order cancellation |
isFromRotation - Boolean
|
Set for child shipments of a master shipment with rotations |
isFromSplit - Boolean
|
Whether the shipment is a child of a split shipment |
isSplit - Boolean
|
Whether the shipment is a split shipment or not |
issues - [ShipmentIssue!]
|
Issues reported by the driver for this shipment |
loadType - LoadType!
|
Full truck load or less than truck load shipment type. Full truck load shipments can't be mixed with other shipments on the same trip |
notes - [ShipmentNote!]
|
Notes associated with the shipment |
order - Order
|
Order the shipment is created from |
orderId - ObjectId
|
ID of the order the shipment is created from |
parentShipment - Shipment
|
For child shipments of a recurrent shipment, the master shipment |
postOfficeNumber - String
|
Purchase order number for the shipment Use purchaseOrderNumbers instead |
purchaseOrderNumbers - [String!]
|
Purchase order numbers for the shipment |
rateConNumbers - [String!]
|
Rate confirmation numbers for the shipment |
reasonForCancellation - String
|
For cancelled shipments, the reason for cancellation |
recurrence - ShipmentRecurrence
|
For recurrent shipments, the recurrence pattern |
referenceNumber - String
|
Reference number for the shipment Use referenceNumbers instead |
referenceNumbers - [String!]
|
Reference numbers for the shipment |
rotationIndex - Float
|
Set for child shipments of a master shipment with rotations |
route - ShipmentRoute
|
Route information for the shipment |
shipmentLocations - [ShipmentLocation!]!
|
Locations that need to be visited for the shipment |
shipmentNumber - String!
|
Auto incremented number for the shipment |
status - Status!
|
Current status of the shipment |
tags - [String!]
|
Tags associated with the shipment |
ticketNumbers - [String!]
|
Ticket numbers for the shipment |
trackingEmailsSent - Boolean
|
Whether tracking emails have been sent for the shipment |
trailerType - TrailerType!
|
Type of trailer required for the shipment |
trip - ShipmentTrip
|
Trip information for the shipment |
tripId - String
|
ID of the trip the shipment is assigned to |
Example
{
"_id": "abc123",
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignment],
"billOfLadingNumber": "abc123",
"billOfLadingNumbers": ["abc123"],
"charges": [ShipmentCharge],
"childShipmentIds": ["abc123"],
"commodityType": "DRY",
"constraints": [ShipmentConstraint],
"createdBy": "xyz789",
"customFields": [CustomField],
"customer": BusinessEntity,
"dailyRotationCount": 123.45,
"documents": [ShipmentDocument],
"events": [ShipmentEvent],
"expenses": [Transaction],
"groupIds": [ObjectId],
"isApplicableChargeOrderCancellation": true,
"isFromRotation": false,
"isFromSplit": true,
"isSplit": true,
"issues": [ShipmentIssue],
"loadType": "FULL_TRUCK_LOAD",
"notes": [ShipmentNote],
"order": Order,
"orderId": ObjectId,
"parentShipment": Shipment,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["xyz789"],
"reasonForCancellation": "xyz789",
"recurrence": ShipmentRecurrence,
"referenceNumber": "xyz789",
"referenceNumbers": ["xyz789"],
"rotationIndex": 987.65,
"route": ShipmentRoute,
"shipmentLocations": [ShipmentLocation],
"shipmentNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["abc123"],
"trackingEmailsSent": true,
"trailerType": "AUTO_CARRIER",
"trip": ShipmentTrip,
"tripId": "abc123"
}
ShipmentCarrierAssignment
ShipmentCarrierAssignmentInput
ShipmentCharge
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
billingRule - BillingRule
|
Billing rule for this charge |
chargeType - ChargeType
|
Type of charge |
customFields - [CustomField!]
|
Custom fields for the transaction |
document - TransactionDocument
|
Document for the transaction |
label - String!
|
Label of the transaction |
number - String
|
Transaction number |
rate - Float!
|
Rate per unit |
reimburseToDriver - Boolean
|
Whether to reimburse to driver |
relatedTransactionId - ObjectId
|
Related transaction ID |
shipmentId - ObjectId
|
Shipment ID this charge is for |
taxable - Boolean
|
Whether the transaction is taxable |
total - Float!
|
Total amount of the charge |
type - TransactionType
|
Type of transaction |
unit - Float!
|
Number of units |
unitType - String!
|
Unit type for the transaction |
Example
{
"_id": "xyz789",
"billingRule": BillingRule,
"chargeType": "ACCESSORIAL",
"customFields": [CustomField],
"document": TransactionDocument,
"label": "xyz789",
"number": "abc123",
"rate": 123.45,
"reimburseToDriver": false,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": true,
"total": 987.65,
"type": "EXPENSE",
"unit": 987.65,
"unitType": "abc123"
}
ShipmentChargeInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
billingRule - String
|
|
chargeType - ChargeType
|
Type of charge. Default = LINEHAUL |
customFields - [CustomFieldInput!]
|
|
document - TransactionDocumentInput
|
|
label - String!
|
|
rate - Float!
|
|
reimburseToDriver - Boolean
|
|
relatedTransactionId - ObjectId
|
|
shipmentId - ObjectId
|
Shipment ID this charge is for |
taxable - Boolean
|
|
type - TransactionType
|
|
unit - Float!
|
|
unitType - String!
|
Example
{
"_id": "xyz789",
"billingRule": "xyz789",
"chargeType": "ACCESSORIAL",
"customFields": [CustomFieldInput],
"document": TransactionDocumentInput,
"label": "xyz789",
"rate": 123.45,
"reimburseToDriver": false,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": true,
"type": "EXPENSE",
"unit": 987.65,
"unitType": "abc123"
}
ShipmentCommodityType
Description
The type of commodity to be delivered in the shipment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DRY"
ShipmentConstraint
Fields
| Field Name | Description |
|---|---|
type - ShipmentConstraintType!
|
|
unit - String
|
|
value - String!
|
Example
{
"type": "HEIGHT",
"unit": "xyz789",
"value": "xyz789"
}
ShipmentConstraintInput
Fields
| Input Field | Description |
|---|---|
type - ShipmentConstraintType!
|
|
unit - String
|
|
value - String!
|
Example
{
"type": "HEIGHT",
"unit": "xyz789",
"value": "abc123"
}
ShipmentConstraintType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HEIGHT"
ShipmentDeleteInput
ShipmentDocument
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
accessLevel - [NoteAccessLevel!]!
|
|
associatedCharge - String
|
|
createdAt - DateTime!
|
|
createdBy - String!
|
|
isBillable - Boolean!
|
|
lastUpdatedBy - String!
|
|
name - String!
|
|
receiver - BusinessEntity
|
|
shipper - BusinessEntity
|
|
type - String!
|
The type of document (BOL, DELIVERY_RECEIPT, etc.) |
updatedAt - DateTime!
|
|
url - String!
|
Example
{
"_id": "abc123",
"accessLevel": ["CARRIER"],
"associatedCharge": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": "abc123",
"isBillable": false,
"lastUpdatedBy": "abc123",
"name": "xyz789",
"receiver": BusinessEntity,
"shipper": BusinessEntity,
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"url": "abc123"
}
ShipmentDocumentInfoInput
Example
{
"accessLevel": ["CARRIER"],
"associatedCharge": "xyz789",
"isBillable": true,
"name": "xyz789",
"receiver": "abc123",
"shipper": "abc123",
"type": "xyz789",
"url": "xyz789"
}
ShipmentDocumentInput
Example
{
"accessLevel": ["CARRIER"],
"associatedCharge": "abc123",
"isBillable": true,
"name": "xyz789",
"receiver": "xyz789",
"shipment": "abc123",
"shipper": "abc123",
"type": "abc123",
"url": "abc123"
}
ShipmentEvent
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
coordinates - Coordinates
|
|
createdBy - String!
|
|
date - DateTime!
|
|
description - String
|
|
label - String
|
|
metadata - JSON
|
|
shipmentLocation - String
|
|
tripShipmentLocation - String
|
|
type - ShipmentEventType!
|
Example
{
"_id": "abc123",
"coordinates": Coordinates,
"createdBy": "xyz789",
"date": "2007-12-03T10:15:30Z",
"description": "xyz789",
"label": "xyz789",
"metadata": {},
"shipmentLocation": "abc123",
"tripShipmentLocation": "abc123",
"type": "CHECK_CALL"
}
ShipmentEventInput
Example
{
"_id": "abc123",
"date": "2007-12-03T10:15:30Z",
"description": "xyz789",
"label": "abc123",
"location": CoordinatesInput,
"metadata": {},
"shipment": "abc123",
"shipmentLocation": "abc123",
"trip": "abc123",
"tripShipmentLocation": "xyz789",
"type": "CHECK_CALL"
}
ShipmentEventType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHECK_CALL"
ShipmentIssue
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
attachedDocuments - [String!]!
|
|
content - String!
|
|
coordinates - Coordinates
|
|
createdBy - String
|
|
date - DateTime!
|
|
delayAmount - Float
|
|
shipmentLocation - String
|
|
type - String!
|
Example
{
"_id": "xyz789",
"attachedDocuments": ["xyz789"],
"content": "abc123",
"coordinates": Coordinates,
"createdBy": "xyz789",
"date": "2007-12-03T10:15:30Z",
"delayAmount": 123.45,
"shipmentLocation": "abc123",
"type": "abc123"
}
ShipmentIssueInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
attachedDocuments - [String!]!
|
|
content - String!
|
|
delayAmount - Float
|
|
location - CoordinatesInput!
|
|
shipment - String!
|
|
shipmentLocation - String
|
|
type - String!
|
Example
{
"_id": "xyz789",
"attachedDocuments": ["xyz789"],
"content": "xyz789",
"delayAmount": 123.45,
"location": CoordinatesInput,
"shipment": "xyz789",
"shipmentLocation": "xyz789",
"type": "abc123"
}
ShipmentLocation
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
addressLabel - String
|
|
addressTimezone - String
|
|
location - Coordinates!
|
|
locationType - ShipmentLocationType!
|
|
name - String
|
|
receivedGoods - [GoodDistribution!]
|
|
receiver - BusinessEntity
|
|
shippedGoods - [Good!]
|
|
shipper - BusinessEntity
|
|
timeWindows - [DateTimeWindow!]!
|
|
trafficInfo - LocationTraffic
|
|
weatherInfo - LocationWeather
|
Example
{
"_id": "xyz789",
"addressLabel": "abc123",
"addressTimezone": "xyz789",
"location": Coordinates,
"locationType": "BREAK",
"name": "abc123",
"receivedGoods": [GoodDistribution],
"receiver": BusinessEntity,
"shippedGoods": [Good],
"shipper": BusinessEntity,
"timeWindows": [DateTimeWindow],
"trafficInfo": LocationTraffic,
"weatherInfo": LocationWeather
}
ShipmentLocationInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
addressLabel - String
|
|
addressTimezone - String
|
|
location - CoordinatesInput!
|
|
locationType - ShipmentLocationType!
|
|
name - String
|
|
receivedGoods - [GoodDistributionInput!]!
|
|
receiver - String
|
|
shippedGoods - [GoodInput!]!
|
|
shipper - String
|
|
timeWindows - [DateTimeWindowInput!]!
|
Example
{
"_id": "abc123",
"addressLabel": "abc123",
"addressTimezone": "abc123",
"location": CoordinatesInput,
"locationType": "BREAK",
"name": "xyz789",
"receivedGoods": [GoodDistributionInput],
"receiver": "xyz789",
"shippedGoods": [GoodInput],
"shipper": "xyz789",
"timeWindows": [DateTimeWindowInput]
}
ShipmentLocationInputForPlanning
ShipmentLocationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BREAK"
ShipmentLocationWithShipment
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
addressLabel - String
|
|
addressTimezone - String
|
|
location - Coordinates!
|
|
locationType - ShipmentLocationType!
|
|
name - String
|
|
receivedGoods - [GoodDistribution!]
|
|
receiver - BusinessEntity
|
|
shipment - Shipment!
|
|
shippedGoods - [Good!]
|
|
shipper - BusinessEntity
|
|
timeWindows - [DateTimeWindow!]!
|
|
trafficInfo - LocationTraffic
|
|
weatherInfo - LocationWeather
|
Example
{
"_id": "abc123",
"addressLabel": "xyz789",
"addressTimezone": "abc123",
"location": Coordinates,
"locationType": "BREAK",
"name": "abc123",
"receivedGoods": [GoodDistribution],
"receiver": BusinessEntity,
"shipment": Shipment,
"shippedGoods": [Good],
"shipper": BusinessEntity,
"timeWindows": [DateTimeWindow],
"trafficInfo": LocationTraffic,
"weatherInfo": LocationWeather
}
ShipmentNote
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
accessLevel - [NoteAccessLevel!]!
|
|
content - String!
|
|
createdAt - DateTime!
|
|
createdBy - String!
|
|
lastUpdatedBy - String!
|
|
receiver - BusinessEntity
|
|
shipper - BusinessEntity
|
|
updatedAt - DateTime!
|
Example
{
"_id": "abc123",
"accessLevel": ["CARRIER"],
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"createdBy": "xyz789",
"lastUpdatedBy": "xyz789",
"receiver": BusinessEntity,
"shipper": BusinessEntity,
"updatedAt": "2007-12-03T10:15:30Z"
}
ShipmentNoteInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
accessLevel - [NoteAccessLevel!]!
|
|
content - String!
|
|
receiver - String
|
|
shipper - String
|
Example
{
"_id": "abc123",
"accessLevel": ["CARRIER"],
"content": "xyz789",
"receiver": "abc123",
"shipper": "abc123"
}
ShipmentPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Shipment!]!
|
Example
{"count": 987, "data": [Shipment]}
ShipmentRecurrence
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
byhour - [Float!]
|
|
byminute - [Float!]
|
|
bymonth - [Float!]
|
|
bymonthday - [Float!]
|
|
bynmonthday - [Float!]
|
|
bysecond - [Float!]
|
|
bysetpos - [Float!]
|
|
byweekday - [ShipmentRecurrenceWeekday!]
|
|
byweekno - [Float!]
|
|
byyearday - [Float!]
|
|
count - Float
|
|
dtstart - DateTime!
|
|
freq - Frequency!
|
|
interval - Float!
|
|
tzid - String
|
|
until - DateTime!
|
Example
{
"_id": "xyz789",
"byhour": [123.45],
"byminute": [987.65],
"bymonth": [123.45],
"bymonthday": [987.65],
"bynmonthday": [123.45],
"bysecond": [123.45],
"bysetpos": [987.65],
"byweekday": [ShipmentRecurrenceWeekday],
"byweekno": [123.45],
"byyearday": [123.45],
"count": 987.65,
"dtstart": "2007-12-03T10:15:30Z",
"freq": "DAILY",
"interval": 123.45,
"tzid": "xyz789",
"until": "2007-12-03T10:15:30Z"
}
ShipmentRecurrenceInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
byhour - [Float!]
|
|
byminute - [Float!]
|
|
bymonth - [Float!]
|
|
bymonthday - [Float!]
|
|
bynmonthday - [Float!]
|
|
bysecond - [Float!]
|
|
bysetpos - [Float!]
|
|
byweekday - [ShipmentRecurrenceWeekdayInput!]
|
|
byweekno - [Float!]
|
|
byyearday - [Float!]
|
|
count - Float
|
|
dtstart - DateTime!
|
|
freq - Frequency!
|
|
interval - Float!
|
|
tzid - String
|
|
until - DateTime!
|
Example
{
"_id": "abc123",
"byhour": [987.65],
"byminute": [987.65],
"bymonth": [123.45],
"bymonthday": [123.45],
"bynmonthday": [123.45],
"bysecond": [987.65],
"bysetpos": [987.65],
"byweekday": [ShipmentRecurrenceWeekdayInput],
"byweekno": [123.45],
"byyearday": [987.65],
"count": 123.45,
"dtstart": "2007-12-03T10:15:30Z",
"freq": "DAILY",
"interval": 123.45,
"tzid": "xyz789",
"until": "2007-12-03T10:15:30Z"
}
ShipmentRecurrenceWeekday
ShipmentRecurrenceWeekdayInput
ShipmentReferenceNumberType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BILL_OF_LADING_NUMBER"
ShipmentReferencesUpdateInput
Example
{
"billOfLadingNumbers": ["abc123"],
"purchaseOrderNumbers": ["xyz789"],
"rateConNumbers": ["abc123"],
"referenceNumbers": ["abc123"],
"ticketNumbers": ["xyz789"]
}
ShipmentRoute
Fields
| Field Name | Description |
|---|---|
distanceToEnd - Float!
|
|
distanceToStart - Float!
|
|
firstPickupTime - DateTime!
|
|
lastDropoffTime - DateTime!
|
|
locations - [TripShipmentLocation!]
|
|
predictedLoadedDistance - Float
|
|
routeDistance - Float!
|
|
violations - [TripViolation!]
|
Example
{
"distanceToEnd": 123.45,
"distanceToStart": 123.45,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"locations": [TripShipmentLocation],
"predictedLoadedDistance": 987.65,
"routeDistance": 987.65,
"violations": [TripViolation]
}
ShipmentSort
Fields
| Input Field | Description |
|---|---|
criteria - ShipmentSortCriteria!
|
|
desc - Boolean
|
Example
{"criteria": "DROPOFF_DATE", "desc": true}
ShipmentSortCriteria
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DROPOFF_DATE"
ShipmentTrackingInfos
Fields
| Field Name | Description |
|---|---|
lastKnownTrailerLocation - Coordinates
|
Use trip.lastTrailerLocation directly |
shipment - Shipment!
|
|
trip - Trip
|
Example
{
"lastKnownTrailerLocation": Coordinates,
"shipment": Shipment,
"trip": Trip
}
ShipmentTrip
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
additionalTrailers - [String!]
|
|
carrier - String
|
|
carrierEntity - Carrier
|
|
deadheadDistance - Float
|
|
distanceToEnd - Float!
|
|
distanceToStart - Float!
|
|
driver - String
|
|
driverEntity - Driver
|
|
etaFromPreviousTrip - Float
|
|
etaToNextTrip - Float
|
|
firstPickupTime - DateTime
|
|
lastDropoffTime - DateTime
|
|
loadedDistance - Float
|
|
polyline - String!
|
|
routeDistance - Float!
|
|
shipmentLocations - [TripShipmentLocation!]!
|
|
status - Status!
|
|
totalDistance - Float
|
|
tractor - String
|
|
tractorEntity - Tractor
|
|
trailer - String
|
|
trailerEntity - Trailer
|
|
tripNumber - String
|
|
violations - [TripViolation!]
|
Example
{
"_id": "abc123",
"additionalTrailers": ["abc123"],
"carrier": "xyz789",
"carrierEntity": Carrier,
"deadheadDistance": 123.45,
"distanceToEnd": 987.65,
"distanceToStart": 987.65,
"driver": "xyz789",
"driverEntity": Driver,
"etaFromPreviousTrip": 123.45,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"loadedDistance": 987.65,
"polyline": "abc123",
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"status": "ACTIVE",
"totalDistance": 987.65,
"tractor": "abc123",
"tractorEntity": Tractor,
"trailer": "xyz789",
"trailerEntity": Trailer,
"tripNumber": "abc123",
"violations": [TripViolation]
}
ShipmentUpdateInput
Fields
| Input Field | Description |
|---|---|
additionalTrailerTypes - [TrailerType!]
|
|
assignedCarriers - [ShipmentCarrierAssignmentInput!]
|
|
billOfLadingNumber - String
|
|
billOfLadingNumbers - [String!]
|
|
charges - [ShipmentChargeInput!]
|
|
commodityType - ShipmentCommodityType
|
|
constraints - [ShipmentConstraintInput!]
|
|
createdBy - String
|
|
customFields - [CustomFieldInput!]
|
|
customer - ObjectId
|
|
dailyRotationCount - Float
|
|
documents - [ShipmentDocumentInput!]
|
|
expenses - [TransactionInput!]
|
|
groupIds - [ObjectId!]
|
|
loadType - LoadType
|
|
notes - [SingleShipmentNoteInput!]
|
|
orderId - ObjectId
|
|
postOfficeNumber - String
|
|
purchaseOrderNumbers - [String!]
|
|
rateConNumbers - [String!]
|
|
recurrence - ShipmentRecurrenceInput
|
|
referenceNumber - String
|
|
referenceNumbers - [String!]
|
|
shipmentLocations - [ShipmentLocationInput!]
|
|
status - Status
|
|
tags - [String!]
|
|
ticketNumbers - [String!]
|
|
trailerType - TrailerType
|
Example
{
"additionalTrailerTypes": ["AUTO_CARRIER"],
"assignedCarriers": [ShipmentCarrierAssignmentInput],
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["xyz789"],
"charges": [ShipmentChargeInput],
"commodityType": "DRY",
"constraints": [ShipmentConstraintInput],
"createdBy": "abc123",
"customFields": [CustomFieldInput],
"customer": ObjectId,
"dailyRotationCount": 987.65,
"documents": [ShipmentDocumentInput],
"expenses": [TransactionInput],
"groupIds": [ObjectId],
"loadType": "FULL_TRUCK_LOAD",
"notes": [SingleShipmentNoteInput],
"orderId": ObjectId,
"postOfficeNumber": "abc123",
"purchaseOrderNumbers": ["abc123"],
"rateConNumbers": ["abc123"],
"recurrence": ShipmentRecurrenceInput,
"referenceNumber": "xyz789",
"referenceNumbers": ["abc123"],
"shipmentLocations": [ShipmentLocationInput],
"status": "ACTIVE",
"tags": ["abc123"],
"ticketNumbers": ["xyz789"],
"trailerType": "AUTO_CARRIER"
}
Shipper
Description
A Shipper Business entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
accessToken - String
|
Token used for access to the customer portal |
additionalContacts - [Contact!]
|
Additional contacts for the business entity. |
additionalTypes - [BusinessEntityType!]
|
Additional types for the business entity (e.g. a business entity could be both a customer and shipper). |
address - Address!
|
Physical address of the business entity. |
addressTimezone - String
|
Timezone of the business entity address. If not provided, it will be inferred from the address. |
billingAddress - TextualAddress
|
Billing address for the business entity. |
billingEmail - String
|
Billing email for the business entity. Invoices are sent here |
billingInvoiceConsolidationCriteria - InvoiceConsolidationCriteria
|
Criteria for invoice consolidation |
billingTermsDay - Float
|
Billing terms for the business entity in days. |
billingWeekStartsOn - Float
|
|
code - String
|
Unique code identifying the business entity. |
contact - Contact!
|
Primary contact for the business entity. |
creditTerms - String
|
For carriers only, the credit terms they offer. |
customFields - [CustomField!]
|
Custom fields for the business entity |
defaultReferenceNumbers - [DefaultReferenceNumber!]
|
|
defaultShipper - BusinessEntity
|
The default shipper for this business entity |
defaultShipperId - ObjectId
|
ID of the default shipper for this business entity. This is used by default when a shipment is sent to this business entity |
documentRequirements - [DocumentRequirement!]
|
Document requirements for invoicing for this business entity |
documents - [Document!]
|
Documents for the business entity |
dotNumber - String
|
DOT Number for carriers and brokers |
externalId - String
|
ID of the business entity in an external system. |
federalId - String
|
Federal ID for carriers |
goodInventoryItems - [GoodInventoryItem!]
|
|
groupIds - [ObjectId!]
|
IDs of the groups that this business entity belongs to |
mcNumber - String
|
MC Number for carriers |
name - String!
|
Legal name of the business entity. |
notes - [BusinessEntityNote!]
|
|
openingSchedules - [OpeningSchedule!]
|
Opening schedules for the business entity. |
parentBusinessEntity - BusinessEntity
|
The business entity that this business entity belongs to |
parentBusinessEntityId - ObjectId
|
ID of the business entity that this business entity belongs to. Used for receiver/customer relations for example |
payToProfile - BusinessEntity
|
The business entity that we need to pay to. Used for carriers |
payToProfileId - ObjectId
|
ID of the business entity that we need to pay to. Used for carriers |
referenceNumberTypes - [ShipmentReferenceNumberType!]
|
For customers and brokers, the types of reference numbers they use in orders. |
remitAddress - TextualAddress
|
Remit address for the business entity. Where payments are sent. |
remitCompanyName - String
|
Remit company name for the business entity |
remitEmail - String
|
Remit email for the business entity |
shipmentDocumentsToReceive - [String!]
|
Shipmentp documents to receive via email on completion |
standardCarrierAlphaCode - String
|
SCAC code for carriers |
status - AssetStatus!
|
|
storageFacilities - [StorageFacility!]
|
Storage facilities for the business entity. Used for tanks, warehouses, etc |
Arguments
|
|
tags - [String!]
|
Tags for the business entity |
trailerTypes - [TrailerType!]
|
For carriers only, the types of trailers they have. |
type - BusinessEntityType!
|
The type of business entity. |
Example
{
"_id": "abc123",
"accessToken": "abc123",
"additionalContacts": [Contact],
"additionalTypes": ["BROKER"],
"address": Address,
"addressTimezone": "xyz789",
"billingAddress": TextualAddress,
"billingEmail": "abc123",
"billingInvoiceConsolidationCriteria": "BOL_NUMBER",
"billingTermsDay": 123.45,
"billingWeekStartsOn": 123.45,
"code": "abc123",
"contact": Contact,
"creditTerms": "xyz789",
"customFields": [CustomField],
"defaultReferenceNumbers": [DefaultReferenceNumber],
"defaultShipper": BusinessEntity,
"defaultShipperId": ObjectId,
"documentRequirements": [DocumentRequirement],
"documents": [Document],
"dotNumber": "xyz789",
"externalId": "abc123",
"federalId": "abc123",
"goodInventoryItems": [GoodInventoryItem],
"groupIds": [ObjectId],
"mcNumber": "xyz789",
"name": "xyz789",
"notes": [BusinessEntityNote],
"openingSchedules": [OpeningSchedule],
"parentBusinessEntity": BusinessEntity,
"parentBusinessEntityId": ObjectId,
"payToProfile": BusinessEntity,
"payToProfileId": ObjectId,
"referenceNumberTypes": ["BILL_OF_LADING_NUMBER"],
"remitAddress": TextualAddress,
"remitCompanyName": "abc123",
"remitEmail": "xyz789",
"shipmentDocumentsToReceive": ["abc123"],
"standardCarrierAlphaCode": "abc123",
"status": "ACTIVE",
"storageFacilities": [StorageFacility],
"tags": ["xyz789"],
"trailerTypes": ["AUTO_CARRIER"],
"type": "BROKER"
}
ShipperPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Shipper!]!
|
Example
{"count": 987, "data": [Shipper]}
SingleShipmentNoteInput
Snapshot
SplitShipmentLocationInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
addressLabel - String
|
|
addressTimezone - String
|
|
arrivalTimeWindows - [DateTimeWindowInput!]
|
|
departureTimeWindows - [DateTimeWindowInput!]
|
|
location - CoordinatesInput!
|
|
locationType - ShipmentLocationType!
|
|
name - String
|
Example
{
"_id": "abc123",
"addressLabel": "xyz789",
"addressTimezone": "xyz789",
"arrivalTimeWindows": [DateTimeWindowInput],
"departureTimeWindows": [DateTimeWindowInput],
"location": CoordinatesInput,
"locationType": "BREAK",
"name": "abc123"
}
StartTripInput
Fields
| Input Field | Description |
|---|---|
location - CoordinatesInput!
|
|
tripId - String!
|
Example
{
"location": CoordinatesInput,
"tripId": "xyz789"
}
Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
StorageFacility
Description
Represents a storage facility at a given receiver
Fields
| Field Name | Description |
|---|---|
capacity - Float!
|
|
commodities - [GoodProfile!]
|
|
commodity - GoodProfile
|
Use commodities instead |
commodityId - ObjectId
|
Use commodityIds instead |
commodityIds - [ObjectId!]!
|
|
currentForecastedReading - Reading
|
|
currentSalesTrend - Float
|
|
defaultPinCode - String
|
|
defaultSupplier - BusinessEntity
|
|
defaultSupplierId - ObjectId
|
|
identifier - String!
|
|
latestReading - Reading
|
|
linkedStorageFacilityIds - [String!]
|
|
runoutDate - DateTime
|
|
runoutDateAfterNextShipment - DateTime
|
|
safeFillLevel - Float
|
|
shutDownLevel - Float
|
|
unit - StorageFacilityUnit!
|
Example
{
"capacity": 123.45,
"commodities": [GoodProfile],
"commodity": GoodProfile,
"commodityId": ObjectId,
"commodityIds": [ObjectId],
"currentForecastedReading": Reading,
"currentSalesTrend": 123.45,
"defaultPinCode": "xyz789",
"defaultSupplier": BusinessEntity,
"defaultSupplierId": ObjectId,
"identifier": "xyz789",
"latestReading": Reading,
"linkedStorageFacilityIds": ["abc123"],
"runoutDate": "2007-12-03T10:15:30Z",
"runoutDateAfterNextShipment": "2007-12-03T10:15:30Z",
"safeFillLevel": 987.65,
"shutDownLevel": 123.45,
"unit": "GALLONS"
}
StorageFacilityDateRangeSales
StorageFacilityInput
Fields
| Input Field | Description |
|---|---|
capacity - Float!
|
|
commodityId - ObjectId
|
|
commodityIds - [ObjectId!]!
|
|
defaultPinCode - String
|
|
defaultSupplierId - ObjectId
|
|
identifier - String!
|
|
linkedStorageFacilityIds - [String!]
|
|
safeFillLevel - Float
|
|
safeFillPercentage - Float
|
|
shutDownLevel - Float
|
|
shutDownPercentage - Float
|
|
unit - StorageFacilityUnit!
|
Example
{
"capacity": 123.45,
"commodityId": ObjectId,
"commodityIds": [ObjectId],
"defaultPinCode": "xyz789",
"defaultSupplierId": ObjectId,
"identifier": "xyz789",
"linkedStorageFacilityIds": ["abc123"],
"safeFillLevel": 987.65,
"safeFillPercentage": 987.65,
"shutDownLevel": 123.45,
"shutDownPercentage": 123.45,
"unit": "GALLONS"
}
StorageFacilityReading
Example
{
"_id": "xyz789",
"date": "2007-12-03T10:15:30Z",
"level": 987.65,
"receiver": BusinessEntity,
"receiverId": ObjectId,
"storageFacilityId": "abc123"
}
StorageFacilityReadingPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [StorageFacilityReading!]!
|
Example
{"count": 987, "data": [StorageFacilityReading]}
StorageFacilityReadingUpdateInput
StorageFacilityUnit
Description
The units of measure for the capacity of a receiver storage facility
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GALLONS"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SubscriptionCheckoutSession
Fields
| Field Name | Description |
|---|---|
url - String!
|
Example
{"url": "xyz789"}
SubscriptionEntitlementAvailability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AVAILABLE"
SubscriptionEntitlementInfo
Fields
| Field Name | Description |
|---|---|
featureId - String!
|
|
value - SubscriptionEntitlementAvailability!
|
Example
{
"featureId": "abc123",
"value": "AVAILABLE"
}
SubscriptionInfo
Example
{
"activatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"entitlements": [SubscriptionEntitlementInfo],
"id": "abc123",
"lastUpdated": "2007-12-03T10:15:30Z",
"mrr": 123.45,
"numberOfAdminSeats": 123.45,
"numberOfDriverSeats": 123.45,
"status": "ACTIVE",
"trialEnd": "2007-12-03T10:15:30Z",
"trialStart": "2007-12-03T10:15:30Z"
}
SubscriptionPortalSession
Fields
| Field Name | Description |
|---|---|
url - String!
|
Example
{"url": "abc123"}
SubscriptionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
SupplierContract
Description
Supplier contract
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
allocation - SupplierContractAllocation
|
The maximum quantities of product allowed by the contract |
conditions - [SupplierContractCondition!]
|
The conditions that must be met for the contract to apply |
contractNumber - String!
|
The identifier of the contract |
customer - BusinessEntity
|
|
customerId - ObjectId
|
The id of the customer that the contract is for |
endDate - DateTime!
|
The end date of the contract. The contract cannot be used after this date |
goodProfile - GoodProfile
|
|
goodProfileId - ObjectId!
|
The id of the commodity that the contract is for |
pinCode - String
|
The pin code to use the contract |
shipper - BusinessEntity
|
|
shipperId - ObjectId
|
The id of the shipper where the commodity can be picked up at |
startDate - DateTime!
|
The start date of the contract. The contract cannot be used before this date |
supplier - BusinessEntity
|
|
supplierId - ObjectId!
|
The id of the supplier that the contract is with |
unitPrice - Float!
|
The price per unit of the commodity |
usedAllocation - SupplierContractAllocation
|
The quantities of product used through this contract |
Example
{
"_id": "xyz789",
"allocation": SupplierContractAllocation,
"conditions": [SupplierContractCondition],
"contractNumber": "xyz789",
"customer": BusinessEntity,
"customerId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"goodProfile": GoodProfile,
"goodProfileId": ObjectId,
"pinCode": "abc123",
"shipper": BusinessEntity,
"shipperId": ObjectId,
"startDate": "2007-12-03T10:15:30Z",
"supplier": BusinessEntity,
"supplierId": ObjectId,
"unitPrice": 123.45,
"usedAllocation": SupplierContractAllocation
}
SupplierContractAllocation
Description
Allocation definition for a supplier contract
Example
{
"dailyQuantity": 987.65,
"monthlyQuantity": 987.65,
"totalQuantity": 123.45,
"weeklyQuantity": 987.65
}
SupplierContractAllocationInput
SupplierContractCondition
Fields
| Field Name | Description |
|---|---|
operator - BillingRuleConditionOperator!
|
|
target - SupplierContractConditionTarget!
|
|
value - ConditionValue
|
Example
{
"operator": "EQUALS",
"target": "PURCHASE_QUANTITY",
"value": ConditionValue
}
SupplierContractConditionInput
Fields
| Input Field | Description |
|---|---|
operator - BillingRuleConditionOperator!
|
|
target - SupplierContractConditionTarget!
|
|
value - ConditionValue
|
Example
{
"operator": "EQUALS",
"target": "PURCHASE_QUANTITY",
"value": ConditionValue
}
SupplierContractConditionTarget
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PURCHASE_QUANTITY"
SupplierContractPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [SupplierContract!]!
|
Example
{"count": 987, "data": [SupplierContract]}
SupplierContractRanking
Description
Supplier contract ranking for a shipment
Fields
| Field Name | Description |
|---|---|
costPerMile - Float!
|
Cost per mile |
mileage - Float!
|
Mileage between the shipper and receiver |
productCost - Float!
|
Cost of purchasing the product |
quantity - Float!
|
Quantity of the product |
shippingCost - Float!
|
Cost of shipping the product |
supplierContract - SupplierContract!
|
The contract data |
totalCost - Float!
|
Total cost of using the contract for the shipment |
unitPrice - Float!
|
Unit price of the product |
Example
{
"costPerMile": 123.45,
"mileage": 987.65,
"productCost": 987.65,
"quantity": 123.45,
"shippingCost": 123.45,
"supplierContract": SupplierContract,
"totalCost": 123.45,
"unitPrice": 123.45
}
SupplierContractUpdateInput
Fields
| Input Field | Description |
|---|---|
allocation - SupplierContractAllocationInput
|
The maximum quantities of product allowed by the contract |
conditions - [SupplierContractConditionInput!]
|
The conditions that must be met for the contract to apply |
contractNumber - String
|
The identifier of the contract |
customerId - ObjectId
|
The id of the customer that the contract is for |
endDate - DateTime
|
The end date of the contract. The contract cannot be used after this date |
goodProfileId - ObjectId
|
The id of the commodity that the contract is for |
pinCode - String
|
The pin code to use the contract |
shipperId - ObjectId
|
The id of the shipper where the commodity can be picked up at |
startDate - DateTime
|
The start date of the contract. The contract cannot be used before this date |
supplierId - ObjectId
|
The id of the supplier that the contract is with |
unitPrice - Float
|
The price per unit of the commodity |
usedAllocation - SupplierContractAllocationInput
|
The quantities of product used through this contract |
Example
{
"allocation": SupplierContractAllocationInput,
"conditions": [SupplierContractConditionInput],
"contractNumber": "abc123",
"customerId": ObjectId,
"endDate": "2007-12-03T10:15:30Z",
"goodProfileId": ObjectId,
"pinCode": "xyz789",
"shipperId": ObjectId,
"startDate": "2007-12-03T10:15:30Z",
"supplierId": ObjectId,
"unitPrice": 987.65,
"usedAllocation": SupplierContractAllocationInput
}
Temp
TextualAddress
Description
Address with textual description
Example
{
"city": "abc123",
"country": "xyz789",
"googlePlaceId": "abc123",
"line1": "xyz789",
"line2": "abc123",
"postalCode": "xyz789",
"state": "abc123"
}
TextualAddressInput
Example
{
"city": "xyz789",
"country": "abc123",
"googlePlaceId": "abc123",
"line1": "xyz789",
"line2": "abc123",
"postalCode": "abc123",
"state": "abc123"
}
Time
TimeInput
Tractor
Description
A Tractor entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
currentDriverEldId - String
|
|
customFields - [CustomField!]
|
|
documents - [Document!]
|
|
domicile - Address
|
|
eldId - String
|
|
groupIds - [ObjectId!]
|
|
lastKnownEldLocation - Coordinates
|
The last known location from the ELD. This is the safest location to use if you want to know the exact location of the tractor but it might not update as often |
lastKnownEldLocationDate - DateTime
|
|
lastKnownLocation - Coordinates
|
The last known location by combining both ELD data and driver app data. This location is not as accurate as the ELD location but it updates more often |
lastKnownLocationDate - DateTime
|
|
licenseNumber - String
|
|
make - String
|
|
mileage - Float
|
|
model - String
|
|
plateNumber - String
|
|
serialNumber - String!
|
|
status - AssetStatus!
|
|
tags - [String!]
|
|
tareWeight - Float
|
|
year - Float
|
Example
{
"_id": "abc123",
"currentDriverEldId": "xyz789",
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"eldId": "xyz789",
"groupIds": [ObjectId],
"lastKnownEldLocation": Coordinates,
"lastKnownEldLocationDate": "2007-12-03T10:15:30Z",
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"licenseNumber": "abc123",
"make": "abc123",
"mileage": 123.45,
"model": "abc123",
"plateNumber": "xyz789",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["xyz789"],
"tareWeight": 123.45,
"year": 987.65
}
TractorPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Tractor!]!
|
Example
{"count": 987, "data": [Tractor]}
TractorPositionInput
Example
{
"_id": "abc123",
"coords": CoordinatesInput,
"driverEldId": "abc123",
"odometer": 987.65,
"timestamp": "2007-12-03T10:15:30Z",
"tractor": "xyz789"
}
TractorUpdateInput
Fields
| Input Field | Description |
|---|---|
customFields - [CustomFieldInput!]
|
|
documents - [DocumentInput!]
|
|
domicile - NewAddressInput
|
|
eldId - String
|
|
groupIds - [ObjectId!]
|
|
licenseNumber - String
|
|
make - String
|
|
mileage - Float
|
|
model - String
|
|
plateNumber - String
|
|
serialNumber - String
|
|
status - AssetStatus
|
|
tags - [String!]
|
|
tareWeight - Float
|
|
year - Float
|
Example
{
"customFields": [CustomFieldInput],
"documents": [DocumentInput],
"domicile": NewAddressInput,
"eldId": "xyz789",
"groupIds": [ObjectId],
"licenseNumber": "abc123",
"make": "abc123",
"mileage": 123.45,
"model": "xyz789",
"plateNumber": "xyz789",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"tareWeight": 987.65,
"year": 123.45
}
Trailer
Description
A Trailer entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
compartments - [TrailerCompartment!]
|
|
customFields - [CustomField!]
|
|
documents - [Document!]
|
|
domicile - Address
|
|
groupIds - [ObjectId!]
|
|
height - Float
|
|
lastKnownLocation - Coordinates
|
|
lastKnownLocationDate - DateTime
|
|
length - Float
|
|
licenseNumber - String
|
|
maxTemperature - Float
|
|
maxWeight - Float
|
|
mileage - Float
|
|
minTemperature - Float
|
|
numberOfAxles - Float
|
|
serial - String
|
|
serialNumber - String!
|
|
status - AssetStatus!
|
|
tags - [String!]
|
|
type - TrailerType!
|
|
vin - String
|
|
width - Float
|
Example
{
"_id": "xyz789",
"compartments": [TrailerCompartment],
"customFields": [CustomField],
"documents": [Document],
"domicile": Address,
"groupIds": [ObjectId],
"height": 123.45,
"lastKnownLocation": Coordinates,
"lastKnownLocationDate": "2007-12-03T10:15:30Z",
"length": 123.45,
"licenseNumber": "xyz789",
"maxTemperature": 123.45,
"maxWeight": 987.65,
"mileage": 123.45,
"minTemperature": 123.45,
"numberOfAxles": 987.65,
"serial": "abc123",
"serialNumber": "abc123",
"status": "ACTIVE",
"tags": ["abc123"],
"type": "AUTO_CARRIER",
"vin": "abc123",
"width": 123.45
}
TrailerCompartment
Description
Represents a storage facility at a given receiver
Fields
| Field Name | Description |
|---|---|
capacity - Float!
|
|
identifier - String!
|
|
unit - TrailerCompartmentUnit!
|
Example
{
"capacity": 987.65,
"identifier": "abc123",
"unit": "GALLONS"
}
TrailerCompartmentAssignment
Description
Assignment of a commodity to a trailer compartment
Example
{
"commodityId": "abc123",
"compartmentId": "xyz789",
"quantity": 123.45,
"targetStorageFacilityId": "abc123",
"trailerId": ObjectId
}
TrailerCompartmentAssignmentInput
TrailerCompartmentInput
Fields
| Input Field | Description |
|---|---|
capacity - Float!
|
|
identifier - String!
|
|
unit - TrailerCompartmentUnit!
|
Example
{
"capacity": 123.45,
"identifier": "abc123",
"unit": "GALLONS"
}
TrailerCompartmentUnit
Description
The units of measure for the capacity of a trailer compartment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GALLONS"
TrailerEvent
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
date - DateTime!
|
|
trailerId - ObjectId!
|
|
type - TrailerEventType!
|
Example
{
"_id": "abc123",
"date": "2007-12-03T10:15:30Z",
"trailerId": ObjectId,
"type": "TRAILER_WASH"
}
TrailerEventPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [TrailerEvent!]!
|
Example
{"count": 987, "data": [TrailerEvent]}
TrailerEventType
Description
Type of trailer event
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TRAILER_WASH"
TrailerEventUpdateInput
Fields
| Input Field | Description |
|---|---|
date - DateTime
|
|
trailerId - ObjectId
|
|
type - TrailerEventType
|
Example
{
"date": "2007-12-03T10:15:30Z",
"trailerId": ObjectId,
"type": "TRAILER_WASH"
}
TrailerPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Trailer!]!
|
Example
{"count": 123, "data": [Trailer]}
TrailerProfile
Fields
| Field Name | Description |
|---|---|
compartments - [TrailerProfileCompartment!]!
|
Example
{"compartments": [TrailerProfileCompartment]}
TrailerProfileCompartment
Example
{
"capacity": 987.65,
"hasSeparatorAfter": true,
"hasSeparatorBefore": true,
"label": "abc123",
"maxWeight": 987.65,
"minUsage": 987.65
}
TrailerProfileCompartmentInput
Example
{
"capacity": 987.65,
"hasSeparatorAfter": true,
"hasSeparatorBefore": true,
"label": "xyz789",
"maxWeight": 123.45,
"minUsage": 123.45
}
TrailerProfileInput
Fields
| Input Field | Description |
|---|---|
compartments - [TrailerProfileCompartmentInput!]!
|
Example
{"compartments": [TrailerProfileCompartmentInput]}
TrailerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTO_CARRIER"
TrailerUpdateInput
Fields
| Input Field | Description |
|---|---|
compartments - [TrailerCompartmentInput!]
|
|
customFields - [CustomFieldInput!]
|
|
documents - [DocumentInput!]
|
|
domicile - NewAddressInput
|
|
groupIds - [ObjectId!]
|
|
height - Float
|
|
lastKnownLocation - CoordinatesInput
|
|
length - Float
|
|
licenseNumber - String
|
|
maxTemperature - Float
|
|
maxWeight - Float
|
|
mileage - Float
|
|
minTemperature - Float
|
|
numberOfAxles - Float
|
|
serial - String
|
|
serialNumber - String
|
|
status - AssetStatus
|
|
tags - [String!]
|
|
type - TrailerType
|
|
vin - String
|
|
width - Float
|
Example
{
"compartments": [TrailerCompartmentInput],
"customFields": [CustomFieldInput],
"documents": [DocumentInput],
"domicile": NewAddressInput,
"groupIds": [ObjectId],
"height": 123.45,
"lastKnownLocation": CoordinatesInput,
"length": 123.45,
"licenseNumber": "abc123",
"maxTemperature": 987.65,
"maxWeight": 987.65,
"mileage": 123.45,
"minTemperature": 123.45,
"numberOfAxles": 123.45,
"serial": "abc123",
"serialNumber": "xyz789",
"status": "ACTIVE",
"tags": ["xyz789"],
"type": "AUTO_CARRIER",
"vin": "abc123",
"width": 987.65
}
Transaction
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
customFields - [CustomField!]
|
Custom fields for the transaction |
document - TransactionDocument
|
Document for the transaction |
label - String!
|
Label of the transaction |
number - String
|
Transaction number |
rate - Float!
|
Rate per unit |
reimburseToDriver - Boolean
|
Whether to reimburse to driver |
relatedTransactionId - ObjectId
|
Related transaction ID |
shipmentId - ObjectId
|
Shipment ID this charge is for |
taxable - Boolean
|
Whether the transaction is taxable |
type - TransactionType
|
Type of transaction |
unit - Float!
|
Number of units |
unitType - String!
|
Unit type for the transaction |
Example
{
"_id": "xyz789",
"customFields": [CustomField],
"document": TransactionDocument,
"label": "xyz789",
"number": "xyz789",
"rate": 123.45,
"reimburseToDriver": false,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": true,
"type": "EXPENSE",
"unit": 123.45,
"unitType": "xyz789"
}
TransactionDocument
TransactionDocumentInput
TransactionInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
customFields - [CustomFieldInput!]
|
|
document - TransactionDocumentInput
|
|
label - String!
|
|
rate - Float!
|
|
reimburseToDriver - Boolean
|
|
relatedTransactionId - ObjectId
|
|
shipmentId - ObjectId
|
Shipment ID this charge is for |
taxable - Boolean
|
|
type - TransactionType
|
|
unit - Float!
|
|
unitType - String!
|
Example
{
"_id": "abc123",
"customFields": [CustomFieldInput],
"document": TransactionDocumentInput,
"label": "xyz789",
"rate": 987.65,
"reimburseToDriver": true,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": false,
"type": "EXPENSE",
"unit": 123.45,
"unitType": "xyz789"
}
TransactionInputObject
Fields
| Field Name | Description |
|---|---|
_id - String
|
|
customFields - [CustomField!]
|
|
document - TransactionDocument
|
|
label - String!
|
|
rate - Float!
|
|
reimburseToDriver - Boolean
|
|
relatedTransactionId - ObjectId
|
|
shipmentId - ObjectId
|
Shipment ID this charge is for |
taxable - Boolean
|
|
type - TransactionType
|
|
unit - Float!
|
|
unitType - String!
|
Example
{
"_id": "abc123",
"customFields": [CustomField],
"document": TransactionDocument,
"label": "abc123",
"rate": 987.65,
"reimburseToDriver": false,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": true,
"type": "EXPENSE",
"unit": 987.65,
"unitType": "xyz789"
}
TransactionPaginatedResult
Fields
| Field Name | Description |
|---|---|
count - Int!
|
|
data - [Transaction!]!
|
Example
{"count": 123, "data": [Transaction]}
TransactionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EXPENSE"
TransactionUpdateInput
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
customFields - [CustomFieldInput!]
|
|
document - TransactionDocumentInput
|
|
label - String
|
|
rate - Float
|
|
reimburseToDriver - Boolean
|
|
relatedTransactionId - ObjectId
|
|
shipmentId - ObjectId
|
Shipment ID this charge is for |
taxable - Boolean
|
|
type - TransactionType
|
|
unit - Float
|
|
unitType - String
|
Example
{
"_id": "abc123",
"customFields": [CustomFieldInput],
"document": TransactionDocumentInput,
"label": "abc123",
"rate": 123.45,
"reimburseToDriver": false,
"relatedTransactionId": ObjectId,
"shipmentId": ObjectId,
"taxable": true,
"type": "EXPENSE",
"unit": 123.45,
"unitType": "abc123"
}
Trip
Description
Trip entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
additionalTrailers - [Trailer!]
|
|
carrier - BusinessEntity
|
|
chassis - Chassis
|
|
customFields - [CustomField!]
|
|
deadheadDistance - Float
|
|
distanceToEnd - Float!
|
|
distanceToStart - Float!
|
|
driver - Driver
|
|
driverPositions - [TripDriverPosition!]
|
|
etaFromPreviousTrip - Float
|
|
etaToNextTrip - Float
|
|
firstPickupTime - DateTime
|
|
lastDropoffTime - DateTime
|
|
lastTrafficCheck - DateTime
|
|
lastTrailerLocation - Coordinates
|
|
lastTrailerLocationDate - DateTime
|
|
lastWeatherCheck - DateTime
|
|
loadStates - [LoadState!]
|
|
loadedDistance - Float
|
|
payments - [TripPayment!]
|
|
polyline - String!
|
|
predictedLoadedDistance - Float
|
|
routeDistance - Float!
|
|
shipmentLocations - [TripShipmentLocation!]!
|
|
shipments - [Shipment!]!
|
|
status - Status!
|
|
tags - [String!]
|
|
totalDistance - Float
|
|
tractor - Tractor
|
|
trailer - Trailer
|
|
trailerCompartmentAssignments - [TrailerCompartmentAssignment!]
|
|
tripNumber - String
|
|
violations - [TripViolation!]
|
Example
{
"_id": "xyz789",
"additionalTrailers": [Trailer],
"carrier": BusinessEntity,
"chassis": Chassis,
"customFields": [CustomField],
"deadheadDistance": 987.65,
"distanceToEnd": 123.45,
"distanceToStart": 123.45,
"driver": Driver,
"driverPositions": [TripDriverPosition],
"etaFromPreviousTrip": 987.65,
"etaToNextTrip": 987.65,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"lastTrafficCheck": "2007-12-03T10:15:30Z",
"lastTrailerLocation": Coordinates,
"lastTrailerLocationDate": "2007-12-03T10:15:30Z",
"lastWeatherCheck": "2007-12-03T10:15:30Z",
"loadStates": [LoadState],
"loadedDistance": 123.45,
"payments": [TripPayment],
"polyline": "xyz789",
"predictedLoadedDistance": 123.45,
"routeDistance": 987.65,
"shipmentLocations": [TripShipmentLocation],
"shipments": [Shipment],
"status": "ACTIVE",
"tags": ["abc123"],
"totalDistance": 987.65,
"tractor": Tractor,
"trailer": Trailer,
"trailerCompartmentAssignments": [
TrailerCompartmentAssignment
],
"tripNumber": "abc123",
"violations": [TripViolation]
}
TripAssetAssignment
Fields
| Input Field | Description |
|---|---|
assetId - String
|
|
assetType - TripAssetTypes!
|
|
tripId - String!
|
Example
{
"assetId": "abc123",
"assetType": "ADDITIONAL_TRAILERS",
"tripId": "xyz789"
}
TripAssetTypes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADDITIONAL_TRAILERS"
TripDriverPosition
Description
TripDriverPosition entity
Example
{
"activity": Activity,
"battery": Battery,
"coords": Coordinates,
"event": "abc123",
"extras": Extras,
"is_moving": true,
"odometer": 123.45,
"timestamp": "xyz789",
"trip": "abc123",
"uuid": "abc123"
}
TripForPlanningInput
Fields
| Input Field | Description |
|---|---|
canMoveBackward - Boolean
|
|
canMoveForward - Boolean
|
|
firstPickupTime - DateTime
|
|
lastDropoffTime - DateTime
|
|
shipmentIds - [String!]!
|
|
shipmentLocations - [ShipmentLocationInputForPlanning!]!
|
Example
{
"canMoveBackward": true,
"canMoveForward": false,
"firstPickupTime": "2007-12-03T10:15:30Z",
"lastDropoffTime": "2007-12-03T10:15:30Z",
"shipmentIds": ["abc123"],
"shipmentLocations": [ShipmentLocationInputForPlanning]
}
TripGenerationResult
Description
Result of generating trips
Fields
| Field Name | Description |
|---|---|
trips - [Trip!]!
|
|
unassignedShipmentLocations - [ShipmentLocationWithShipment!]!
|
|
unplannedShipments - [Shipment!]!
|
Example
{
"trips": [Trip],
"unassignedShipmentLocations": [
ShipmentLocationWithShipment
],
"unplannedShipments": [Shipment]
}
TripPaginatedResult
TripPayment
TripPaymentInput
TripShipmentLocation
Description
Trip shipment location entity
Fields
| Field Name | Description |
|---|---|
_id - String!
|
|
addressLabel - String
|
|
addressTimezone - String
|
|
arrivalTime - DateTime!
|
|
distanceTo - Float
|
|
location - Coordinates!
|
|
locationType - ShipmentLocationType!
|
|
name - String
|
|
receivedGoods - [GoodDistribution!]
|
|
receiver - BusinessEntity
|
|
rotationIndex - Float
|
|
serviceDuration - Float!
|
|
setupDuration - Float!
|
|
shipmentId - String
|
|
shippedGoods - [Good!]
|
|
shipper - BusinessEntity
|
|
timeWindows - [DateTimeWindow!]!
|
|
trafficInfo - LocationTraffic
|
|
tripShipmentLocationId - String!
|
This is the ID of the shipment location as defined in the trip |
waitingDuration - Float!
|
|
weatherInfo - LocationWeather
|
Example
{
"_id": "abc123",
"addressLabel": "xyz789",
"addressTimezone": "abc123",
"arrivalTime": "2007-12-03T10:15:30Z",
"distanceTo": 987.65,
"location": Coordinates,
"locationType": "BREAK",
"name": "abc123",
"receivedGoods": [GoodDistribution],
"receiver": BusinessEntity,
"rotationIndex": 987.65,
"serviceDuration": 987.65,
"setupDuration": 123.45,
"shipmentId": "xyz789",
"shippedGoods": [Good],
"shipper": BusinessEntity,
"timeWindows": [DateTimeWindow],
"trafficInfo": LocationTraffic,
"tripShipmentLocationId": "abc123",
"waitingDuration": 123.45,
"weatherInfo": LocationWeather
}
TripShipmentLocationInput
Description
Trip shipment location entity
Fields
| Input Field | Description |
|---|---|
_id - String
|
|
addressLabel - String
|
|
addressTimezone - String
|
|
arrivalTime - DateTime!
|
|
distanceTo - Float
|
|
location - CoordinatesInput!
|
|
locationType - ShipmentLocationType!
|
|
name - String
|
|
receivedGoods - [GoodDistributionInput!]!
|
|
receiver - String
|
|
rotationIndex - Float
|
|
serviceDuration - Float!
|
|
setupDuration - Float!
|
|
shipmentId - String
|
|
shippedGoods - [GoodInput!]!
|
|
shipper - String
|
|
timeWindows - [DateTimeWindowInput!]!
|
|
tripShipmentLocationId - String!
|
This is the ID of the shipment location as defined in the trip |
waitingDuration - Float!
|
Example
{
"_id": "xyz789",
"addressLabel": "abc123",
"addressTimezone": "abc123",
"arrivalTime": "2007-12-03T10:15:30Z",
"distanceTo": 987.65,
"location": CoordinatesInput,
"locationType": "BREAK",
"name": "xyz789",
"receivedGoods": [GoodDistributionInput],
"receiver": "xyz789",
"rotationIndex": 987.65,
"serviceDuration": 123.45,
"setupDuration": 987.65,
"shipmentId": "abc123",
"shippedGoods": [GoodInput],
"shipper": "xyz789",
"timeWindows": [DateTimeWindowInput],
"tripShipmentLocationId": "abc123",
"waitingDuration": 123.45
}
TripSort
Fields
| Input Field | Description |
|---|---|
criteria - TripSortCriteria!
|
|
desc - Boolean
|
Example
{"criteria": "CREATED_AT", "desc": true}
TripSortCriteria
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
TripViolation
Fields
| Field Name | Description |
|---|---|
cause - ViolationCause!
|
|
duration - Float
|
|
locationId - String
|
Example
{
"cause": "BREAK_DELAY",
"duration": 987.65,
"locationId": "xyz789"
}
TripViolationInput
Fields
| Input Field | Description |
|---|---|
cause - ViolationCause!
|
|
duration - Float
|
|
locationId - String
|
Example
{
"cause": "BREAK_DELAY",
"duration": 987.65,
"locationId": "xyz789"
}
UpdateAccountAttributesInput
Fields
| Input Field | Description |
|---|---|
freshchatRestoreId - String
|
Example
{"freshchatRestoreId": "xyz789"}
UpdateAccountInput
Fields
| Input Field | Description |
|---|---|
attributes - UpdateAccountAttributesInput
|
|
firstName - String
|
|
lastName - String
|
Example
{
"attributes": UpdateAccountAttributesInput,
"firstName": "abc123",
"lastName": "abc123"
}
UpdateGoodDeliveredQuantityInput
UpdateGoodLoadedQuantityInput
UpdateShipmentEventInput
Fields
| Input Field | Description |
|---|---|
date - DateTime
|
Example
{"date": "2007-12-03T10:15:30Z"}
UpdateTripOrderInput
Fields
| Input Field | Description |
|---|---|
shipmentLocationsOrder - [ObjectId!]!
|
|
tripId - ObjectId!
|
Example
{
"shipmentLocationsOrder": [ObjectId],
"tripId": ObjectId
}
UserAttributes
Example
{
"customFields": "xyz789",
"driverId": "xyz789",
"freshchatRestoreId": "xyz789",
"phoneNumber": "abc123",
"phoneNumberVerified": true,
"promoCode": "abc123",
"tags": "abc123",
"trialDays": "xyz789"
}
UserAttributesInput
Example
{
"customFields": "xyz789",
"driverId": "xyz789",
"freshchatRestoreId": "xyz789",
"phoneNumber": "abc123",
"phoneNumberVerified": false,
"promoCode": "abc123",
"tags": "abc123",
"trialDays": "abc123"
}
ViolationCause
Description
The cause of the violation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BREAK_DELAY"