Reconex
TMS API

AccesorialDockType

string · enum
Enum values:
BusinessWithDock
BusinessWithOutDock
Residence
OtherLimitedAccess
Construction
Church
Military
StorageFacility

280 = BusinessWithDock, 281 = BusinessWithOutDock, 282 = Residence, 283 = OtherLimitedAccess, 284 = Construction, 285 = Church, 286 = Military, 287 = StorageFacility, 288 = School, 289 = Farm, 290 = Mine, 291 = Prison, 292 = Government, 293 = Nuclear, 294 = Hotel, 295 = GroceryWarehouse

Accessorials

doNotFreeze
​boolean
overLength
​boolean
sortAndSegregate
​boolean
blindShipment
​boolean
whiteGloveDelivery
​boolean
expedite
​boolean
insuranceRequired
​boolean
falveyInsValue
​number · double
volumeLoad
​boolean
guaranteed
​boolean
mabd
​boolean
destinationNotification
​boolean
originInsidePickup
​boolean
originLiftGate
​boolean
destinationInsideDelivery
​boolean
destinationLiftGate
​boolean
inBond
​boolean

AccessoryListReRate

blindShipment
​boolean
doNotFreeze
​boolean
guaranteed
​boolean
notification
​boolean
overLength
​boolean
sortAndSegregate
​boolean
volumeLoad
​boolean
whiteGloveDelivery
​boolean
expedite
​boolean
originInsidePickup
​boolean
destinationInsideDelivery
​boolean
originLiftGate
​boolean
destinationLiftGate
​boolean
inBond
​boolean

AttachmentDto

fileName
​string | null
fileContent
​string | null

BillingLocation

name
​string | null
street
​string | null
street2
​string | null
city
​string | null
stateProvince
​string | null
postalCode
​string | null
country
​string | null

Possible values: USA, CAN, OTHER, MEX

BillingLocationDto

name
​string | null
street
​string | null
street2
​string | null
city
​string | null
stateProvince
​string | null
postalCode
​string | null
country
​string | null

Possible values: USA, CAN, OTHER, MEX

BillingReRateInformation

terms
​string | null

Possible values: Prepaid, Collect, ThirdParty, PrepaidAdd

role
​string | null

Possible values: Shipper, Consignee, ThirdParty

billingID
​string | null
poNumber
​string | null
proNumber
​string | null
customID
​string | null
name
​string | null
street1
​string | null
street2
​string | null
city
​string | null
state
​string | null
zip
​string | null
country
​string | null

Possible values: USA, CAN, OTHER, MEX

BookLoadASNTemplate

isASNNeeded
​boolean
asnTemplateName
​string | null

BookLoadCostInformation

resultCode
​string | null
isPROchanged
​boolean
isBooked
​boolean
loadID
​string | null
proNumber
​string | null
poNumber
​string | null
billingID
​string | null

BookLoadCostRequest

loadId
​integer · int32
proNumber
​string | null
billingId
​string | null
poNumber
​string | null
isHotShipment
​boolean

BookLoadCostResponse

​array | null
​array | null

BookLoadDetail

terms
​string | null

Possible values: Prepaid, Collect, ThirdParty, PrepaidAdd

billingID
​string | null
poNumber
​string | null
proNumber
​string | null
customID
​string | null
customerBilling
​string | null

BookLoadRequest

mustArriveByDate
​string | null · date-time
​BookLoadDetail
​BillingLocation
​LocationLoad
​LocationLoad
​Accessorials
​array | null
​LoadInformation
scac
​string | null

ClassifierFreightClass

integer · enum · int32
Enum values:
100
101
102
103
104
105
106
107

100 = FreightClass50, 101 = FreightClass55, 102 = FreightClass60, 103 = FreightClass65, 104 = FreightClass70, 105 = FreightClass77_5, 106 = FreightClass85, 107 = FreightClass92_5, 108 = FreightClass100, 109 = FreightClass110, 110 = FreightClass125, 111 = FreightClass150, 112 = FreightClass175, 113 = FreightClass200, 114 = FreightClass250, 115 = FreightClass300, 116 = FreightClass400, 117 = FreightClass500

ClassifierHazClass

integer · enum · int32
Enum values:
210
211
212
213
214
215
216
217

210 = HazClass1, 211 = HazClass1_1, 212 = HazClass1_2, 213 = HazClass1_3, 214 = HazClass1_4, 215 = HazClass1_5, 216 = HazClass1_6, 217 = HazClass2, 218 = HazClass2_1, 219 = HazClass2_2, 220 = HazClass2_3, 221 = HazClass3, 222 = HazClass4, 223 = HazClass4_1, 224 = HazClass4_2, 225 = HazClass4_3, 226 = HazClass5, 227 = HazClass5_1, 228 = HazClass5_2, 229 = HazClass6, 230 = HazClass6_1, 231 = HazClass6_2, 232 = HazClass7, 233 = HazClass8, 234 = HazClass9

ClassifierLoadShipLabelReport

integer · enum · int32
Enum values:
800
801
802
803
804
805
806
807

