Glossary

This glossary explains terms and acronyms used in Opendock. It helps you understand terminology used throughout the documentation and platform.

note

🤖 This document is designed to help feed LLMs (Large Language Models, conversational artificial intelligences) with context about the product and how data is structured within it. It is also useful to humans willing to learn more about the underlying engine of Opendock.

Industry Terms

Term	Description
Appointment	Scheduled time slot when a facility expects a carrier to pick up or deliver goods.
Carrier	Company that transports goods for other businesses.
Dock	Designated area where trucks load or unload goods at a facility.
Load Type	Classification of goods transported together.
Warehouse	Storage, processing, or manufacturing location (interchangeable with "Facility").
Yard Management System (YMS)	System for tracking and managing trucks and containers in a yard and its parking spots.

Opendock Features

Term	Description
2-Way-SMS	Communication system enabling facility operators and drivers to exchange messages via SMS.
Appointment Start Times	Configuration controlling when appointments can begin (hourly, quarter-hourly, custom intervals, etc.).
Appointment Validation	External middleware system that approves or rejects appointment creation/modification based on customer-defined rules.
Audit Log	Every action such as creating or modifying data is stored, along with the user that authored the change and the timestamp, for auditing purposes.
Availability	Time periods when new appointments can be created, based on dock schedules, existing appointments, and load type restrictions.
Carrier Contacts	Database of frequent carrier partners, with favoriting and custom notification options.
Carrier Lead Times	Minimum and maximum timeframes for scheduling appointments (e.g., minimum 3 hours before start time).
Carrier Scheduling	Self-service appointment booking by carriers through the Scheduling Portal.
Claims & Damages Support	Documentation system for recording damages with photos and descriptions within appointments.
Confirmation Number	Human-friendly number that identifies the appointment on Opendock, along with the appointment UUID and the Reference Number.
Custom Fields	Legacy system for adding customized data fields beyond standard options (deprecated).
Custom Forms	Enhanced replacement for Custom Fields, enabling tailored forms across Gate Management, scheduling, claims, and other areas.
Email Notifications	Automated messages sent when appointments are created, modified, or change status.
Email Subscribers	Recipients who receive email notifications for specific appointments.
Estimated Time of Arrival	Allows carriers or internal users to indicate when the driver is expected to arrive for the appointment.
Gate Management	Mobile check-in system allowing drivers to self-register upon arrival.
Geofencing	Location-based restriction preventing check-ins when drivers aren't physically near the facility.
Jockey Tasks	Task management system for yard operators to coordinate container movements.
Military Time	24-hour time format display option (vs. standard 12-hour format).
Overbooking	Feature allowing multiple appointments to share overlapping time slots at a single dock.
Parallel Capacity	Hierarchical dock structure with parent/child relationships for simultaneous appointment scheduling.
Power BI	Microsoft analytics platform powering Opendock's insights features.
Recurring Appointments	Appointments scheduled in advance for several repeated days at the same time, for example, weekly, monthly, etc. (consists of a recurring parent, the head of the chain, and multiple recurring children).
Reference Number	Customizable appointment identifier within a warehouse (can be required, unique, and renamed to match workflows).
Reserves	Similar to an appointment, but without a carrier or load type. Meant to be a hold for a given period of time, preventing the scheduling of overlapping appointments.
Schedule	Operating hours for warehouses, docks, and load types. Appointments require alignment of all three schedules. Also called "Hours of Operation" or "HOOPs".
Scheduling Portal	Web interface where carriers search, favorite, and book appointments with warehouses.
Single-Sign-On (SSO)	Authentication system integrating with external Identity Providers (IdP) like Azure or Okta using SAML 2.0.
TV Mode	Large format display of the appointment grid optimized for warehouse monitors.
Unit Limiter	Capacity control system setting daily, weekly, or monthly limits on weight, pallets, cartons, or other metrics.
Unplanned Arrivals	Allows carriers checking in to the facility without a pre-existing appointment. The warehouse personnel has the power to accept and link it to an appointment, or reject it.
User Roles	Defines the power level of a user within that Org, from "owner" (most powerful role) to "spectator" (least powerful role).
Warehouse Restricted Users	Opendock users are created for the entire Org, but they can be restricted to visualize and modify a subset of facilities within it.

Settings and Configurations

Opendock supports settings at multiple levels (Org, Warehouse, and Dock). Not all settings are available for all levels, and the most specific one is always taken into account. So, for example, when scheduling an appointment, its dock settings take precedence over the warehouse settings, which takes precedence over the Org settings. When a setting is absent at the most specific level, the least specific is used and, when it is absent on all levels, a default is used.

Below follows the list of settings and at which levels they are available:

