Models O

Data models used in RushHour API requests and responses. Property names are shown as the API sends them. See the API reference overview for how enumerated values are written.

OnTimeRateDto

Property	Type	Description
days	integer (int32)
graceMinutes	integer (int32)	Minutes of grace past the scheduled instant before a delivery counts late.
total	integer (int32)	Delivered orders in the window with a measurable scheduled time.
onTime	integer (int32)
late	integer (int32)
onTimePct	number (double)	Can be null.

Order

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
orderId	integer (int32)
orderNumber	string	Can be null.
parentOrderId	integer (int32)	Can be null.
parentOrder	Order
childOrders	array of Order	Can be null.
purchaseOrderNumber	string	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
customer	Customer
billToInfo	string	Can be null.
orderStatus	string	One of: Dreft, Quote, Order, Deleted, Closed.
date	string (date-time)
orderStops	array of OrderStop	Can be null.
orderItems	array of OrderItem	Can be null.
setupStep	string	One of: pickups, deliveries, summary.
invoices	array of Invoice	Can be null.
orderTags	array of OrderTag	Can be null.
customerId	integer (int32)	Can be null.
shipmentTypeId	integer (int32)	Can be null.
addresssString	string	Can be null.
directionPolyline	string	Can be null.
tripStatus	string	Can be null. One of: Open, Assigned, InTransit, Delivered.
directionsJson	string	Can be null.
hasInvoice	boolean
invoice	Invoice
paymentStatus	string	Can be null. One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
directions	object
costLines	array of CostLine	Can be null.
markupType	string	One of: Value, Percent.
markupValue	number (double)	Can be null.
discountType	string	One of: Value, Percent.
discountValue	number (double)	Can be null.
discountDescription	string	Can be null.
price	number (double)	Can be null.
buyingPrice	number (double)	Can be null.
oldPriceInfo	number (double)	Can be null.
newPriceInfo	number (double)	Can be null.
customPriceInfo	number (double)	Can be null.
notes	string	Can be null.
commonNotes	string	Can be null.
attachments	array of Attachment	Can be null.
sentEmails	array of SentEmail	Can be null.
isQuoteSent	boolean	Read-only.
isInvoiceSent	boolean	Read-only.
isBillOfLandingSent	boolean	Read-only.
orderTrips	array of OrderTrip	Can be null.
pickupCount	integer (int32)
deliveryCount	integer (int32)
itemCount	integer (int32)
additionalChargesTotal	number (double)
waitingTimeTotal	number (double)
invoiceTotal	number (double)
shipmentScope	string	Read-only. One of: Internal, International.
warehouseForPickupDeliveryStopIds	map of integer (int32)	Can be null.
priceReflectsCurrentRoute	boolean	False when the stored price was not computed from the stops the order currently holds - either it was never computed, or a directions lookup failed and the previous price was carried over.
routes	array of Route	Can be null.
tags	array of Tag	Can be null.
recursSaturday	boolean
recursFriday	boolean
recursThursday	boolean
recursWednesday	boolean
recursTuesday	boolean
recursMonday	boolean
recursSunday	boolean
recursEveryMonth	boolean
recursEveryOtherWeek	boolean
shipmentType	ShipmentType
miles	number (double)
minutes	number (double)
isCreditCardPaymentAuthorized	boolean
creditCardAuthorizedAmount	number (double)	Can be null.
creditCardAuthorizationReferenceNumber	string	Can be null.
userProfile	object
type	integer (int32)	One of: 0 (Default), 1 (FullRoute).
routeItemCharges	array of RouteItemCharge	Can be null.
customerContactId	integer (int32)	Can be null.
customerContact	CustomerContact
priority	string	Can be null. One of: Low, Regular, High.
source	integer (int32)	One of: 0 (Default), 1 (Web), 2 (CustomerPortal).
trackingNumber	string	Can be null.
useNewPricingModel	boolean	Can be null.
pricingModelType	integer (int32)	One of: 0 (Default), 1 (Pallets), 2 (Custom).
showTransferCards	boolean	Can be null.
customerInfo	object
currencyCode	string	Can be null. Up to 3 characters.
freightMode	string	Can be null. How this shipment moves. One of: Ground, Ocean, Air.
declaredValue	number (double)	Can be null. Declared / customs value of the shipment, in the order's currency.
chargeableWeightKg	number (double)	Can be null.
pricingIntlRateId	integer (int32)	Can be null. The international rate card that priced this order, when one did.
intlDeclineReason	string	Can be null. Why international pricing declined this order, when the decline was one a human should hear about. One of: None, NotInternational, NoCardMatched, QuantityNotBillable, NoBandForQuantity, BandHasNoRate, CardOutsideValidityWindow, LegCurrencyMismatch, ModeMismatch, AreaPriceUponRequest, LegNarrowedAway.

OrderAuditChange