800 = ShipLabel6x4Page1x4, 801 = ShipLabel8x11Page1x1, 802 = ShipLabel11x8Page4x1, 803 = ShipLabel6x4Page1x1, 804 = ShipLabel4x6Page1x4, 805 = ShipLabel4x6Page1x2, 806 = ShipLabel4x3Page1x4, 807 = ShipLabel4x2Page1x4, 808 = ShipLabel8x4Page1x1, 809 = ShipLabel11x8Page1x1, 813 = ShipLabel4x6Page1x1, 814 = ShipLabel2x4Page1x2, 815 = ShipLabel4x4Page1x4, 816 = ShipLabel4x7Page1x1

Countries

integer · enum · int32
Enum values:
1
2
3
4

1 = USA, 2 = CAN, 3 = OTHER, 4 = MEX

CreateLoad - Country

type
​Countries · enum · int32 · required

1 = USA, 2 = CAN, 3 = OTHER, 4 = MEX

Enum values:
1
2
3
4

CreateLoad - DockType

type
​AccesorialDockType · enum · required

280 = BusinessWithDock, 281 = BusinessWithOutDock, 282 = Residence, 283 = OtherLimitedAccess, 284 = Construction, 285 = Church, 286 = Military, 287 = StorageFacility, 288 = School, 289 = Farm, 290 = Mine, 291 = Prison, 292 = Government, 293 = Nuclear, 294 = Hotel, 295 = GroceryWarehouse

Enum values:
BusinessWithDock
BusinessWithOutDock
Residence
OtherLimitedAccess
Construction
Church
Military
StorageFacility

CreateLoad - FreightClass

type
​ClassifierFreightClass · enum · int32 · required

100 = FreightClass50, 101 = FreightClass55, 102 = FreightClass60, 103 = FreightClass65, 104 = FreightClass70, 105 = FreightClass77_5, 106 = FreightClass85, 107 = FreightClass92_5, 108 = FreightClass100, 109 = FreightClass110, 110 = FreightClass125, 111 = FreightClass150, 112 = FreightClass175, 113 = FreightClass200, 114 = FreightClass250, 115 = FreightClass300, 116 = FreightClass400, 117 = FreightClass500

Enum values:
100
101
102
103
104
105
106
107

CreateLoad - HazClass

type
​ClassifierHazClass · enum · int32 · required

210 = HazClass1, 211 = HazClass1_1, 212 = HazClass1_2, 213 = HazClass1_3, 214 = HazClass1_4, 215 = HazClass1_5, 216 = HazClass1_6, 217 = HazClass2, 218 = HazClass2_1, 219 = HazClass2_2, 220 = HazClass2_3, 221 = HazClass3, 222 = HazClass4, 223 = HazClass4_1, 224 = HazClass4_2, 225 = HazClass4_3, 226 = HazClass5, 227 = HazClass5_1, 228 = HazClass5_2, 229 = HazClass6, 230 = HazClass6_1, 231 = HazClass6_2, 232 = HazClass7, 233 = HazClass8, 234 = HazClass9

Enum values:
210
211
212
213
214
215
216
217

CreateLoad - LabelTypeId

type
​ClassifierLoadShipLabelReport · enum · int32 · required

800 = ShipLabel6x4Page1x4, 801 = ShipLabel8x11Page1x1, 802 = ShipLabel11x8Page4x1, 803 = ShipLabel6x4Page1x1, 804 = ShipLabel4x6Page1x4, 805 = ShipLabel4x6Page1x2, 806 = ShipLabel4x3Page1x4, 807 = ShipLabel4x2Page1x4, 808 = ShipLabel8x4Page1x1, 809 = ShipLabel11x8Page1x1, 813 = ShipLabel4x6Page1x1, 814 = ShipLabel2x4Page1x2, 815 = ShipLabel4x4Page1x4, 816 = ShipLabel4x7Page1x1

Enum values:
800
801
802
803
804
805
806
807

CreateLoad - LoadEquipmentType

type
​EquipmentType · enum · required

1 = VanStandardTrailer, 2 = CargoVan, 3 = StraightTruck, 4 = PartialTruckload, 5 = DoubleDrop, 6 = FlatBed, 7 = LowBoy, 8 = StepDeck, 9 = Tanker, 10 = Intermodal, 11 = CurtainSide, 12 = RGN, 13 = Refrigerated, 14 = Heated, 15 = Other, 16 = VanTrailer53ft, 17 = Container20ft, 18 = Container40ft, 19 = DumpTruck, 20 = Frozen, 21 = Gooseneck, 22 = HopperBottom, 23 = MaxiTrailer, 24 = RollOffTruck, 25 = WalkingFloor, 26 = PartialVanStandardTrailer, 27 = PartialStepDeck, 28 = PartialFlatBed, 29 = Reefer53ft, 30 = PowerOnly, 31 = FlatbedPullCurtain53ft, 32 = StepDeckPullCurtain53ft, 33 = DoubleDropPullCurtain53ft, 34 = Bulk, 35 = SprinterVan, 36 = HotShot

Enum values:
VanStandardTrailer
CargoVan
StraightTruck
PartialTruckload
DoubleDrop
FlatBed
LowBoy
StepDeck

CreateLoad - Packaging

type
​TypePackaging · enum · required