Setting	Levels	Description	Example Value
referenceNumberIsVisible	Org, Warehouse	Controls whether the Reference Number field appears on appointment forms. When disabled, the field is hidden and related settings are ignored.	true
referenceNumberDisplayName	Org, Warehouse	Customizes the display name for Reference Number fields (e.g., "PO Number", "Shipment ID").	"PO Number"
referenceNumberHelperText	Org, Warehouse	Additional helper text shown below the Reference Number field to provide guidance to users.	"Please enter the PO number associated with this delivery"
referenceNumberIsRequired	Org, Warehouse	When enabled, requires a Reference Number to be provided for all appointments.	false
referenceNumberIsUnique	Org, Warehouse	When enabled, requires all Reference Numbers to be unique across active appointments, in that same warehouse. Does not consider cancelled and no-show appointments.	true
appointmentStartTimeMinutes	Org, Warehouse	Controls when appointments can start (hourly, half-hourly, quarter-hourly, or custom intervals).	30 (every half hour)
customAppointmentStartTimes	Org, Warehouse	Defines custom start times when appointmentStartTimeMinutes is set to "custom".	["08:00", "10:30", "13:00", "15:45"]
muteAppointmentNotifications	Org, Warehouse	Controls whether appointment notifications are sent. When true, enables notifications; when false, disables all notifications.	true (notifications enabled)
mutedAppointmentNotifications	Org, Warehouse	List of specific notification types that are muted at the entity level.	["appointment_inprogress", "appointment_tagged"]
customLogo	Org, Warehouse	Custom logo that appears in the Scheduling Portal and email notifications.	"https://files.opendock.com/company-logo.png"
yardMap	Warehouse	Upload of the warehouse yard map to display in the Scheduling Portal.	"https://files.opendock.com/warehouse-yard-map.png"
appointmentCreationStatus	Org, Warehouse	Default status for newly created appointments (Scheduled or Requested).	"Scheduled"
statusSucceedingArrived	Org, Warehouse	Defines which status follows after "Arrived" (can be "In Progress" or "Completed").	"InProgress"
enableMilitaryTime	Org, Warehouse	Controls time display format across the platform. When enabled, uses 24-hour format; otherwise uses 12-hour format.	false (12-hour format)
useNewGridTiles	Warehouse	Enables the customizable appointment details system in the appointment grid.	true
gridTileConfig	Warehouse	User configuration for appointment information displayed in grid tiles.	["refNumber", "carrier", "loadType"]
gateManagementRequiresGeofencing	Warehouse	When enabled, restricts driver check-ins to within geofenced area (approx. 1 mile) of the warehouse.	true
gateManagementAdditionalInformationText	Warehouse	Custom message shown to drivers after they check in through Gate Management.	"Please proceed to Door #7 and check in with security"
rescheduleByCarrierForbidden	Warehouse	When enabled, prevents carriers from rescheduling appointments in the Scheduling Portal.	false
checkInEarlyThreshold	Warehouse	Number of minutes before appointment start time when a carrier can check in.	120 (2 hours)
checkInLateThreshold	Warehouse	Number of minutes after appointment start time when a carrier can check in.	30
isLoadTypeDurationCarrierViewHidden	Warehouse	When enabled, hides the load type duration in the Scheduling Portal.	false
technicalContactEmailAddress	Warehouse	Email address for technical notifications related to appointment validation.	"tech-support@company.com"
externalValidationServerErrorNotifyThrottleMinutes	Warehouse	Minimum time (in minutes) between technical notification emails for validation server errors.	60
allowCarrierDockSelection	LoadType	When enabled, allows carriers to select docks when booking appointments in the Scheduling Portal.	false

Entities and Fields

Appointment (appointment)

Field	Type	Description
id	uuid	Unique identifier for the appointment
createDateTime	ISO-8601 timestamp	When the appointment was created
lastChangedDateTime	ISO-8601 timestamp	When the appointment was last modified
isActive	boolean	Whether the appointment is active
tags	array	Tags associated with the appointment
type	string	Either Standard or Reserve
status	string	Current status of the appointment, can be Requested, Scheduled, Arrived, InProgress, Completed, NoShow or Cancelled
start	ISO-8601 timestamp	Start time of the appointment
end	ISO-8601 timestamp	End time of the appointment
userId	uuid	The appointee (carrier) user for the appointment
loadTypeId	uuid	Load type for this appointment
dockId	uuid	Dock assigned to this appointment
refNumber	string	Reference number for the appointment
customFields	jsonb	Custom fields for additional information (see custom fields)
notes	string	User input notes for the appointment
orgId	uuid	Organization that owns the appointment
statusTimeline	jsonb	Key-value JSON of Status-Timestamp representing when each status was achieved (e.g. {"Scheduled": "2023-11-15T14:30:00.000Z", "Arrived": "2023-11-15T15:45:00.000Z", "Completed": null })
ccEmails	array	Additional emails to copy on notifications
createdBy	uuid	User who created the appointment
lastChangedBy	uuid	User who last modified the appointment
recurringParentId	uuid	Parent ID for recurring appointments, if the appointment is a recurring child
recurringPattern	jsonb	Pattern for recurring appointments, if the appointment is a recurring child (e.g. {"numWeeks": 105, "weekDays": ["Wednesday", "Tuesday"]})
reschedules	jsonb	History of reschedules, as a list of JSON objects containing by (author), from (original start time), to (new start time) and timestamp (when the action occurred) (e.g. {"by": "6b356be9-0bba-445a-8fa0-5d94a24fd956", "to": "2023-10-20T19:30:00.000Z", "from": "2023-10-20T12:00:00.000Z", "timestamp": "2023-10-19T17:13:39.465Z"})
eta	ISO-8601 timestamp	Current estimated time of arrival
confirmationNumber	bigint	Confirmation number for the appointment
muteNotifications	boolean	Whether notifications are muted

Asset Container (assetcontainer)

Field	Type	Description
id	uuid	Unique identifier for the container
createDateTime	ISO-8601 timestamp	When the container was created
createdBy	uuid	User who created the container
lastChangedDateTime	ISO-8601 timestamp	When the container was last modified
lastChangedBy	uuid	User who last modified the container
isActive	boolean	Whether the container is active
type	string	Type of container, can be Container, Trailer, Oversized, or Other
code	string	Container identification code
assetVisitId	uuid	Associated visit ID
orgId	uuid	Organization that owns the container
warehouseId	uuid	Warehouse where the container is located
pickupAppointmentId	uuid	Appointment for container pickup
dropAppointmentId	uuid	Appointment for container drop-off
notes	text	Additional notes about the container