Property	Type	Description
field	string	Can be null.
label	string	Can be null.
kind	string	One of: Text, Number, Money, Date, DateTime, Time, Boolean, Enum, Reference.
oldValue	string	Can be null. Rendered value before the change.
newValue	string	Can be null. Rendered value after the change.

OrderAuditFeedItemDto

Property	Type	Description
id	string	Can be null.
source	string	One of: OrderAudit, StopActivity, InvoiceActivity, Derived.
orderStopActivityId	integer (int32)	Can be null.
occurredUtc	string (date-time)	When it happened (UTC).
correlationId	string (uuid)	Can be null. Groups the several saves of one user action.
category	string	One of: Lifecycle, Details, Stops, Items, Pricing, Charges, Dispatch, Accounting, Other.
action	string	Can be null. One of: Created, Updated, Removed, Restored, StatusChanged.
eventType	string	Can be null.
entityType	string	Can be null.
entityId	integer (int32)	Can be null.
entityLabel	string	Can be null. Snapshot label of the changed record, as it read at the time.
summary	string	Can be null.
changes	array of OrderAuditChange	Can be null.
actorType	string	Which kind of actor performed this. One of: Staff, Driver, CustomerPortal, ExternalAnonymous, AiAgent, System.
actorName	string	Can be null.
actorUserId	string	Can be null.
user	object
driver	object	Driver behind the action, for avatar rendering.
orderStopId	integer (int32)	Can be null. Stop this event concerns.
orderStopType	string	Can be null. One of: Pickup, Delivery, Transfer.
routeId	integer (int32)	Can be null. Route this event concerns.
description	string	Can be null.
note	string	Can be null.
oldPrice	number (double)	Can be null. Price before the change.
newPrice	number (double)	Can be null. Price after the change.
oldPricingType	integer (int32)	Can be null. Pricing model before the change. One of: 0 (Default), 1 (Pallets), 2 (Custom).
newPricingType	integer (int32)	Can be null. Pricing model after the change. One of: 0 (Default), 1 (Pallets), 2 (Custom).
oldInvoiceId	integer (int32)	Can be null. Invoice the price moved from, when one existed.
newInvoiceId	integer (int32)	Can be null. Invoice the price moved to, when one existed.
invoiceId	integer (int32)	Can be null.
invoiceNumber	string	Can be null.

OrderAuditLogDto

Property	Type	Description
items	array of OrderAuditFeedItemDto	Can be null. The page of events, newest first.
totalCount	integer (int32)	Total matching events across all pages.
page	integer (int32)	Zero-based page index that was returned.
pageSize	integer (int32)	Page size that was applied.
hasMore	boolean	Whether more events exist beyond this page.

OrderBarcodeFreightDto

Property	Type	Description
orderItemStopId	integer (int32)
quantity	integer (int32)
type	string	One of: Boxes & Crates, Pallets, Full Load, CFS, Other, Bags, Pallets+.
orderItemId	integer (int32)	Can be null.
name	string	Can be null.
code	string	Can be null.
codes	array of BarcodeScanCodeDto	Can be null.
loadUnits	array of OrderBarcodeLoadUnitDto	Can be null.

OrderBarcodeLoadUnitContentDto

Property	Type	Description
loadUnitContentId	integer (int32)
quantity	integer (int32)
indexOnUnit	integer (int32)
type	string	One of: Unknown, Boxes, Bags, Pallets.
name	string	Can be null.
code	string	Can be null.
codes	array of BarcodeScanCodeDto	Can be null.

OrderBarcodeLoadUnitDto

Property	Type	Description
loadUnitId	integer (int32)
type	string	One of: Unknown, Pallet, Box, Bag, Crate, Drum, Roll, Container, Tote, Cage, Bundle, Parcel, Other.
locationIndex	integer (int32)
name	string	Can be null.
code	string	Can be null.
codes	array of BarcodeScanCodeDto	Can be null.
contents	array of OrderBarcodeLoadUnitContentDto	Can be null.

OrderBarcodeStopDto

Property	Type	Description
orderStopId	integer (int32)
stopNumber	integer (int32)
stopType	string	One of: Pickup, Delivery, Transfer.
locationCompanyName	string	Can be null.
date	string (date-time)	Can be null.
time	string (date-time)	Can be null.
dateTime	string (date-time)	Can be null.
address	Address
codes	array of BarcodeScanCodeDto	Can be null.
freight	array of OrderBarcodeFreightDto	Can be null.