10 = Bags, 11 = Bales, 12 = Barrels, 13 = Baskets, 14 = Boxes, 15 = Buckets, 16 = Bulkheads, 17 = Bundles, 18 = Carboys, 19 = Cartons, 20 = Cases, 21 = Chests, 22 = Coils, 23 = Crates, 24 = Cylinders, 25 = Drums, 26 = Feet, 27 = Firkins, 28 = Hampers, 29 = Hogsheads, 30 = Kegs, 31 = Packages, 32 = Pails, 33 = Pallets, 34 = Pieces, 35 = Racks, 36 = Reels, 37 = Rolls, 38 = Skids, 39 = SlipSheets, 40 = Sows, 41 = SuperSack, 42 = Totes, 43 = Trailers, 44 = Truckload, 45 = Trunks, 46 = Tubes, 47 = Unpackaged, 48 = FloorLoaded, 49 = Tanks, 50 = PackingSlip, 51 = ChepPallets, 52 = EmptyTotes, 53 = EmptyDrums, 54 = EmptyContainers, 55 = Carrier, 56 = Gaylords, 57 = PalletsStackable, 58 = PalletsNonStackable, 59 = Doors, 60 = Skins, 61 = Jambs, 62 = BasePlate, 63 = Carts, 71 = Eaches

Enum values:
Bags
Bales
Barrels
Baskets
Boxes
Buckets
Bulkheads
Bundles

CreateLoad - PgCode

type
​PGType · enum · required

0 = None, 1 = PGI, 2 = PGII, 3 = PGIII

Enum values:
None
PGI
PGII
PGIII

CreateLoad - ShippingUnits

type
​TypePackaging · enum · required

10 = Bags, 11 = Bales, 12 = Barrels, 13 = Baskets, 14 = Boxes, 15 = Buckets, 16 = Bulkheads, 17 = Bundles, 18 = Carboys, 19 = Cartons, 20 = Cases, 21 = Chests, 22 = Coils, 23 = Crates, 24 = Cylinders, 25 = Drums, 26 = Feet, 27 = Firkins, 28 = Hampers, 29 = Hogsheads, 30 = Kegs, 31 = Packages, 32 = Pails, 33 = Pallets, 34 = Pieces, 35 = Racks, 36 = Reels, 37 = Rolls, 38 = Skids, 39 = SlipSheets, 40 = Sows, 41 = SuperSack, 42 = Totes, 43 = Trailers, 44 = Truckload, 45 = Trunks, 46 = Tubes, 47 = Unpackaged, 48 = FloorLoaded, 49 = Tanks, 50 = PackingSlip, 51 = ChepPallets, 52 = EmptyTotes, 53 = EmptyDrums, 54 = EmptyContainers, 55 = Carrier, 56 = Gaylords, 57 = PalletsStackable, 58 = PalletsNonStackable, 59 = Doors, 60 = Skins, 61 = Jambs, 62 = BasePlate, 63 = Carts, 71 = Eaches

Enum values:
Bags
Bales
Barrels
Baskets
Boxes
Buckets
Bulkheads
Bundles

CreateLoad - SubClass

type
​SubclassClassifier · enum · int32 · required

1 = Subclass1, 2 = Subclass2, 3 = Subclass3, 4 = Subclass4, 5 = Subclass5, 6 = Subclass6, 7 = Subclass7, 8 = Subclass8, 9 = Subclass9, 10 = Subclass10, 11 = Subclass11, 12 = Subclass12, 13 = Subclass13, 14 = Subclass14, 15 = Subclass15, 16 = Subclass16, 17 = Subclass17, 18 = Subclass18, 19 = Subclass19, 20 = Subclass20

Enum values:
1
2
3
4
5
6
7
8

CreateLoad - UnNa

type
​UNNAType · enum · required

0 = U, 1 = N

Enum values:
U
N

CreateLoadActionOptionDto

accountId
​integer · int32
rate
​boolean
book
​string | null
proNumber
​boolean
dispatch
​boolean
errorEmailNotification
​string | null

Email address that receives the error notification when one of the requested actions fails. Multiple recipients are supported: separate the addresses with a comma, for example "ops@company.com,support@company.com". The comma is the only accepted separator (a semicolon is not), spaces around each address are ignored, and the whole value is limited to 500 characters.

CreateLoadDetailDto

billingID
​string | null
poNumber
​string | null
proNumber
​string | null
customID
​string | null
customerBilling
​string | null

CreateLoadRequestDto

​EmailParametersDto
​CreateLoadDetailDto
​BillingLocationDto
​LocationLoadDto
​LocationLoadDto
​Accessorials
​array | null
​LoadInformationDto
​array | null

CreateLoadResponseDto

​InformationDto
​array | null

EmailAttachementsDto

bol
​boolean
label
​boolean
labelTypeId
​string | null

Possible values: ShipLabel6x4Page1x4, ShipLabel8x11Page1x1, ShipLabel11x8Page4x1, ShipLabel6x4Page1x1, ShipLabel4x6Page1x4, ShipLabel4x6Page1x2, ShipLabel4x3Page1x4, ShipLabel4x2Page1x4, ShipLabel8x4Page1x1, ShipLabel11x8Page1x1, ShipLabel4x6Page1x1, ShipLabel2x4Page1x2, ShipLabel4x4Page1x4, ShipLabel4x7Page1x1

loadAttachments
​boolean

EmailParametersDto