Asset Container Event (assetcontainerevent)

Field	Type	Description
id	uuid	Unique identifier for the event
orgId	uuid	Organization that owns the event
createDateTime	ISO-8601 timestamp	When the event was created
createdBy	uuid	User who created the event
assetContainerId	uuid	Container this event relates to
eventType	string	Type of event that occurred, can be Arrived, Loading, Loading Complete, Unloading, Unloading Complete, Ready for Pickup, Inoperable or Departed

Asset Observation (assetobservation)

Field	Type	Description
id	uuid	Unique identifier for the observation
createDateTime	ISO-8601 timestamp	When the observation was created
createdBy	uuid	User who created the observation
lastChangedDateTime	ISO-8601 timestamp	When the observation was last modified
lastChangedBy	uuid	User who last modified the observation
isActive	boolean	Whether the observation is active
vehicleObservationId	uuid	Vehicle observation on the NavTrac system
direction	string	Direction of asset, can be Inbound or Outbound
images	array	List of image URLs of the asset
licensePlate	string	License plate of the vehicle
dotNumber	string	DOT number of the vehicle
damage	boolean	Whether damage was observed
detectedAt	ISO-8601 timestamp	When the asset was detected
hasSeal	boolean	Whether the container has a seal
assetType	string	Type of asset observed, can be Container, ContainerReefer, DryVan, DryVanReefer or Flatbed
orgId	uuid	Organization that owns the observation
number	string	Container or asset number

Asset Visit (assetvisit)

Field	Type	Description
id	uuid	Unique identifier for the visit
createDateTime	ISO-8601 timestamp	When the visit was created
createdBy	uuid	User who created the visit
lastChangedDateTime	ISO-8601 timestamp	When the visit was last modified
lastChangedBy	uuid	User who last modified the visit
isActive	boolean	Whether the visit is active
orgId	uuid	Organization that owns the visit
warehouseId	uuid	Warehouse being visited
appointmentId	uuid	Related appointment, if any
companyId	uuid	Carrier company making the visit
phone	string	Contact phone number, which will be used for 2-Way-SMS communication
isPlanned	boolean	Whether the visit was planned
companyHint	string	Hint to identify the company
checkInAcknowledged	boolean	Whether check-in was acknowledged
visitType	string	Type of visit, can be Live, Drop, PickUp, DropHook, or Unknown
driverNotes	string	Notes provided by the driver
driverAppointmentIdentifier	string	Appointment ID provided by driver
licensePlate	string	License plate of the vehicle
dotNumber	string	DOT number of the vehicle

Asset Visit Event (assetvisitevent)

Field	Type	Description
id	uuid	Unique identifier for the event
createDateTime	ISO-8601 timestamp	When the event was created
createdBy	uuid	User who created the event
assetVisitId	uuid	Visit this event relates to
eventType	string	Type of event that occurred, can be Arrived, NotArrived, Docked, Attached, Detached, Departed, or Canceled
lastChangedDateTime	ISO-8601 timestamp	When the event was last modified
orgId	uuid	Organization that owns the event
assetContainerId	uuid	Related container

Audit Log (audit_log)

Field	Type	Description
id	integer	Unique identifier for the log entry
tableName	text	Name of the table being audited
objectId	uuid	ID of the object being audited
changedBy	uuid	User who made the change
actionTimestamp	ISO-8601 timestamp	When the action occurred
action	string	Type of action performed, can be INSERT, UPDATE, or DELETE
changedFields	jsonb	JSON object with the shape of the fields being inserted or modified
orgId	uuid	Organization the change occurred in

Carrier Settings (carriersettings)

Field	Type	Description
id	uuid	Unique identifier for the settings
createDateTime	ISO-8601 timestamp	When the settings were created
createdBy	uuid	User who created the settings
lastChangedDateTime	ISO-8601 timestamp	When the settings were last modified
lastChangedBy	uuid	User who last modified the settings
userId	uuid	Carrier User these settings belong to
favoriteWarehouseIds	array	IDs of favorite warehouses

Company (company)

Field	Type	Description
id	uuid	Unique identifier for the company
createDateTime	ISO-8601 timestamp	When the company was created
lastChangedDateTime	ISO-8601 timestamp	When the company was last modified
isActive	boolean	Whether the company is active
name	string	Name of the company
scac	string	Standard Carrier Alpha Code
mc	string	Motor Carrier number
usdot	string	US Department of Transportation number
createdBy	uuid	User who created the company
lastChangedBy	uuid	User who last modified the company
type	string	Currently only type_carrier, companies can only be carrier companies

Dock (dock)