OrderDto

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
orderId	integer (int32)
orderNumber	string	Can be null.
parentOrderId	integer (int32)	Can be null.
parentOrder	Order
childOrders	array of Order	Can be null.
purchaseOrderNumber	string	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
customer	Customer
billToInfo	string	Can be null.
orderStatus	string	One of: Dreft, Quote, Order, Deleted, Closed.
date	string (date-time)
orderStops	array of OrderStop	Can be null.
orderItems	array of OrderItem	Can be null.
setupStep	string	One of: pickups, deliveries, summary.
invoices	array of Invoice	Can be null.
orderTags	array of OrderTag	Can be null.
customerId	integer (int32)	Can be null.
shipmentTypeId	integer (int32)	Can be null.
addresssString	string	Can be null.
directionPolyline	string	Can be null.
tripStatus	string	Can be null. One of: Open, Assigned, InTransit, Delivered.
directionsJson	string	Can be null.
hasInvoice	boolean
invoice	Invoice
paymentStatus	string	Can be null. One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
directions	object
costLines	array of CostLine	Can be null.
markupType	string	One of: Value, Percent.
markupValue	number (double)	Can be null.
discountType	string	One of: Value, Percent.
discountValue	number (double)	Can be null.
discountDescription	string	Can be null.
price	number (double)	Can be null.
buyingPrice	number (double)	Can be null.
oldPriceInfo	number (double)	Can be null.
newPriceInfo	number (double)	Can be null.
customPriceInfo	number (double)	Can be null.
notes	string	Can be null.
commonNotes	string	Can be null.
attachments	array of Attachment	Can be null.
sentEmails	array of SentEmail	Can be null.
isQuoteSent	boolean	Read-only.
isInvoiceSent	boolean	Read-only.
isBillOfLandingSent	boolean	Read-only.
orderTrips	array of OrderTrip	Can be null.
pickupCount	integer (int32)
deliveryCount	integer (int32)
itemCount	integer (int32)
additionalChargesTotal	number (double)
waitingTimeTotal	number (double)
invoiceTotal	number (double)
shipmentScope	string	Read-only. One of: Internal, International.
warehouseForPickupDeliveryStopIds	map of integer (int32)	Can be null.
priceReflectsCurrentRoute	boolean	False when the stored price was not computed from the stops the order currently holds - either it was never computed, or a directions lookup failed and the previous price was carried over.
routes	array of Route	Can be null.
tags	array of Tag	Can be null.
recursSaturday	boolean
recursFriday	boolean
recursThursday	boolean
recursWednesday	boolean
recursTuesday	boolean
recursMonday	boolean
recursSunday	boolean
recursEveryMonth	boolean
recursEveryOtherWeek	boolean
shipmentType	ShipmentType
miles	number (double)
minutes	number (double)
isCreditCardPaymentAuthorized	boolean
creditCardAuthorizedAmount	number (double)	Can be null.
creditCardAuthorizationReferenceNumber	string	Can be null.
userProfile	object
type	integer (int32)	One of: 0 (Default), 1 (FullRoute).
routeItemCharges	array of RouteItemCharge	Can be null.
customerContactId	integer (int32)	Can be null.
customerContact	CustomerContact
priority	string	Can be null. One of: Low, Regular, High.
source	integer (int32)	One of: 0 (Default), 1 (Web), 2 (CustomerPortal).
trackingNumber	string	Can be null.
useNewPricingModel	boolean	Can be null.
pricingModelType	integer (int32)	One of: 0 (Default), 1 (Pallets), 2 (Custom).
showTransferCards	boolean	Can be null.
customerInfo	object
currencyCode	string	Can be null. Up to 3 characters.
freightMode	string	Can be null. How this shipment moves. One of: Ground, Ocean, Air.
declaredValue	number (double)	Can be null. Declared / customs value of the shipment, in the order's currency.
chargeableWeightKg	number (double)	Can be null.
pricingIntlRateId	integer (int32)	Can be null. The international rate card that priced this order, when one did.
intlDeclineReason	string	Can be null. Why international pricing declined this order, when the decline was one a human should hear about. One of: None, NotInternational, NoCardMatched, QuantityNotBillable, NoBandForQuantity, BandHasNoRate, CardOutsideValidityWindow, LegCurrencyMismatch, ModeMismatch, AreaPriceUponRequest, LegNarrowedAway.
previousOrderId	integer (int32)	Can be null.
nextOrderId	integer (int32)	Can be null.

OrderHoldDto

Property	Type	Description
orderHoldId	integer (int32)
orderId	integer (int32)
orderStopId	integer (int32)	Can be null.
scope	string	One of: Order, DeliveryStop.
status	string	One of: Active, Resolved.
reason	string	Can be null.
placedByUserId	integer (int32)	Can be null.
placedBy	object
placedAt	string (date-time)
resolvedByUserId	integer (int32)	Can be null.
resolvedBy	object
resolvedAt	string (date-time)	Can be null.
resolutionMethod	string	Can be null. One of: Manual, Payment.

OrderInfoDto

Property	Type	Description
pickups	array of OrderStopInfoDto	Can be null.
deliveries	array of OrderStopInfoDto	Can be null.
transfers	array of RouteItem	Can be null.
orderItems	array of OrderItemInfoDto	Can be null.

