Yard Operations
Yard Operations in Opendock enables facilities to manage the physical movement and positioning of assets within the yard. After carriers complete the check-in process through Gate Operations, the yard management system tracks assets as they move through parking areas, dock assignments, and ultimately departure — providing real-time visibility into your facility's yard activities.
Understanding Yard Management
Yard Management builds directly upon Gate Operations and tracks the continued lifecycle of Asset Visits after initial check-in. While Gate Operations handles arrival and basic information capture, Yard Operations focuses on the physical management of assets within your facility.
Before working with Yard Operations, ensure you're familiar with Gate Operations, as the Asset Visit created during check-in is the foundation for all yard management activities.
Yard Areas and Spots
Every facility can have multiple areas defined within the yard, such as parking zones, dock areas, or staging locations. These areas help organize the physical space and provide structured tracking of asset positions.
Spot Areas
A Spot Area represents a logical grouping of physical locations within your facility. Examples include:
- Dock Areas: "Docks - Building A", "Docks - Building B"
- Parking Zones: "Trailer Parking - North", "Overflow Parking"
- Staging Areas: "Inbound Staging", "Outbound Staging"
Each area can contain multiple individual spots where assets can be positioned.
Common API Operations
Listing Yard Areas
Retrieve all spot areas configured for a specific warehouse location.
API Endpoint:
GET /yard/spot-area?s={"warehouseId":"{warehouseId}"}
Example Request:
GET /yard/spot-area?s={"warehouseId":"746a7b37-9592-45db-8a58-656c7727603d"}
Example Response:
{
"data": [
{
"id": "ad3b423b-cb7f-47ed-a6bb-2aa49707f0bb",
"isActive": true,
"warehouseId": "746a7b37-9592-45db-8a58-656c7727603d",
"name": "Docks - Building A"
},
{
"id": "f8c2d4e1-9a3b-4f7e-8d6c-5b2a1e9f3c4d",
"isActive": true,
"warehouseId": "746a7b37-9592-45db-8a58-656c7727603d",
"name": "Docks - Building B"
},
{
"id": "c5a8b9e3-2d4f-4a1c-9e7b-6f3d2c1a8b5e",
"isActive": true,
"warehouseId": "746a7b37-9592-45db-8a58-656c7727603d",
"name": "Trailer Parking - North"
},
{
"id": "d9f3c2a1-4e5b-4c6d-8a7e-9b1f2c3d4e5a",
"isActive": true,
"warehouseId": "746a7b37-9592-45db-8a58-656c7727603d",
"name": "Inbound Staging"
}
],
"entity": "SpotArea",
"action": "read",
"count": 4,
"total": 4,
"page": 1,
"pageCount": 1
}
Understanding Spot Properties
Before retrieving spots, it's helpful to understand the key properties that define each spot:
- code: The human-readable identifier you assigned when creating the spot. This should match the physical signage or labeling at your facility (e.g., "M1", "D45"). Drivers and yard personnel use this code to locate the spot.
- type: The functional type of the spot, which can be either:
parking: A general parking or staging location for trailers and trucksdocking: A dock door where loading or unloading operations occur
These properties help distinguish between different areas of your yard and enable filtering based on spot functionality.
Listing Spots with Current Assignments
A natural way to view yard operations is through the lens of physical spots — understanding what's currently occupying each location in your facility. This spot-first approach provides immediate visibility into yard utilization and asset positioning.
API Endpoint:
GET /yard/spot?join[]=spotAssignments&join[]=spotAssignments.assetVisit&join[]=spotAssignments.assetContainer&s={"spotAreaId":"{spotAreaId}"}
Example Request:
GET /yard/spot?join[]=spotAssignments&join[]=spotAssignments.assetVisit&join[]=spotAssignments.assetContainer&s={"spotAreaId":"09f41a5d-90cd-43d2-bb0c-8d0a6bccc517"}
Example Response:
{
"data": [
{
"id": "2df2d58a-dbe3-4608-b9b2-1614f8f47706",
"lastChangedDateTime": "2024-10-29T17:55:08.327Z",
"isActive": true,
"warehouseId": "746a7b37-9592-45db-8a58-656c7727603d",
"code": "M1",
"type": "parking",
"spotAreaId": "09f41a5d-90cd-43d2-bb0c-8d0a6bccc517",
"observation": null,
"spotAssignments": [
{
"id": "eda06334-3751-420b-8a6c-07244d04c6ca",
"lastChangedDateTime": "2025-12-29T19:12:34.987Z",
"isActive": true,
"warehouseId": "746a7b37-9592-45db-8a58-656c7727603d",
"spotId": "2df2d58a-dbe3-4608-b9b2-1614f8f47706",
"assetVisitId": "bfe9a8b7-f645-4454-83fe-dbbad21c04d5",
"assetContainerId": "4ddb1e68-a237-4288-ae9b-9cd65cc7332b",
"observation": null,
"assetVisit": {
"id": "bfe9a8b7-f645-4454-83fe-dbbad21c04d5",
"lastChangedDateTime": "2025-10-01T18:41:42.422Z",
"isActive": true,
"warehouseId": "746a7b37-9592-45db-8a58-656c7727603d",
"appointmentId": null,
"licensePlate": null,
"dotNumber": null,
"companyId": null,
"phone": "+14155552847",
"isPlanned": false,
"companyHint": "OPENDOCK",
"driverNotes": null,
"driverAppointmentIdentifier": null,
"visitType": "DropHook",
"checkInAcknowledged": false,
"company": null,
"assetContainers": [],
"appointment": null
},
"assetContainer": {
"id": "4ddb1e68-a237-4288-ae9b-9cd65cc7332b",
"type": "Trailer",
"state": null,
"code": "2890189012",
"notes": "Manually added via Yard View",
"pickupAppointmentId": null,
"dropAppointmentId": null,
"companyId": null,
"company": null,
"pickupAppointment": null,
"dropAppointment": null,
"assetContainerEvents": [
{
"id": "62bc08d5-aafc-4919-ab56-bd5483956fa9",
"assetVisitId": "bfe9a8b7-f645-4454-83fe-dbbad21c04d5",
"eventType": "Arrived",
"assetVisit": {
"id": "bfe9a8b7-f645-4454-83fe-dbbad21c04d5",
"appointmentId": null,
"companyId": null,
"phone": "+14155552847",
"isPlanned": false,
"companyHint": "OPENDOCK",
"visitType": "DropHook",
"company": null
}
}
]
}
}
],
"spotReserves": []
}
],
"entity": "Spot",
"action": "read"
}
Although spotAssignments is returned as an array, it will currently contain at most one element. An asset (visit or container) can have either zero spot assignments (not currently assigned to any spot) or one spot assignment (assigned to a specific spot). The array structure is maintained for potential future enhancements, but your integration can safely assume it will never have more than one active assignment at a time.
Each spot has specific limitations on what it can contain at any given time:
- Maximum one standalone container - A spot can hold only one unhooked container (detached from any truck)
- Maximum one truck - A spot can accommodate only one truck (asset visit), with or without containers attached
- Truck capacity - A single truck can have up to 2 containers attached to it
- Valid configurations - A spot can contain:
- Only a truck (with 0-2 attached containers)
- Only a standalone container
- Both a truck AND a standalone container
These rules ensure proper physical space management and prevent overcrowding of yard spots.
Understanding where container data appears in the response is critical:
- Hooked Containers: When a container is attached to a truck (hooked), it appears in
spotAssignments[0].assetVisit.assetContainers[0]— the container is associated with the Asset Visit - Unhooked Containers: When a container is detached from a truck (unhooked), it appears directly in
spotAssignments[0].assetContainer— the container is independently assigned to the spot
This distinction reflects the physical reality: hooked containers move with their trucks, while unhooked containers are independently positioned in the yard.
Listing Asset Visits with Spot Assignments
Alternatively, you can query from the asset visit perspective to understand which assets are positioned where in your yard. By joining the spot data, you can immediately see the spot code without additional API calls.
API Endpoint:
GET /asset-visit?join[]=spotAssignments||id,spotId&join[]=spotAssignments.spot||id,code,spotAreaId&s={"warehouseId":"{warehouseId}","isActive":true}
Example Request:
GET /asset-visit?join[]=spotAssignments||id,spotId&join[]=spotAssignments.spot||id,code,spotAreaId&s={"warehouseId":"746a7b37-9592-45db-8a58-656c7727603d","isActive":true}
Example Response:
{
"data": [
{
"id": "bfe9a8b7-f645-4454-83fe-dbbad21c04d5",
"warehouseId": "746a7b37-9592-45db-8a58-656c7727603d",
"appointmentId": null,
"licensePlate": null,
"dotNumber": null,
"companyId": null,
"phone": "+17135558219",
"isPlanned": false,
"companyHint": "OPENDOCK",
"driverNotes": null,
"driverAppointmentIdentifier": null,
"visitType": "DropHook",
"checkInAcknowledged": false,
"spotAssignments": [
{
"id": "eda06334-3751-420b-8a6c-07244d04c6ca",
"spotId": "2df2d58a-dbe3-4608-b9b2-1614f8f47706",
"spot": {
"id": "2df2d58a-dbe3-4608-b9b2-1614f8f47706",
"code": "M1"
}
}
]
}
],
"entity": "AssetVisit",
"action": "read",
"count": 1,
"total": 1,
"page": 1,
"pageCount": 1
}
This endpoint returns asset visits (trucks with drivers that checked in). It will not return orphan containers that have been detached and are sitting independently in your yard. See the next section for querying unhooked containers.