Field	Type	Description
id	uuid	Unique identifier for the dock
createDateTime	ISO-8601 timestamp	When the dock was created
lastChangedDateTime	ISO-8601 timestamp	When the dock was last modified
isActive	boolean	Whether the dock is active
name	string	Name of the dock
warehouseId	uuid	Warehouse this dock belongs to
loadTypeIds	array	Array of UUIDs, containing the load types accepted in this dock
orgId	uuid	Organization that owns the dock
schedule	jsonb	Weekly operating schedule for the dock; each day can have multiple intervals of operation (e.g. {"friday": [{"end": "21:00", "start": "9:00"}], "monday": [{"end": "12:00", "start": "9:00"}, {"end": "21:00", "start": "13:00"}], "sunday": [], "tuesday": [{"end": "21:00", "start": "9:00"}], "thursday": [{"end": "21:00", "start": "9:00"}],"wednesday": [{"end": "21:00", "start": "9:00"}]})
createdBy	uuid	User who created the dock
lastChangedBy	uuid	User who last modified the dock
doorNumber	string	Door number for the dock
instructions	string	Special instructions for using the dock
minCarrierLeadTime_hr	smallint	How many hours in advance are required when a carrier is scheduling an appointment
ccEmails	array	Additional emails to copy on notifications when scheduling on this dock
maxCarrierLeadTime_hr	smallint	How many hours in advance are forbidden when a carrier is scheduling an appointment
allowCarrierScheduling	boolean	Whether carriers can schedule appointments
allowOverBooking	boolean	Whether overbooking is allowed
capacityParentId	uuid	Parent dock, if this dock is a capacity child
sortOrder	integer	Order for display in lists and grid
settings	jsonb	Additional dock settings (see the settings definition above); keys that are absent will default to the Warehouse settings, and then to the Org settings respectively
minCarrierLeadTimeForUpdates_hr	smallint	Same as minCarrierLeadTime_hr but for updates

Load Type (loadtype)

Field	Type	Description
id	uuid	Unique identifier for the load type
createDateTime	ISO-8601 timestamp	When the load type was created
lastChangedDateTime	ISO-8601 timestamp	When the load type was last modified
isActive	boolean	Whether the load type is active
name	string	Name of the load type
duration_min	integer	Default duration in minutes for this load type, used when scheduling appointments
createdBy	uuid	User who created the load type
lastChangedBy	uuid	User who last modified the load type
orgId	uuid	Organization that owns the load type
direction	string	Direction, can be Inbound or Outbound
allowCarrierScheduling	boolean	Whether carriers can schedule this load type
description	string	Description of the load type
warehouseId	uuid	Warehouse this load type belongs to; this is optional, as load types can either be Org-bound or Warehouse-bound
settings	jsonb	Additional load type settings (e.g. {"allowCarrierDockSelection": false})
operation	string	Operation performed for this load type, can be Drop, Live, or Other
equipmentType	string	Type of equipment needed, can be Dry Van, Reefer, Flatbed, or Other
transportationMode	string	Mode of transportation, can be FTL, PTL, or Other
schedule	jsonb	Operating schedule for this load type; each day can have multiple intervals of operation (e.g. {"friday": [{"end": "21:00", "start": "9:00"}], "monday": [{"end": "12:00", "start": "9:00"}, {"end": "21:00", "start": "13:00"}], "sunday": [], "tuesday": [{"end": "21:00", "start": "9:00"}], "thursday": [{"end": "21:00", "start": "9:00"}],"wednesday": [{"end": "21:00", "start": "9:00"}]})

Organization (org)

Field	Type	Description
id	uuid	Unique identifier for the organization
createDateTime	ISO-8601 timestamp	When the organization was created
lastChangedDateTime	ISO-8601 timestamp	When the organization was last modified
isActive	boolean	Whether the organization is active
tags	array	Tags associated with the organization
name	string	Name of the organization
createdBy	uuid	User who created the organization
lastChangedBy	uuid	User who last modified the organization
settings	jsonb	Organization settings (see the settings definition above);
reportSearches	jsonb	Saved report searches (e.g. {"weekly-report": {"title": "Weekly Report", "filters": {"dockIds": ["b6b378d3-9e0c-49df-bf52-c9234a40a02a", "ec791f2e-959c-40c5-9d76-6b676c499fd1", "..."], "loadTypeIds": ["2aa96651-d156-4929-a638-9ec478b56fcf", "48c63f21-d8d1-48b0-b7b9-164f96be581b", "..."], "statuses": ["Scheduled", "Completed"], "definedRange": "wtd", "exportFields": ["APPOINTMENT_DATE", "STATUS", "..."]}, "createdAt": "2023-08-14T10:12:45.766Z"}, "..."})
customTags	jsonb	Custom tags for the organization, that can be reused when creating appointments (e.g. [{"name": "Urgent Load", "color": "#D95914", "textColor": "#FFFFFF"}, {"name": "BIOHAZARD ☣️", "color": "#FFCDD2", "textColor": "#1E3036"}, "..."])
expiresAt	ISO-8601 timestamp	When the organization subscription expires
samlConfig	jsonb	SAML configuration for SSO , when using so (e.g. {"enabled": true, "idpMetadataUrl": "www.test.com", "forbidPasswordLogins": false})
orgType	string	Type of organization (Client, Test or Trial)

User (user)

Field	Type	Description
id	uuid	Unique identifier for the user
createDateTime	ISO-8601 timestamp	When the user was created
lastChangedDateTime	ISO-8601 timestamp	When the user was last modified
isActive	boolean	Whether the user is active
email	string	Email address of the user
password	string	Hashed password
firstName	string	First name of the user
lastName	string	Last name of the user
isEmailVerified	boolean	Whether the email is verified
role	string	Role of the user in the system; role_base, for an user that was not yet completely activated or assigned to any Org or Carrier Company, role_carrier for users associated to Carrier Companies, role_owner, role_admin, role_operator, role_attendant, role_spectator for the Org (Warehouse) users, and role_internal for the Opendock support team
orgId	uuid	Organization the user belongs to, if the user is an internal warehouse user
companyId	uuid	Company the user belongs to, if the user belongs to a carrier company
phone	string	Phone number of the user
createdBy	uuid	User who invited this user
lastChangedBy	uuid	User who last modified this user
invalidLoginAttempts	integer	Number of failed login attempts
warehouseAccessList	array	Warehouses this user can access, if the user is an internal warehouse user and is restricted
extension	string	Phone extension
tcConfirmedAt	ISO-8601 timestamp	When terms were accepted
lastLoginAt	timestamp without time zone	When the user last logged in
passwordResetRequired	boolean	Whether password reset is required
passwordResetEmailSentAt	ISO-8601 timestamp	When password reset email was sent