emailFrom
​string | null
emailTo
​string | null
emailSubject
​string | null
emailBody
​string | null
​EmailAttachementsDto

EquipmentType

string · enum
Enum values:
VanStandardTrailer
CargoVan
StraightTruck
PartialTruckload
DoubleDrop
FlatBed
LowBoy
StepDeck

1 = VanStandardTrailer, 2 = CargoVan, 3 = StraightTruck, 4 = PartialTruckload, 5 = DoubleDrop, 6 = FlatBed, 7 = LowBoy, 8 = StepDeck, 9 = Tanker, 10 = Intermodal, 11 = CurtainSide, 12 = RGN, 13 = Refrigerated, 14 = Heated, 15 = Other, 16 = VanTrailer53ft, 17 = Container20ft, 18 = Container40ft, 19 = DumpTruck, 20 = Frozen, 21 = Gooseneck, 22 = HopperBottom, 23 = MaxiTrailer, 24 = RollOffTruck, 25 = WalkingFloor, 26 = PartialVanStandardTrailer, 27 = PartialStepDeck, 28 = PartialFlatBed, 29 = Reefer53ft, 30 = PowerOnly, 31 = FlatbedPullCurtain53ft, 32 = StepDeckPullCurtain53ft, 33 = DoubleDropPullCurtain53ft, 34 = Bulk, 35 = SprinterVan, 36 = HotShot

ErrorType

error
​string | null

FileInfo

fileName
​string | null
extension
​string | null
fileContent
​string | null · byte

HazMat

isHazMat
​boolean
unNa
​string | null

Possible values: U, N

unNaNumber
​string | null
hazClass
​string | null

Possible values: 1, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2, 2.1, 2.2, 2.3, 3, 4, 4.1, 4.2, 4.3, 5, 5.1, 5.2, 6, 6.1, 6.2, 7, 8, 9

pgCode
​string | null

Possible values: None, PGI, PGII, PGIII

subRisk
​number | null · double
vol
​number · double
limitedQuantity
​boolean

Information

resultCode
​string | null
resultDescription
​string | null
originPostalCode
​string | null
destinationPostalCode
​string | null
loadID
​string | null
customerLoadID
​string | null
proNumber
​string | null

InformationDto

loadId
​string | null
proNumber
​string | null
billingId
​string | null
customId
​string | null
poNumber
​string | null
customerBilling
​string | null

ItemDetailsInfo

qty
​string | null
packaging
​string | null

Possible values: Bags, Bales, Barrels, Baskets, Boxes, Buckets, Bulkheads, Bundles, Carboys, Cartons, Cases, Chests, Coils, Crates, Cylinders, Drums, Feet, Firkins, Hampers, Hogsheads, Kegs, Packages, Pails, Pallets, Pieces, Racks, Reels, Rolls, Skids, SlipSheets, Sows, SuperSack, Totes, Trailers, Truckload, Trunks, Tubes, Unpackaged, FloorLoaded, Tanks, PackingSlip, ChepPallets, EmptyTotes, EmptyDrums, EmptyContainers, Carrier, Gaylords, PalletsStackable, PalletsNonStackable, Doors, Skins, Jambs, BasePlate, Carts, Eaches

freightClass
​string | null

Possible values: 50, 55, 60, 65, 70, 77.5, 85, 92.5, 100, 110, 125, 150, 175, 200, 250, 300, 400, 500

weight
​string | null
nmfCnumber
​string | null
subClass
​string | null

Possible values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20

description
​string | null
​HazMat
​ItemDimensions

ItemDimensions

length
​integer · int32
height
​integer · int32
width
​integer · int32
shipQuantity
​integer · int32

LoadASNTemplateDto

isASNNeeded
​boolean
asnTemplateName
​string | null

LoadDetail

loadID
​integer · int32
shipDate
​string · date-time
carrierBooked
​string | null
scac
​string | null
proNumber
​string | null
confirmationNumber
​string | null
trackingLink
​string | null
loadStatusDetail
​string | null
billingID
​string | null
poNumber
​string | null
customID
​string | null
customerBilling
​string | null
​LocationDTO
​LocationDTO
totalWeight
​integer · int32
totalShippingQty
​integer · int32
shippingUnit
​string | null
specialInstructions
​string | null
notes
​string | null
loadStatusId
​LoadStatusType · enum

1 = Pending, 2 = Quoted, 3 = Booked, 4 = Dispatched, 5 = InTransit, 6 = Delivered, 7 = Exception, 8 = Billed, 9 = Paid, 10 = Imported, 15 = NIS, 20 = Canceled, -1 = None

Enum values:
Pending
Quoted
Booked
Dispatched
InTransit
Delivered
Exception
Billed
ship
​string | null · date-time
deliveryDate
​string | null · date-time
custCharge
​number | null · double
freightChange
​number | null · double
access
​number · double
base
​number · double
fsc
​number | null · double
insuranceFee
​number | null · double
​FileInfo
​FileInfo
​FileInfo
​FileInfo
​array | null
mileage
​integer · int32
​array | null

LoadInfoDocuments

getBillOfLadingDocument
​boolean
Default: false
​ShippingLabelDocument
getRateConfirmationDocument
​boolean
Default: false
getCarrieDocsFile
​boolean
Default: false
getFreightSnapDocuments
​boolean
Default: false