OrderItem

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
orderItemId	integer (int32)
order	Order
orderItemType	string	One of: Boxes & Crates, Pallets, Full Load, CFS, Other, Bags, Pallets+.
plannedOrderItemType	string	Can be null. One of: Boxes & Crates, Pallets, Full Load, CFS, Other, Bags, Pallets+.
itemName	string	Can be null.
itemDescription	string	Can be null.
sizeUnitOfMeasure	string	Can be null. One of: Inches, Centimeters, Pounds, Kilograms, Miles, Kilometers.
sizeType	string	Can be null. One of: PalletStandard, PalletSmall, PalletLarge, Custom, LoadTrailer, LoadTruck, LoadVan.
fullLoadPalletSize	string	Can be null. One of: PalletStandard, PalletSmall, PalletLarge.
sizeLength	number (double)	Can be null.
sizeWidth	number (double)	Can be null.
sizeHight	number (double)	Can be null.
wight	number (double)	Can be null.
orderId	integer (int32)	Can be null.
cbmWeight	number (double)	Can be null.
quantityOfTrucks	integer (int32)	Can be null.
totalWeightUnitOfMeasure	string	Can be null. One of: Inches, Centimeters, Pounds, Kilograms, Miles, Kilometers.
totalWeight	number (double)	Can be null.
containerNumber	string	Can be null.
withTracker	boolean
itemsPackedIn	integer (int32)	One of: 0 (BoxAndCrates), 1 (Boxes), 2 (Pallets).
wightUnitOfMeasure	string	Can be null. One of: Inches, Centimeters, Pounds, Kilograms, Miles, Kilometers.
accessoriesNeeded	array of OrderItemAccessory	Can be null.
isFragile	boolean
isHazardous	boolean
isRefrigerated	boolean
isOverweight	boolean
isOther	boolean
attachments	array of Attachment	Can be null.
orderItemStops	array of OrderItemStop	Can be null.
isActive	boolean
companyId	integer (int32)
tenantId	string (uuid)
tenant	object
routeItems	array of RouteItem	Can be null.
quantityToPick	integer (int32)
pickQuantity	integer (int32)
routePickupOrderItemStopId	integer (int32)	Can be null.
routeDeliveryOrderItemStopId	integer (int32)	Can be null.
isOrderItemTypeChanged	boolean	Read-only.
totalQuantity	number (double)	Read-only.
pickedQuantity	number (double)	Read-only.
formatedMeasurements	string	Read-only. Can be null.
formatedWeight	string	Read-only. Can be null.
formattedUnitOfMeasure	string	Read-only. Can be null.
itemTypeQty	string	Read-only. Can be null.
sizeTypeName	string	Read-only. Can be null.

OrderItemAccessory

Property	Type	Description
orderItemAccessoryId	integer (int32)
orderItem	OrderItem
accessoryType	integer (int32)	One of: 1 (Handtruck).
isActive	boolean
orderItemId	integer (int32)	Can be null.
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object

OrderItemEventDto

Property	Type	Description
type	string	One of: Unassigned, Assigned, Confirmed, OrderCreated, OrderUpdated, Order Completed, Quote Approved, Stop Updated, Order Assigned, Order Unassigned, Stop Assigned, Stop Unassigned, Route Copied, Stop Copied, Order Confirmed, Stop Confirmed, Order Undo, Stop Undo, Note Created, Note Updated, Reverted To Quote, Invoice Created, Invoice Created Automatically, Invoice Sent, BOL Sent, Payment Added, Related Order Created, Email Sent, Email Received, Price Updated, Hold Placed, Hold Resolved, Auto Charge Applied, Auto Charge Dismissed, Item Added, Item Removed, Item Increased, Item Decreased, Unsuccessful Stop, Postponed Stop.
date	string (date-time)
orderStopId	integer (int32)	Can be null. The stop this event belongs to, so the timeline can group by leg.
orderStopType	string	Can be null. One of: Pickup, Delivery, Transfer.

OrderItemInfoDto

Property	Type	Description
totalQuantity	integer (int32)
totalItemAllocated	integer (int32)
totalItemsUnallocated	integer (int32)
orderItem	OrderItem
orderItemStops	array of OrderItemStopInfoDto	Can be null.

OrderItemStop

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
orderItemStopId	integer (int32)
orderItem	OrderItem
orderStop	OrderStop
orderItemId	integer (int32)	Can be null.
orderStopId	integer (int32)	Can be null.
warehouseItem	WarehouseItem
quantity	integer (int32)
plannedQuantity	integer (int32)	Can be null.
notes	string	Can be null.
isActive	boolean
companyId	integer (int32)
tenantId	string (uuid)
tenant	object
loadUnits	array of LoadUnit	Can be null.
routeItems	array of RouteItem	Can be null.
qtyAssinedToTrip	integer (int32)
isQuantityChanged	boolean	Read-only.

OrderItemStopInfoDto