Warehouse (warehouse)

Field	Type	Description
id	uuid	Unique identifier for the warehouse
createDateTime	ISO-8601 timestamp	When the warehouse was created
lastChangedDateTime	ISO-8601 timestamp	When the warehouse was last modified
isActive	boolean	Whether the warehouse is active
name	string	Name of the warehouse
phone	string	Contact phone number
email	string	Contact email address
notes	string	Additional notes to carriers
instructions	string	Special instructions
street	string	Street address
city	string	City
state	string	State/province
zip	string	ZIP/postal code
customApptFieldsTemplate	jsonb	Template for custom appointment fields; The template is stamped to each appointment upon creation, and remains the same upon its lifecycle; Read more about custom fields.
orgId	uuid	Organization that owns the warehouse
schedule	jsonb	Weekly operating schedule for the warehouse; each day can have multiple intervals of operation (e.g. {"friday": [{"end": "21:00", "start": "9:00"}], "monday": [{"end": "12:00", "start": "9:00"}, {"end": "21:00", "start": "13:00"}], "sunday": [], "tuesday": [{"end": "21:00", "start": "9:00"}], "thursday": [{"end": "21:00", "start": "9:00"}],"wednesday": [{"end": "21:00", "start": "9:00"}]})
timezone	string	Timezone of the warehouse, using IANA names (e.g. America/Phoenix, Europe/Berlin, etc.)
contactName	string	Name of the primary contact within the facility
createdBy	uuid	User who created the warehouse
lastChangedBy	uuid	User who last modified the warehouse
facilityNumber	string	Facility identification number
refNumberValidationUrl	string	URL for appointment validation middleware
settings	jsonb	Additional warehouse settings (see settings above in this document)
allowCarrierScheduling	boolean	Whether carriers can book appointments using the Scheduling Portal
geolocation	jsonb	Geographic coordinates (e.g. {"latitude": 40.7128, "longitude": -74.0060}), used primarily for Gate Management (Self Check-in) geofencing
country	string	Country code using ISO 3166-1 alpha-3 standard (e.g. USA, CAN, MEX)
ccEmails	array	Additional emails to copy on notifications
refNumberValidationPasscode	string	Optional passcode for reference number validation
refNumberValidationVersion	string	Version of reference number validation (V1 for spreadsheet-based or V2 for webhook-based)
amenities	array	Amenities available at the warehouse, can be a list of Lumper services, Drivers restroom, Overnight parking, and Free Wi-Fi
ppeRequirements	array	Personal protective equipment requirements, can be a list of Face Mask, Safety Glasses, Hard Hat, Safety Boots, Gloves, High Visibility Vest, Long Pants, Long Sleeves, and No Smoking
intervalTrimForCarriers	smallint	Interval trimming for carrier schedules
customBookingUrl	string	Custom URL for booking appointment, when not using the default Scheduling Portal

Message Thread (messagethread)

Field	Type	Description
id	uuid	Unique identifier for the thread
createDateTime	ISO-8601 timestamp	When the thread was created
createdBy	uuid	User who created the thread
lastChangedDateTime	ISO-8601 timestamp	When the thread was last modified
lastChangedBy	uuid	User who last modified the thread
isActive	boolean	Whether the thread is active
orgId	uuid	Organization that owns the thread
assetVisitId	uuid	Related asset visit
expiresAt	ISO-8601 timestamp	When the thread expires
isOpen	boolean	Whether the thread is currently open
lastReadMessageId	uuid	ID of the last read message
isDriverSubscribed	boolean	Whether the driver is subscribed
unreadMessagesCount	integer	Number of messages the warehouse hasn't yet read

Message Thread Message (messagethreadmessage)

Field	Type	Description
id	uuid	Unique identifier for the message
createDateTime	ISO-8601 timestamp	When the message was created
createdBy	uuid	User who created the message
lastChangedDateTime	ISO-8601 timestamp	When the message was last modified
lastChangedBy	uuid	User who last modified the message
isActive	boolean	Whether the message is active
providerMessageId	string	ID from the third party message provider
orgId	uuid	Organization that owns the message
messageThreadId	uuid	Thread this message belongs to
content	string	Content of the message
toNumber	string	Recipient phone number
fromNumber	string	Sender phone number
status	string	Status of the message, can be sent, failed, delivered, or received
sourceType	string	Source of the message, can be driver, warehouse, or system
files	jsonb	Files attached to the message (e.g. [{"url": "https://files.opendock.com/messages/abc123/document.pdf", "name": "delivery-receipt.pdf", "size": 245760, "mimeType": "application/pdf"}])

Unit Limit (unitlimit)