LoadInfoReference

billingId
​string | null
poNumber
​string | null
customerId
​string | null
customerBillingId
​string | null
proNumber
​string | null

LoadInformation

pickedUpDate
​string · date-time
specialInstructions
​string | null
shippingQuantity
​integer · int32
loadEquipmentType
​string | null

Possible values: VanStandardTrailer, CargoVan, StraightTruck, PartialTruckload, DoubleDrop, FlatBed, LowBoy, StepDeck, Tanker, Intermodal, CurtainSide, RGN, Refrigerated, Heated, Other, VanTrailer53ft, Container20ft, Container40ft, DumpTruck, Frozen, Gooseneck, HopperBottom, MaxiTrailer, RollOffTruck, WalkingFloor, PartialVanStandardTrailer, PartialStepDeck, PartialFlatBed, Reefer53ft, PowerOnly, FlatbedPullCurtain53ft, StepDeckPullCurtain53ft, DoubleDropPullCurtain53ft, Bulk, SprinterVan, HotShot

shippingUnits
​string | null

Possible values: Bags, Bales, Barrels, Baskets, Boxes, Buckets, Bulkheads, Bundles, Carboys, Cartons, Cases, Chests, Coils, Crates, Cylinders, Drums, Feet, Firkins, Hampers, Hogsheads, Kegs, Packages, Pails, Pallets, Pieces, Racks, Reels, Rolls, Skids, SlipSheets, Sows, SuperSack, Totes, Trailers, Truckload, Trunks, Tubes, Unpackaged, FloorLoaded, Tanks, PackingSlip, ChepPallets, EmptyTotes, EmptyDrums, EmptyContainers, Carrier, Gaylords, PalletsStackable, PalletsNonStackable, Doors, Skins, Jambs, BasePlate, Carts, Eaches

allStackable
​boolean | null
loadNotes
​string | null

LoadInformationDto

pickedUpDate
​string · date-time
mustArriveByDate
​string | null · date-time
specialInstructions
​string | null
shippingQuantity
​integer · int32
loadEquipmentType
​string | null

Possible values: VanStandardTrailer, CargoVan, StraightTruck, PartialTruckload, DoubleDrop, FlatBed, LowBoy, StepDeck, Tanker, Intermodal, CurtainSide, RGN, Refrigerated, Heated, Other, VanTrailer53ft, Container20ft, Container40ft, DumpTruck, Frozen, Gooseneck, HopperBottom, MaxiTrailer, RollOffTruck, WalkingFloor, PartialVanStandardTrailer, PartialStepDeck, PartialFlatBed, Reefer53ft, PowerOnly, FlatbedPullCurtain53ft, StepDeckPullCurtain53ft, DoubleDropPullCurtain53ft, Bulk, SprinterVan, HotShot

shippingUnits
​string | null

Possible values: Bags, Bales, Barrels, Baskets, Boxes, Buckets, Bulkheads, Bundles, Carboys, Cartons, Cases, Chests, Coils, Crates, Cylinders, Drums, Feet, Firkins, Hampers, Hogsheads, Kegs, Packages, Pails, Pallets, Pieces, Racks, Reels, Rolls, Skids, SlipSheets, Sows, SuperSack, Totes, Trailers, Truckload, Trunks, Tubes, Unpackaged, FloorLoaded, Tanks, PackingSlip, ChepPallets, EmptyTotes, EmptyDrums, EmptyContainers, Carrier, Gaylords, PalletsStackable, PalletsNonStackable, Doors, Skins, Jambs, BasePlate, Carts, Eaches

allStackable
​boolean | null
loadNotes
​string | null

LoadInformationResponse

​array | null
​array | null
​array | null

LoadRequest

loadsId
​array | null
​array | null
statusLoads
​array | null
Enum values:
Pending
Quoted
Booked
Dispatched
InTransit
Delivered
Canceled
​LoadInfoDocuments

LoadStatusType

string · enum
Enum values:
Pending
Quoted
Booked
Dispatched
InTransit
Delivered
Exception
Billed

1 = Pending, 2 = Quoted, 3 = Booked, 4 = Dispatched, 5 = InTransit, 6 = Delivered, 7 = Exception, 8 = Billed, 9 = Paid, 10 = Imported, 15 = NIS, 20 = Canceled, -1 = None

LocationDTO

name
​string | null
street1
​string | null
street2
​string | null
city
​string | null
state
​string | null
postalCode
​string | null
country
​string | null
countryId
​integer | null · int32

LocationInformation

street
​string | null
city
​string | null
state
​string | null
postalCode
​string | null
country
​string | null

Possible values: USA, CAN, OTHER, MEX

notesNotOnBOL
​string | null
dockType
​string | null

Possible values: BusinessWithDock, BusinessWithOutDock, Residence, OtherLimitedAccess, Construction, Church, Military, StorageFacility, School, Farm, Mine, Prison, Government, Nuclear, Hotel, GroceryWarehouse

LocationLoad

contact
​string | null
phone
​string | null
fax
​string | null
email
​string | null
other
​string | null
type
​string | null

Possible values: BusinessWithDock, BusinessWithOutDock, Residence, OtherLimitedAccess, Construction, Church, Military, StorageFacility, School, Farm, Mine, Prison, Government, Nuclear, Hotel, GroceryWarehouse