Property	Type	Description
pickupNumber	integer (int32)
deliveryNumber	integer (int32)
deliveryAllocatedQty	integer (int32)
deliveryConfirmedQty	integer (int32)
pickupType	string	One of: Pickup, Delivery, Transfer.
deliveryType	string	One of: Pickup, Delivery, Transfer.
pickupAddress	Address
deliveryAddress	Address
dateOfPickup	string (date-time)	Can be null.
timeOfPickup	string (date-time)	Can be null.
dateTimeOfPickup	string (date-time)	Can be null.
dateOfDelivery	string (date-time)	Can be null.
timeOfDelivery	string (date-time)	Can be null.
dateTimeOfDelivery	string (date-time)	Can be null.

OrderListDto

Property	Type	Description
orderId	integer (int32)
customerId	integer (int32)	Can be null.
date	string (date-time)
orderNumber	string	Can be null.
price	number (double)	Can be null.
buyingPrice	number (double)	Can be null.
customerName	string	Can be null.
tripStatus	string	One of: Open, Assigned, InTransit, Delivered.
orderStatus	string	One of: Dreft, Quote, Order, Deleted, Closed.
isOnHold	boolean
source	integer (int32)	One of: 0 (Default), 1 (Web), 2 (CustomerPortal).
hasInvoice	boolean
invoiceId	integer (int32)	Can be null.
invoiceNumber	string	Can be null.
addressFrom	array of string	Can be null.
addressTo	array of string	Can be null.
orderForDriver	string	Can be null.
balance	number (double)
paymentStatus	string	Can be null. One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
paymentMethodType	integer (int32)	Can be null. One of: 0 (Check), 1 (Cash), 2 (PaymentMethod).
createdCompanyUserName	string	Can be null.
purchaseOrderNumber	string	Can be null.
trackingNumber	string	Can be null.
createdTime	string (date-time)
sentEmails	array of SentEmail	Can be null.
orderStops	array of OrderStopBasicDetailsDto	Can be null.
priceBalance	number (double)	Can be null.
customerInfo	object

OrderListDtoPagedList

A page of results. See Pagination and filtering.

Property	Type	Description
list	array of OrderListDto	Can be null.
page	integer (int32)
itemsPerPage	integer (int32)
totalCount	integer (int32)

OrderMapStopDto

Property	Type	Description
orderStopId	integer (int32)
type	string	One of: Pickup, Delivery, Transfer.
city	string	Can be null.
state	string	Can be null.
latitude	number (double)	Can be null.
longitude	number (double)	Can be null.
dateTime	string (date-time)	Can be null.
isOnHold	boolean

OrderMapViewDto

Property	Type	Description
orderId	integer (int32)
orderNumber	string	Can be null.
orderStatus	string	One of: Dreft, Quote, Order, Deleted, Closed.
tripStatus	string	One of: Open, Assigned, InTransit, Delivered.
priority	string	Can be null. One of: Low, Regular, High.
isOnHold	boolean	Any active stop is held.
hasInvoice	boolean
customerId	integer (int32)	Can be null.
customerName	string	Can be null.
date	string (date-time)
stops	array of OrderMapStopDto	Can be null.

OrderPagedList

A page of results. See Pagination and filtering.

Property	Type	Description
list	array of Order	Can be null.
page	integer (int32)
itemsPerPage	integer (int32)
totalCount	integer (int32)

OrderRouteSnapshotDto

Property	Type	Description
orderRouteStops	array of OrderRouteStopSnapshot	Can be null.
deliveryDate	string (date-time)	Can be null.
deliveryDateTime	string (date-time)	Can be null.
directions	object

OrderRouteStopSnapshot

Property	Type	Description
type	string	One of: Pickup, Delivery, Transfer.
latLng	object
isDone	boolean

OrdersMapViewResDto

Property	Type	Description
totalCount	integer (int32)	Total orders matching the filters (what the list endpoint would report).
returnedCount	integer (int32)	Orders actually returned (≤ the cap).
truncated	boolean
withoutGeoCount	integer (int32)	Returned orders whose active stops all lack coordinates.
orders	array of OrderMapViewDto	Can be null.

OrderStats

Property	Type	Description
unassignedOrdersCount	integer (int32)	Orders without assigned trip (Open or null trip status).
dispatchedOrdersCount	integer (int32)
pendingOrdersCount	integer (int32)	Orders in Draft or Quote status.
ordersCount	integer (int32)	Total active orders (Order status only, excluding quotes).
onRouteCount	integer (int32)	Orders currently in transit.
completeCount	integer (int32)	Completed orders (Delivered + Closed).
unpaidOrders	integer (int32)	Orders with outstanding balance.
draftsCount	integer (int32)	Total number of draft orders.
quotesCount	integer (int32)	Total number of quotes.