Field	Type	Description
id	uuid	Unique identifier for the limit
createDateTime	ISO-8601 timestamp	When the limit was created
createdBy	uuid	User who created the limit
lastChangedDateTime	ISO-8601 timestamp	When the limit was last modified
lastChangedBy	uuid	User who last modified the limit
isActive	boolean	Whether the limit is active
unitGrouperType	string	Type of unit grouper (can be Dock, LoadType, or Warehouse)
unitGrouperId	uuid	ID of the unit grouper entity
orgId	uuid	Organization that owns the limit
warehouseId	uuid	Warehouse this limit applies to
mondayLimit	integer	Limit for Monday
tuesdayLimit	integer	Limit for Tuesday
wednesdayLimit	integer	Limit for Wednesday
thursdayLimit	integer	Limit for Thursday
fridayLimit	integer	Limit for Friday
saturdayLimit	integer	Limit for Saturday
sundayLimit	integer	Limit for Sunday
dailyLimit	integer	Daily limit
weeklyLimit	integer	Weekly limit
monthlyLimit	integer	Monthly limit
unitType	string	Type of unit being limited (only Appointment is currently supported)
januaryLimit	integer	Limit for January
februaryLimit	integer	Limit for February
marchLimit	integer	Limit for March
aprilLimit	integer	Limit for April
mayLimit	integer	Limit for May
juneLimit	integer	Limit for June
julyLimit	integer	Limit for July
augustLimit	integer	Limit for August
septemberLimit	integer	Limit for September
octoberLimit	integer	Limit for October
novemberLimit	integer	Limit for November
decemberLimit	integer	Limit for December

Form (form)

Field	Type	Description
id	uuid	Unique identifier for the form
createDateTime	ISO-8601 timestamp	When the form was created
createdBy	uuid	User who created the form
lastChangedDateTime	ISO-8601 timestamp	When the form was last modified
lastChangedBy	uuid	User who last modified the form
isActive	boolean	Whether the form is active
orgId	uuid	Organization that owns the form
warehouseId	uuid	Warehouse this form belongs to
name	string	Name of the form (see custom fields)
description	string	Description of the form

Form Field (formfield)

Field	Type	Description
id	uuid	Unique identifier for the form field
createDateTime	ISO-8601 timestamp	When the field was created
createdBy	uuid	User who created the field
lastChangedDateTime	ISO-8601 timestamp	When the field was last modified
lastChangedBy	uuid	User who last modified the field
isActive	boolean	Whether the field is active
orgId	uuid	Organization that owns the field
order	integer	Display order of the field
required	boolean	Whether the field is required
overrideLabel	string	Custom label for the field
formId	uuid	Form this field belongs to
fieldId	uuid	Field definition

Field (field)

Field	Type	Description
id	uuid	Unique identifier for the field
createDateTime	ISO-8601 timestamp	When the field was created
createdBy	uuid	User who created the field
lastChangedDateTime	ISO-8601 timestamp	When the field was last modified
lastChangedBy	uuid	User who last modified the field
isActive	boolean	Whether the field is active
tags	array	Tags associated with the field
orgId	uuid	Organization that owns the field
label	string	Label of the field
description	string	Description of the field
placeholder	string	Placeholder text
type	USER-DEFINED	Type of field (can be str, bigstr, date, bool, doc, multidoc, int, email, phone, dropdown, dropdownmultiselect, combobox, timestamp, or action)
extraFields	jsonb	Additional field settings (e.g. {"dropDownValues": ["Alabama", "Alaska", "Arizona", "Arkansas", "..."]} or {"maxLengthOrValue": 9, "minLengthOrValue": 3})

Custom Form Data (customformdata)

Field	Type	Description
id	uuid	Unique identifier for the form data
createDateTime	ISO-8601 timestamp	When the data was created
createdBy	uuid	User who created the data
lastChangedDateTime	ISO-8601 timestamp	When the data was last modified
lastChangedBy	uuid	User who last modified the data
isActive	boolean	Whether the data is active
orgId	uuid	Organization that owns the data
objectId	uuid	Object this data is for
entityName	string	Type of entity this data is for (can be appointment, assetvisit, or assetcontainer)
label	string	Label for the data
value	string	Value of the data
type	string	Type of data (can be str, bigstr, date, bool, doc, multidoc, int, email, phone, dropdown, dropdownmultiselect, combobox, timestamp, or action)
formFieldId	uuid	Form field this data is for
triggerId	uuid	Trigger that created this data
warehouseId	uuid	Warehouse this data belongs to

Flow (flow)

Field	Type	Description
id	uuid	Unique identifier for the flow
createDateTime	ISO-8601 timestamp	When the flow was created
createdBy	uuid	User who created the flow
lastChangedDateTime	ISO-8601 timestamp	When the flow was last modified
lastChangedBy	uuid	User who last modified the flow
isActive	boolean	Whether the flow is active
orgId	uuid	Organization that owns the flow
warehouseId	uuid	Warehouse this flow belongs to
name	string	Name of the flow
description	string	Description of the flow
entityTags	array	Entity tags for the flow
formFromId	uuid	Source form for the flow
formToId	uuid	Target form for the flow
conditionOperator	string	Operator used for flow conditions (e.g. =)
conditionValue	string	Value used for flow conditions
conditionFormFieldId	uuid	Form field used for flow conditions
tagFromFormFieldId	uuid	Form field used for tagging in the flow
parentCode	uuid	Parent code for hierarchical flows

Gate (gate)