notes
​string | null
number
​string | null
dockOpen
​string · date-time
dockClose
​string · date-time
notesNotOnBOL
​string | null
appointment
​boolean
appointmentDate
​string · date-time
freightReadyTime
​string · date-time
name
​string | null
street
​string | null
street2
​string | null
city
​string | null
stateProvince
​string | null
postalCode
​string | null
country
​string | null

Possible values: USA, CAN, OTHER, MEX

LocationLoadDto

contact
​string | null
phone
​string | null
phoneExtension
​string | null
fax
​string | null
email
​string | null
dockType
​string | null

Possible values: BusinessWithDock, BusinessWithOutDock, Residence, OtherLimitedAccess, Construction, Church, Military, StorageFacility, School, Farm, Mine, Prison, Government, Nuclear, Hotel, GroceryWarehouse

notes
​string | null
number
​string | null
dockOpen
​string · date-time
dockClose
​string · date-time
notesNotOnBOL
​string | null
appointment
​boolean
appointmentDate
​string · date-time
freightReadyTime
​string · date-time
acceptGoogleSuggestions
​boolean
acceptAddyBookSuggestion
​boolean
acceptAccessorialSuggestions
​boolean
name
​string | null
street
​string | null
street2
​string | null
city
​string | null
stateProvince
​string | null
postalCode
​string | null
country
​string | null

Possible values: USA, CAN, OTHER, MEX

MessageDto

description
​string | null
type
​string | null

Notification

notificationID
​integer · int32
emails
​string | null
potentialLate
​boolean
loadException
​boolean
rateChange
​boolean
delivery
​boolean
weatherDelay
​boolean
reweigh
​boolean

PGType

string · enum
Enum values:
None
PGI
PGII
PGIII

0 = None, 1 = PGI, 2 = PGII, 3 = PGIII

QuoteEngineRequest

mustArriveByDate
​string | null · date-time
​LocationInformation
​LocationInformation
​array | null
​TotalDetail
​Accessorials

QuoteEngineResponse

​Information
​array | null
​array | null
​array | null
​array | null

QuoteInfoDetail

carrier
​string | null
scac
​string | null
customerCharge
​string | null
freightCharge
​string | null
transitTime
​string | null
indirect
​boolean
notes
​string | null
pricingOwnershipID
​integer · int32
access
​number · double
base
​number · double
fsc
​number · double
totalCharge
​number · double
serviceLevel
​string | null
tenantPricing
​boolean
insuranceFee
​number · double
mode
​string | null
success
​boolean
errorMessage
​string | null
performance
​string | null
smartSelect
​string | null

ShippingLabelDocument

isRequiered
​boolean
Default: false
reportTypeId
​integer · int32
Default: 802

StatusLoad

string · enum
Enum values:
Pending
Quoted
Booked
Dispatched
InTransit
Delivered
Canceled

1 = Pending, 2 = Quoted, 3 = Booked, 4 = Dispatched, 5 = InTransit, 6 = Delivered, 20 = Canceled

SubclassClassifier

integer · enum · int32
Enum values:
1
2
3
4
5
6
7
8

1 = Subclass1, 2 = Subclass2, 3 = Subclass3, 4 = Subclass4, 5 = Subclass5, 6 = Subclass6, 7 = Subclass7, 8 = Subclass8, 9 = Subclass9, 10 = Subclass10, 11 = Subclass11, 12 = Subclass12, 13 = Subclass13, 14 = Subclass14, 15 = Subclass15, 16 = Subclass16, 17 = Subclass17, 18 = Subclass18, 19 = Subclass19, 20 = Subclass20

TotalDetail

quantity
​string · minLength: 1 · required
units
​string · minLength: 1 · required
customerLoadID
​string | null
proNumber
​string | null
linFt
​integer · int32
linIn
​integer · int32
includeVol
​boolean
includeGuar
​boolean
includeMABDProgram
​boolean
equipment
​string | null

Possible values: VanStandard, VanTrailer53ft, Container20ft, Container40ft, DoubleDrop, DumpTruck, FlatBed, Frozen, Gooseneck, HopperBottom, LowBoy, MaxiTrailer, Other, Refrigerated, RollOffTruck, StepDeck, Tanker, WalkingFloor, Intermodal, PartialTruckload, CargoVan, StraightTruck, Heated, PartialVanStandardTrailer, PartialStepDeck, PartialFlatBed, Reefer53ft, PowerOnly, CurtainSide

allStackable
​boolean | null

TrackingStatusUpdate

time
​string | null · date-time
status
​string | null
message
​string | null
weight
​number · double
cost
​number · double
carrierETA
​string | null
updatedOn
​string | null · date-time

TypePackaging

string · enum
Enum values:
Bags
Bales
Barrels
Baskets
Boxes
Buckets
Bulkheads
Bundles