OrderStop

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
orderStopId	integer (int32)
order	Order
orderId	integer (int32)	Can be null.
shipmentTypeId	integer (int32)	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
tenant	object
orderStopType	string	One of: Pickup, Delivery, Transfer.
addressId	integer (int32)	Can be null.
address	Address
addressDetails	string	Can be null.
locationCompanyName	string	Can be null.
locationContactName	string	Can be null.
locationContactNumber	string	Can be null.
locationContactNumberExtension	string	Can be null.
locationContactEmail	string	Can be null.
locationContactCountryCode	string	Can be null. Up to 4 characters.
locationContactCountryIso	string	Can be null. Up to 3 characters.
referenceNumber	string	Can be null.
dateType	string	Can be null. One of: None, Today, Tomorrow, Custom.
date	string (date-time)	Can be null.
timeType	string	Can be null. One of: None, Morning, Noon, Evening, Custom.
time	string (date-time)	Can be null.
dateTime	string (date-time)	Can be null.
orderItemStops	array of OrderItemStop	Can be null.
attachments	array of Attachment	Can be null.
isActive	boolean
isBlindStop	boolean
isOnHold	boolean
confirmedWithoutAssignItems	boolean
blindCustomer	Customer
blindCustomerCustomerId	integer (int32)	Can be null.
blindCustomerName	string	Can be null.
blindCustomerNameForDriver	string	Can be null.
blindAddressAddressId	integer (int32)	Can be null.
blindAddress	Address
blindAddressFullAddress	string	Can be null.
routeItems	array of RouteItem	Can be null.
routeItemCharges	array of RouteItemCharge	Can be null.
sortOrder	integer (int32)
warehouseId	integer (int32)	Can be null.
notes	string	Can be null.
driverInstructions	string	Can be null.
departTime	string (date-time)	Can be null.
arrivalTime	string (date-time)	Can be null.
priority	string	Can be null. One of: Low, Regular, High.
newLocationName	string	Can be null.
overrideAddress	boolean	Can be null.
overwriteMainAddress	boolean	Can be null.
isNewLocationCompanyName	boolean	Can be null.
callOutcome	integer (int32)	One of: 1 (CallNotMade), 2 (Possible), 3 (NotPossible).
callOutcomeDate	string (date-time)	Can be null.
appointmentStatus	string	One of: Nothing, Request, Requested, Approve, Accepted, Review, NewAppointment.
appointmentCode	string	Can be null.
appointmentEmail	string	Can be null.
ratings	array of OrderStopRating	Can be null.
liftgateRequired	boolean
isHasFreightPayment	boolean	Read-only.
isHasOutstandingPayment	boolean	Read-only.
isAddContact	boolean	Can be null.
callOutcomeResult	integer (int32)	One of: 1 (CallNotMade), 2 (Possible), 3 (NotPossible).
orderStopRouteType	string	One of: First, Middle, Last.
jobSite	boolean

OrderStopActivityDto

Property	Type	Description
orderStopActivityId	integer (int32)
orderId	integer (int32)	Can be null.
isActive	boolean
type	string	One of: Unassigned, Assigned, Confirmed, OrderCreated, OrderUpdated, Order Completed, Quote Approved, Stop Updated, Order Assigned, Order Unassigned, Stop Assigned, Stop Unassigned, Route Copied, Stop Copied, Order Confirmed, Stop Confirmed, Order Undo, Stop Undo, Note Created, Note Updated, Reverted To Quote, Invoice Created, Invoice Created Automatically, Invoice Sent, BOL Sent, Payment Added, Related Order Created, Email Sent, Email Received, Price Updated, Hold Placed, Hold Resolved, Auto Charge Applied, Auto Charge Dismissed, Item Added, Item Removed, Item Increased, Item Decreased, Unsuccessful Stop, Postponed Stop.
typeOfInitiator	string	One of: Default, Driver.
date	string (date-time)
orderStopId	integer (int32)	Can be null.
orderStopType	string	Can be null. One of: Pickup, Delivery, Transfer.
transferStopId	integer (int32)	Can be null.
routeId	integer (int32)	Can be null.
driver	object
user	object
description	string	Can be null.
note	string	Can be null.
locationRating	integer (int32)	Can be null.
locationFeedbackText	string	Can be null.
oldPricingType	integer (int32)	Can be null. One of: 0 (Default), 1 (Pallets), 2 (Custom).
newPricingType	integer (int32)	Can be null. One of: 0 (Default), 1 (Pallets), 2 (Custom).
oldPrice	number (double)	Can be null.
newPrice	number (double)	Can be null.
oldInvoiceId	integer (int32)	Can be null.
newInvoiceId	integer (int32)	Can be null.

OrderStopBasicDetailsDto

Property	Type	Description
orderStopType	string	One of: Pickup, Delivery, Transfer.
address	Address
plannedDepartTime	string (date-time)	Can be null.
plannedArrivalTime	string (date-time)	Can be null.
actualDepartTime	string (date-time)	Can be null.
actualArrivalTime	string (date-time)	Can be null.
orderStopTripStatus	string	One of: Unassigned, Assigned, Dispatched, OnRoute, Completed.
orderTripStatus	string	Can be null. One of: Open, Assigned, InTransit, Delivered.
dateType	string	Can be null. One of: None, Today, Tomorrow, Custom.
timeType	string	Can be null. One of: None, Morning, Noon, Evening, Custom.
appointmentStatus	string	Appointment lifecycle status shown as a colored label in the Date & Time section. One of: Nothing, Request, Requested, Approve, Accepted, Review, NewAppointment.
appointmentCode	string	Can be null.
driverInstructions	string	Can be null. Free-text driver instructions for this stop (gate code, dock, "call on arrival").
isBlindStop	boolean
blindCustomerName	string	Can be null.
blindCustomerNameForDriver	string	Can be null.
blindAddressFullAddress	string	Can be null.
isOnHold	boolean