Field	Type	Description
id	uuid	Unique identifier for the gate
createDateTime	ISO-8601 timestamp	When the gate was created
createdBy	uuid	User who created the gate
lastChangedDateTime	ISO-8601 timestamp	When the gate was last modified
lastChangedBy	uuid	User who last modified the gate
isActive	boolean	Whether the gate is active
name	string	Name of the gate
siteId	uuid	Site this gate belongs to
orgId	uuid	Organization that owns the gate

Load Type Group (loadtypegroup)

Field	Type	Description
id	uuid	Unique identifier for the load type group
createDateTime	ISO-8601 timestamp	When the load type group was created
createdBy	uuid	User who created the load type group
lastChangedDateTime	ISO-8601 timestamp	When the load type group was last modified
lastChangedBy	uuid	User who last modified the load type group
isActive	boolean	Whether the load type group is active
name	string	Name of the load type group
orgId	uuid	Organization that owns the load type group
warehouseId	uuid	Warehouse this load type group belongs to

Message Thread Event (messagethreadevent)

Field	Type	Description
id	uuid	Unique identifier for the message thread event
createDateTime	ISO-8601 timestamp	When the event was created
createdBy	uuid	User who created the event
lastChangedDateTime	ISO-8601 timestamp	When the event was last modified
lastChangedBy	uuid	User who last modified the event
isActive	boolean	Whether the event is active
orgId	uuid	Organization that owns the event
messageThreadId	uuid	Message thread this event belongs to
content	string	Content of the event (e.g. Chat ended by the warehouse, Driver's phone changed to +1 480 888 9999, Chat at My Storage Facility ended due to another check-in)

Notification Config (notificationconfig)

Field	Type	Description
id	uuid	Unique identifier for the notification configuration
createDateTime	ISO-8601 timestamp	When the configuration was created
createdBy	uuid	User who created the configuration
lastChangedDateTime	ISO-8601 timestamp	When the configuration was last modified
lastChangedBy	uuid	User who last modified the configuration
isActive	boolean	Whether the configuration is active
orgId	uuid	Organization that owns the configuration
notificationType	text	Type of notification, can be appointment_requested, appointment_requested_confirmed, appointment_confirmed, appointment_rescheduled, appointment_updated, appointment_tagged, appointment_recurring_series_scheduled, appointment_cancelled, appointment_arrived, appointment_inprogress, appointment_completed, or appointment_noshow
contentBlocks	jsonb	Content blocks for the notification template (e.g. [{"content": "<p>Reach out to our staff upon arrival</p>", "blockKey": "appointment_paragraph_one", "isActive": true, "styleType": "alert"}])
settings	jsonb	Additional settings for the notification (e.g. {"appointmentIdType": "confirmation_number", "displayableAppointmentFields": ["confirmation_number", "load_type_description", "reference_number", "appointment_custom_fields", "carrier_contact", "notes", "dock_instructions", "warehouse_instructions", "appointment_id"]})
warehouseId	uuid	Warehouse this configuration belongs to

Org Carrier Settings (orgcarriersettings)

Field	Type	Description
id	uuid	Unique identifier for the org carrier settings
createDateTime	ISO-8601 timestamp	When the settings were created
createdBy	uuid	User who created the settings
lastChangedDateTime	ISO-8601 timestamp	When the settings were last modified
lastChangedBy	uuid	User who last modified the settings
isActive	boolean	Whether the settings are active
orgId	uuid	Organization that owns the settings
userId	uuid	User these settings apply to
emailCCs	array	Email addresses to CC on notifications
favoriteWarehouseIds	array	IDs of warehouses this carrier is a favorite of

Schedule History (schedulehistory)

Field	Type	Description
id	uuid	Unique identifier for the schedule history entry, which pertains to a specific dock IN OVERLAP with its parent warehouse
orgId	uuid	Organization that owns this history entry
dockId	uuid	Dock this schedule history belongs to
start	date	Start date of the schedule period
end	date	End date of the schedule period
schedule	jsonb	Historical schedule data (e.g. {"friday": [{"end": "21:00", "start": "9:00"}], "monday": [{"end": "12:00", "start": "9:00"}, {"end": "21:00", "start": "13:00"}], "sunday": [], "tuesday": [{"end": "21:00", "start": "9:00"}], "thursday": [{"end": "21:00", "start": "9:00"}],"wednesday": [{"end": "21:00", "start": "9:00"}]})

Site (site)

Field	Type	Description
id	uuid	Unique identifier for the physical site
createDateTime	ISO-8601 timestamp	When the physical site was created
createdBy	uuid	User who created the physical site
lastChangedDateTime	ISO-8601 timestamp	When the physical site was last modified
lastChangedBy	uuid	User who last modified the physical site
isActive	boolean	Whether the physical site is active
name	string	Name of the physical site
warehouseId	uuid	Warehouse this physical site belongs to
orgId	uuid	Organization that owns the physical site

Spot (spot)

Field	Type	Description
id	uuid	Unique identifier for the spot
createDateTime	ISO-8601 timestamp	When the spot was created
createdBy	uuid	User who created the spot
lastChangedDateTime	ISO-8601 timestamp	When the spot was last modified
lastChangedBy	uuid	User who last modified the spot
isActive	boolean	Whether the spot is active
orgId	uuid	Organization that owns the spot
warehouseId	uuid	Warehouse this spot belongs to
code	string	Code identifier for the spot
type	string	Type of spot (docking or parking)
spotAreaId	uuid	Spot area this spot belongs to
observation	string	Observations about the spot

Spot Area (spotarea)

Field	Type	Description
id	uuid	Unique identifier for the spot area
createDateTime	ISO-8601 timestamp	When the spot area was created
createdBy	uuid	User who created the spot area
lastChangedDateTime	ISO-8601 timestamp	When the spot area was last modified
lastChangedBy	uuid	User who last modified the spot area
isActive	boolean	Whether the spot area is active
orgId	uuid	Organization that owns the spot area
warehouseId	uuid	Warehouse this spot area belongs to
name	string	Name of the spot area

Spot Assignment (spotassignment)

Field	Type	Description
id	uuid	Unique identifier for the spot assignment
createDateTime	ISO-8601 timestamp	When the assignment was created
createdBy	uuid	User who created the assignment
lastChangedDateTime	ISO-8601 timestamp	When the assignment was last modified
lastChangedBy	uuid	User who last modified the assignment
isActive	boolean	Whether the assignment is active
orgId	uuid	Organization that owns the assignment
warehouseId	uuid	Warehouse this assignment belongs to
spotId	uuid	Spot being assigned
assetVisitId	uuid	Asset visit being assigned to the spot
observation	string	Observations about the assignment
assetContainerId	uuid	Asset container being assigned to the spot

Spot Event (spotevent)

Field	Type	Description
id	uuid	Unique identifier for the spot event
createDateTime	ISO-8601 timestamp	When the event was created
createdBy	uuid	User who created the event
lastChangedDateTime	ISO-8601 timestamp	When the event was last modified
lastChangedBy	uuid	User who last modified the event
isActive	boolean	Whether the event is active
orgId	uuid	Organization that owns the event
warehouseId	uuid	Warehouse this event belongs to
spotId	uuid	Spot this event relates to
eventType	string	Type of event that occurred (open, close, assignment, release)
reason	string	Reason for the event
observation	string	Observations about the event

Trigger (trigger)

Field	Type	Description
id	uuid	Unique identifier for the trigger
createDateTime	ISO-8601 timestamp	When the trigger was created
createdBy	uuid	User who created the trigger
lastChangedDateTime	ISO-8601 timestamp	When the trigger was last modified
lastChangedBy	uuid	User who last modified the trigger
isActive	boolean	Whether the trigger is active
orgId	uuid	Organization that owns the trigger
app	string	Application the trigger belongs to (carrier, driver, warehouse, all)
category	string	Category of the trigger (appointmentCreated, appointmentStatusArrived, assetVisitCreated, appointmentStatusCompleted, or manualTrigger)
flowId	uuid	Flow this trigger is associated with
objectId	uuid	Object this trigger applies to
entityName	string	Name of the entity the trigger applies to (loadtype or warehouse)
feature	string	Feature the trigger is for (Book Load Type, Inbound Claim, Outbound Claim, asset container details, check-in, check-in additional asset details, or check-out)
dataEntityName	string	Name of the data entity for the trigger (appointment, assetvisit, or assetcontainer)

Unit Limit Count (unitlimitcount)

Field	Type	Description
id	uuid	Unique identifier for the unit limit count
createDateTime	ISO-8601 timestamp	When the count was created
createdBy	uuid	User who created the count
lastChangedDateTime	ISO-8601 timestamp	When the count was last modified
lastChangedBy	uuid	User who last modified the count
isActive	boolean	Whether the count is active
unitLimitId	uuid	Unit limit this count belongs to
countedDate	date	Date for which this count applies
dailyLimitSnapshot	integer	Snapshot of the daily limit at time of counting
unitCount	integer	Actual count of units for the date

Vehicle Observation (vehicleobservation)

Field	Type	Description
id	uuid	Unique identifier for the vehicle observation
createDateTime	ISO-8601 timestamp	When the observation was created
createdBy	uuid	User who created the observation
lastChangedDateTime	ISO-8601 timestamp	When the observation was last modified
lastChangedBy	uuid	User who last modified the observation
isActive	boolean	Whether the observation is active
gateId	uuid	Gate where the observation occurred
direction	string	Direction of vehicle movement (Inbound or Outbound)
images	array	Images captured during the observation
licensePlate	string	License plate of the observed vehicle
dotNumber	string	DOT number of the vehicle
damage	boolean	Whether damage was observed on the vehicle
fuelType	string	Type of fuel the vehicle uses (Diesel, Electric, FuelCell, Gasoline, NaturalGas, Propane, or Unavailable)
vehicleClass	string	Classification of the vehicle (<2b, 2b-7, or 8)
detectedAt	ISO-8601 timestamp	When the vehicle was detected
orgId	uuid	Organization that owns the observation
assetVisitId	uuid	Associated asset visit
number	string	Vehicle number
carrierName	string	Name of the carrier company

Warehouse Feature (warehousefeature)

Field	Type	Description
warehouseId	uuid	Warehouse this feature belongs to
featureCode	string	Code identifying the feature (yms, navtrac, or gm)
createDateTime	ISO-8601 timestamp	When the feature was created
createdBy	uuid	User who created the feature
lastChangedDateTime	ISO-8601 timestamp	When the feature was last modified
lastChangedBy	uuid	User who last modified the feature

Warehouse Group (warehousegroup)

Field	Type	Description
id	uuid	Unique identifier for the warehouse group
createDateTime	ISO-8601 timestamp	When the group was created
createdBy	uuid	User who created the group
lastChangedDateTime	ISO-8601 timestamp	When the group was last modified
lastChangedBy	uuid	User who last modified the group
isActive	boolean	Whether the group is active
tags	array	Tags associated with the group
name	string	Name of the warehouse group
orgId	uuid	Organization that owns the group