10 = Bags, 11 = Bales, 12 = Barrels, 13 = Baskets, 14 = Boxes, 15 = Buckets, 16 = Bulkheads, 17 = Bundles, 18 = Carboys, 19 = Cartons, 20 = Cases, 21 = Chests, 22 = Coils, 23 = Crates, 24 = Cylinders, 25 = Drums, 26 = Feet, 27 = Firkins, 28 = Hampers, 29 = Hogsheads, 30 = Kegs, 31 = Packages, 32 = Pails, 33 = Pallets, 34 = Pieces, 35 = Racks, 36 = Reels, 37 = Rolls, 38 = Skids, 39 = SlipSheets, 40 = Sows, 41 = SuperSack, 42 = Totes, 43 = Trailers, 44 = Truckload, 45 = Trunks, 46 = Tubes, 47 = Unpackaged, 48 = FloorLoaded, 49 = Tanks, 50 = PackingSlip, 51 = ChepPallets, 52 = EmptyTotes, 53 = EmptyDrums, 54 = EmptyContainers, 55 = Carrier, 56 = Gaylords, 57 = PalletsStackable, 58 = PalletsNonStackable, 59 = Doors, 60 = Skins, 61 = Jambs, 62 = BasePlate, 63 = Carts, 71 = Eaches

UNNAType

string · enum
Enum values:
U
N

0 = U, 1 = N

UpdateLoad - Country

type
​Countries · enum · int32 · required

1 = USA, 2 = CAN, 3 = OTHER, 4 = MEX

Enum values:
1
2
3
4

UpdateLoad - DockType

type
​AccesorialDockType · enum · required

280 = BusinessWithDock, 281 = BusinessWithOutDock, 282 = Residence, 283 = OtherLimitedAccess, 284 = Construction, 285 = Church, 286 = Military, 287 = StorageFacility, 288 = School, 289 = Farm, 290 = Mine, 291 = Prison, 292 = Government, 293 = Nuclear, 294 = Hotel, 295 = GroceryWarehouse

Enum values:
BusinessWithDock
BusinessWithOutDock
Residence
OtherLimitedAccess
Construction
Church
Military
StorageFacility

UpdateLoad - FreightClass

type
​ClassifierFreightClass · enum · int32 · required

100 = FreightClass50, 101 = FreightClass55, 102 = FreightClass60, 103 = FreightClass65, 104 = FreightClass70, 105 = FreightClass77_5, 106 = FreightClass85, 107 = FreightClass92_5, 108 = FreightClass100, 109 = FreightClass110, 110 = FreightClass125, 111 = FreightClass150, 112 = FreightClass175, 113 = FreightClass200, 114 = FreightClass250, 115 = FreightClass300, 116 = FreightClass400, 117 = FreightClass500

Enum values:
100
101
102
103
104
105
106
107

UpdateLoad - HazClass

type
​ClassifierHazClass · enum · int32 · required

210 = HazClass1, 211 = HazClass1_1, 212 = HazClass1_2, 213 = HazClass1_3, 214 = HazClass1_4, 215 = HazClass1_5, 216 = HazClass1_6, 217 = HazClass2, 218 = HazClass2_1, 219 = HazClass2_2, 220 = HazClass2_3, 221 = HazClass3, 222 = HazClass4, 223 = HazClass4_1, 224 = HazClass4_2, 225 = HazClass4_3, 226 = HazClass5, 227 = HazClass5_1, 228 = HazClass5_2, 229 = HazClass6, 230 = HazClass6_1, 231 = HazClass6_2, 232 = HazClass7, 233 = HazClass8, 234 = HazClass9

Enum values:
210
211
212
213
214
215
216
217

UpdateLoad - LabelTypeId

type
​ClassifierLoadShipLabelReport · enum · int32 · required

800 = ShipLabel6x4Page1x4, 801 = ShipLabel8x11Page1x1, 802 = ShipLabel11x8Page4x1, 803 = ShipLabel6x4Page1x1, 804 = ShipLabel4x6Page1x4, 805 = ShipLabel4x6Page1x2, 806 = ShipLabel4x3Page1x4, 807 = ShipLabel4x2Page1x4, 808 = ShipLabel8x4Page1x1, 809 = ShipLabel11x8Page1x1, 813 = ShipLabel4x6Page1x1, 814 = ShipLabel2x4Page1x2, 815 = ShipLabel4x4Page1x4, 816 = ShipLabel4x7Page1x1

Enum values:
800
801
802
803
804
805
806
807

UpdateLoad - LoadEquipmentType

type
​EquipmentType · enum · required

1 = VanStandardTrailer, 2 = CargoVan, 3 = StraightTruck, 4 = PartialTruckload, 5 = DoubleDrop, 6 = FlatBed, 7 = LowBoy, 8 = StepDeck, 9 = Tanker, 10 = Intermodal, 11 = CurtainSide, 12 = RGN, 13 = Refrigerated, 14 = Heated, 15 = Other, 16 = VanTrailer53ft, 17 = Container20ft, 18 = Container40ft, 19 = DumpTruck, 20 = Frozen, 21 = Gooseneck, 22 = HopperBottom, 23 = MaxiTrailer, 24 = RollOffTruck, 25 = WalkingFloor, 26 = PartialVanStandardTrailer, 27 = PartialStepDeck, 28 = PartialFlatBed, 29 = Reefer53ft, 30 = PowerOnly, 31 = FlatbedPullCurtain53ft, 32 = StepDeckPullCurtain53ft, 33 = DoubleDropPullCurtain53ft, 34 = Bulk, 35 = SprinterVan, 36 = HotShot