OrderStopDateAndTimeDto

Property	Type	Description
orderStopIds	array of integer (int32)	Required. List of order stop IDs to update.
dateType	string	Can be null. Type of date being applied. One of: None, Today, Tomorrow, Custom.
date	string (date-time)	Can be null. Specific date value to assign to the stop.
timeType	string	Can be null. Type of time being applied. One of: None, Morning, Noon, Evening, Custom.
time	string (date-time)	Can be null. Specific time value to assign to the stop.
dateTime	string (date-time)	Can be null. Combined date and time value to assign to the stop.
syncRouteItemDates	boolean

OrderStopDriverInstructionsDto

Property	Type	Description
driverInstructions	string	Can be null. Free-text instructions for the driver at this stop (gate code, dock number, "call on arrival").

OrderStopInfoDto

Property	Type	Description
orderStopId	integer (int32)
number	integer (int32)
freightQty	integer (int32)
status	string	One of: Unassigned, Assigned, Confirmed.
address	Address
date	string (date-time)	Can be null.
time	string (date-time)	Can be null.
dateTime	string (date-time)	Can be null.

OrderStopRating

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
orderStopRatingId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
orderStopId	integer (int32)
driverId	integer (int32)
rating	integer (int32)
orderId	integer (int32)	Can be null.
feedbackText	string	Can be null.

OrderStopWaitingTimeDto

Property	Type	Description
routeId	integer (int32)	Can be null. Route whose items of the stop should carry the waiting time, when the stop is split across routes.
arrivalDateTime	string (date-time)
departureDateTime	string (date-time)
waitingTime	string	Can be null.
freeWaitingTime	integer (int32)

OrderStopWarningDto

Property	Type	Description
orderStopId	integer (int32)
assignDelivery	boolean
assignPickup	boolean
assignTransfer	boolean
assignHub	boolean
confirmedWithoutAssignItems	boolean
allocateItems	boolean
allocatePickupItems	boolean
allocateDeliveryItems	boolean
createDelivery	boolean
stopWithoutRoute	boolean
routeItemStops	RouteItemStopGroup

OrderTag

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
id	integer (int32)
orderId	integer (int32)
tagId	integer (int32)
tag	Tag
order	Order
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object

OrderTrip

Property	Type	Description
orderTripId	integer (int32)
order	Order
orderItem	OrderItem
pickupOrderStop	OrderStop
deliveryOrderStop	OrderStop
quantity	integer (int32)
type	string	One of: OrderStop, Transfer.
deleted	boolean
qtyAssigned	integer (int32)
qtyInTransit	integer (int32)
qtyDelivered	integer (int32)
pickupRouteItem	RouteItem
dropOffRouteItem	RouteItem
driverId	integer (int32)	Can be null.
status	string	Read-only. One of: Open, Assigned, InTransit, Delivered.

OutsourceCompanyContactDetailsResponse

Property	Type	Description
companyEmails	array of CustomerEmail	Can be null.
companyContacts	array of CustomerContact	Can be null.

OutsourceCompanyCreateDto

Property	Type	Description
companyId	integer (int32)
ratings	integer (int32)
status	string	One of: Active, Inactive, Deleted.
startShift	string (date-time)
endShift	string (date-time)
outsourceCompanyName	string	Can be null.
localName	string	Can be null.
notes	string	Can be null.
phone	string	Can be null.
phoneCountryCode	string	Can be null. Up to 4 characters.
phoneCountryIso	string	Can be null. Up to 3 characters.
phoneExtension	string	Can be null.
logoUrl	string	Can be null.
driverRouteViewOverrideEnabled	boolean	Can be null.
driverRouteViewMode	string	Can be null. One of: Full, Restricted.
address	Address
driver	Driver
companyContact	CustomerContact
companyEmails	array of CustomerEmail	Can be null.
companyFinances	array of OutsourceCompanyFinance	Can be null.
companyTypeOfTrucks	array of OutsourceCompanyTypeOfTruck	Can be null.
firstEmail	string	Read-only. Can be null.

OutsourceCompanyDto