Enum values:
VanStandardTrailer
CargoVan
StraightTruck
PartialTruckload
DoubleDrop
FlatBed
LowBoy
StepDeck

UpdateLoad - Packaging

type
​TypePackaging · enum · required

10 = Bags, 11 = Bales, 12 = Barrels, 13 = Baskets, 14 = Boxes, 15 = Buckets, 16 = Bulkheads, 17 = Bundles, 18 = Carboys, 19 = Cartons, 20 = Cases, 21 = Chests, 22 = Coils, 23 = Crates, 24 = Cylinders, 25 = Drums, 26 = Feet, 27 = Firkins, 28 = Hampers, 29 = Hogsheads, 30 = Kegs, 31 = Packages, 32 = Pails, 33 = Pallets, 34 = Pieces, 35 = Racks, 36 = Reels, 37 = Rolls, 38 = Skids, 39 = SlipSheets, 40 = Sows, 41 = SuperSack, 42 = Totes, 43 = Trailers, 44 = Truckload, 45 = Trunks, 46 = Tubes, 47 = Unpackaged, 48 = FloorLoaded, 49 = Tanks, 50 = PackingSlip, 51 = ChepPallets, 52 = EmptyTotes, 53 = EmptyDrums, 54 = EmptyContainers, 55 = Carrier, 56 = Gaylords, 57 = PalletsStackable, 58 = PalletsNonStackable, 59 = Doors, 60 = Skins, 61 = Jambs, 62 = BasePlate, 63 = Carts, 71 = Eaches

Enum values:
Bags
Bales
Barrels
Baskets
Boxes
Buckets
Bulkheads
Bundles

UpdateLoad - PgCode

type
​PGType · enum · required

0 = None, 1 = PGI, 2 = PGII, 3 = PGIII

Enum values:
None
PGI
PGII
PGIII

UpdateLoad - ShippingUnits

type
​TypePackaging · enum · required

10 = Bags, 11 = Bales, 12 = Barrels, 13 = Baskets, 14 = Boxes, 15 = Buckets, 16 = Bulkheads, 17 = Bundles, 18 = Carboys, 19 = Cartons, 20 = Cases, 21 = Chests, 22 = Coils, 23 = Crates, 24 = Cylinders, 25 = Drums, 26 = Feet, 27 = Firkins, 28 = Hampers, 29 = Hogsheads, 30 = Kegs, 31 = Packages, 32 = Pails, 33 = Pallets, 34 = Pieces, 35 = Racks, 36 = Reels, 37 = Rolls, 38 = Skids, 39 = SlipSheets, 40 = Sows, 41 = SuperSack, 42 = Totes, 43 = Trailers, 44 = Truckload, 45 = Trunks, 46 = Tubes, 47 = Unpackaged, 48 = FloorLoaded, 49 = Tanks, 50 = PackingSlip, 51 = ChepPallets, 52 = EmptyTotes, 53 = EmptyDrums, 54 = EmptyContainers, 55 = Carrier, 56 = Gaylords, 57 = PalletsStackable, 58 = PalletsNonStackable, 59 = Doors, 60 = Skins, 61 = Jambs, 62 = BasePlate, 63 = Carts, 71 = Eaches

Enum values:
Bags
Bales
Barrels
Baskets
Boxes
Buckets
Bulkheads
Bundles

UpdateLoad - SubClass

type
​SubclassClassifier · enum · int32 · required

1 = Subclass1, 2 = Subclass2, 3 = Subclass3, 4 = Subclass4, 5 = Subclass5, 6 = Subclass6, 7 = Subclass7, 8 = Subclass8, 9 = Subclass9, 10 = Subclass10, 11 = Subclass11, 12 = Subclass12, 13 = Subclass13, 14 = Subclass14, 15 = Subclass15, 16 = Subclass16, 17 = Subclass17, 18 = Subclass18, 19 = Subclass19, 20 = Subclass20

Enum values:
1
2
3
4
5
6
7
8

UpdateLoad - UnNa

type
​UNNAType · enum · required

0 = U, 1 = N

Enum values:
U
N

UpdateLoadActionOptionDto

loadId
​integer · int32
accountId
​integer · int32
rate
​boolean
book
​string | null
proNumber
​boolean
dispatch
​boolean
errorEmailNotification
​string | null

Email address that receives the error notification when one of the requested actions fails. Multiple recipients are supported: separate the addresses with a comma, for example "ops@company.com,support@company.com". The comma is the only accepted separator (a semicolon is not), spaces around each address are ignored, and the whole value is limited to 500 characters.

UpdateLoadDetailDto

billingID
​string | null
poNumber
​string | null
proNumber
​string | null
customID
​string | null
customerBilling
​string | null

UpdateLoadRequestDto

​EmailParametersDto
​UpdateLoadDetailDto
​BillingLocationDto
​LocationLoadDto
​LocationLoadDto
​Accessorials
​array | null
​LoadInformationDto
​array | null

UpdateReRateRequest

mustArriveByDate
​string | null · date-time
loadId
​integer · int32
​BillingReRateInformation
​LocationLoad
​LocationLoad
​array | null
​Accessorials
​LoadInformation
​AccessoryListReRate

WarningType

warning
​string | null