Property	Type	Description
id	integer (int32)
companyId	integer (int32)
ratings	integer (int32)
status	string	One of: Active, Inactive, Deleted.
startShift	string (date-time)
endShift	string (date-time)
outsourceCompanyName	string	Can be null.
localName	string	Can be null.
phone	string	Can be null.
phoneCountryCode	string	Can be null. Up to 4 characters.
phoneCountryIso	string	Can be null. Up to 3 characters.
phoneExtension	string	Can be null.
notes	string	Can be null.
logoUrl	string	Can be null.
driverRouteViewOverrideEnabled	boolean
driverRouteViewMode	string	One of: Full, Restricted.
drivers	array of Driver	Can be null.
addresses	array of Address	Can be null.
companyEmails	array of CustomerEmail	Can be null.
companyContacts	array of CustomerContact	Can be null.
companyFinances	array of OutsourceCompanyFinance	Can be null.
companyTypeOfTrucks	array of OutsourceCompanyTypeOfTruck	Can be null.
firstEmail	string	Read-only. Can be null.
mainAddress	Address

OutsourceCompanyFinance

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
outsourceCompanyFinanceId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
outsourceCompanyId	integer (int32)
discount	number (double)
costFixed	number (double)
costDistance	number (double)
costHourly	number (double)
costPallets	number (double)
freeWaitingTimeMinutes	integer (int32)
typeOfWork	integer (int32)	One of: 1 (Fixed), 2 (Distance), 4 (Hourly), 8 (Pallets). Values can be combined by adding them together.
discountType	integer (int32)	One of: 0 (Fixed), 1 (Percent).
isActive	boolean
notes	string	Can be null.
tenant	object
company	Company

OutsourceCompanyFinanceCreateDto

Property	Type	Description
outsourceCompanyId	integer (int32)
discount	number (double)
costFixed	number (double)
costDistance	number (double)
costHourly	number (double)
costPallets	number (double)
freeWaitingTimeMinutes	integer (int32)
typeOfWork	integer (int32)	One of: 1 (Fixed), 2 (Distance), 4 (Hourly), 8 (Pallets). Values can be combined by adding them together.
discountType	integer (int32)	One of: 0 (Fixed), 1 (Percent).
isActive	boolean
notes	string	Can be null.

OutsourceCompanyFinanceDto

Property	Type	Description
outsourceCompanyId	integer (int32)
discount	number (double)
costFixed	number (double)
costDistance	number (double)
costHourly	number (double)
costPallets	number (double)
freeWaitingTimeMinutes	integer (int32)
typeOfWork	integer (int32)	One of: 1 (Fixed), 2 (Distance), 4 (Hourly), 8 (Pallets). Values can be combined by adding them together.
discountType	integer (int32)	One of: 0 (Fixed), 1 (Percent).
isActive	boolean
notes	string	Can be null.
id	integer (int32)

OutsourceCompanyListDto

Property	Type	Description
id	integer (int32)
rating	integer (int32)
driversCount	integer (int32)
openBalance	number (double)
outsourceCompanyName	string	Can be null.
localName	string	Can be null.
logoUrl	string	Can be null.
firstName	string	Can be null.
lastName	string	Can be null.
phone	string	Can be null.
email	string	Can be null.
address	string	Can be null.
countryId	integer (int32)	Can be null.

OutsourceCompanyListDtoPagedList

A page of results. See Pagination and filtering.

Property	Type	Description
list	array of OutsourceCompanyListDto	Can be null.
page	integer (int32)
itemsPerPage	integer (int32)
totalCount	integer (int32)

OutsourceCompanyTypeOfTruck

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
outsourceCompanyTypeOfTruckId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
typeOfTruckId	integer (int32)
outsourceCompanyId	integer (int32)
park	integer (int32)
isActive	boolean
typeOfTruck	object
tenant	object
company	Company

OutsourceCompanyTypeOfTruckCreateDto

Property	Type	Description
typeOfTruckId	integer (int32)
outsourceCompanyId	integer (int32)
park	integer (int32)
isActive	boolean
typeOfTruck	object

OutsourceCompanyTypeOfTruckDto

Property	Type	Description
typeOfTruckId	integer (int32)
outsourceCompanyId	integer (int32)
park	integer (int32)
isActive	boolean
typeOfTruck	object
id	integer (int32)

OutsourceCompanyUpdateDto

Property	Type	Description
companyId	integer (int32)
ratings	integer (int32)
status	string	One of: Active, Inactive, Deleted.
startShift	string (date-time)
endShift	string (date-time)
outsourceCompanyName	string	Can be null.
localName	string	Can be null.
notes	string	Can be null.
phone	string	Can be null.
phoneCountryCode	string	Can be null. Up to 4 characters.
phoneCountryIso	string	Can be null. Up to 3 characters.
phoneExtension	string	Can be null.
logoUrl	string	Can be null.
driverRouteViewOverrideEnabled	boolean	Can be null.
driverRouteViewMode	string	Can be null. One of: Full, Restricted.
address	Address
driver	Driver
companyContact	CustomerContact
companyEmails	array of CustomerEmail	Can be null.
companyFinances	array of OutsourceCompanyFinance	Can be null.
companyTypeOfTrucks	array of OutsourceCompanyTypeOfTruck	Can be null.
firstEmail	string	Read-only. Can be null.
id	integer (int32)