Gate Check-In
6 min
The following message is sent to a subscribed URL when a trailer is checked into a site. This is associated with the Check_In trigger.
Field Definitions
All fields on the webhooks will be present on every message, the schema is static. However, the Required field on each will notate whether or not a field can be nullable. For array values, an empty array would return if optional and an empty list
- Optional String field example when empty: "turnaway_reason": null
- Optional Array field example when empty: "load_numbers": []
Custom Trailer Attributes
The additional_attributes array contains a list of custom attributes created on the trailer check-in form and are configured in the Nomenclature setup. If your organization does not have a need for custom fields to be entered by users in Dynamic Yard, this array will be empty. Otherwise, the fields and their values will be listed.
Trailer / Equipment Detail
- additional_attributes
- Type: Array
- Required: O
- Description: Array of additional/custom attributes created on the trailer. If no custom attributes are defined in the company setup, this will be an empty array. See the Custom Attributes section in the description for more information
- appointment_type
- Type: String
- Required: M
- Description: Type of check-in and is selected by the gate. Please view the check-in modal window for additional details for different types of check-in options. Valid values: Live | Drop_and_Hook | Inbound_Only | Outbound_Only | Check_in_Only
- audit_trailer
- Type: Boolean
- Required: O
- Description: Indicates whether the trailer needs to be audited. If not used, the field will pass as null
- audit_trailer_notes
- Type: String
- Required: O
- Description: Notes left about the trailer's audit status. If no notes are left, the field will pass as null
- equipment_type
- Type: String
- Required: M
- Description: The type of trailer (e.g. 53' Dry Van, Container, etc.). Values are configurable in the UI as customer master data
- location_name
- Type: String
- Required: O
- Description: Name of last location of the trailer prior to check-out. Will be either a parking spot name or dock door name. If the trailer has an "Unassigned" location then this will be null
- location_parent_name
- Type: String
- Required: O
- Description: Name of the last dock or parking lot where the trailer is was located prior to check-out. If the trailer is in a parking spot, this will be the parking lot name associated with that spot. If the trailer is in a dock door, this will be the dock name associated with that door. If the trailer has an "Unassigned" location then this will be null
- location_type
- Type: String
- Required: O
- Description: Type of the last location of the trailer prior to check-out. Will be either "Spot" or "Door". If the trailer has an "Unassigned" location then this will be null
- message_type
- Type: String
- Required: M
- Description: Type of webhook. Will always be GATE_TRANSACTION
- out_of_service
- Type: Boolean
- Required: M
- Description: true/false indicator as to whether the trailer is eligible for use
- out_of_service_notes
- Type: String
- Required: M
- Description: Notes left about the trailer's service status. If no notes left, field will pass as null
- seal_number
- Type: String
- Required: O
- Description: Seal number associated with the trailer
- seal_status
- Type: String
- Required: O
- Description: Seal status of the trailer (e.g. "Intact" or "Broken")
- site_code
- Type: String
- Required: M
- Description: Unique identifier for the site
- tractor_name
- Type: String
- Required: O
- Description: Truck/tractor number entered on the UI by the gate
- trailer_arrival_time
- Type: ISO8601 Date/Time
- Required: M
- Description: Arrival time of the trailer at the facility
- trailer_condition
- Type: String
- Required: O
- Description: Condition of the trailer (e.g. "Clean", "Dirty"). Values are configurable as master data
- trailer_damage
- Type: Boolean
- Required: O
- Description: Boolean flag indicating whether or not the trailer is damaged. If not checked, field will pass as null
- trailer_damage_notes
- Type: String
- Required: O
- Description: Notes left about the damage status of a trailer. If no notes are used, field will pass as null
- trailer_departure_time
- Type: ISO8601 Date/Time
- Required: O
- Description: Departure time of the trailer from the facility. Will always be null for check-in events
- trailer_id
- Type: String
- Required: M
- Description: Unique trailer ID generated by Dynamic Yard. It is recommended to store this ID as it is used for other Dynamic Yard APIs
- trailer_tag
- Type: String
- Required: O
- Description: RFID tag associated with the trailer, or placed on the trailer by the gate. If RFID tags are not used, this field will be null
- trailer_number
- Type: String
- Required: M
- Description: Trailer number entered by the gate upon check-in
- trailer_usage
- Type: String
- Required: O
- Description: This is a custom label that can be used to identify how the trailer is being used (dedicated fleet, storage, OTR, etc). This status is tied to the usage of the trailer, not the descriptor of the trailer
- transaction_type
- Type: String
- Required: M
- Description: Will be either ARRIVAL or TURN_AWAY depending upon whether the trailer was checked into the facility or turned away
- turnaway_reason
- Type: String
- Required: O
- Description: If the trailer is turned away, this will contain the specific reason
Delivery / Shipment Detail
- delivery_ids
- Type: Array
- Required: O
- Description: List of delivery IDs (shipments) associated with the trailer. These are listed on the delivery object. Will only be populated if the trailer is full
- delivery_info
- Type: Array of Objects
- Required: O
- Description: A list of objects showing the customer associated with each delivery. The object will contain two fields: customer and delivery_id to demonstrate the link between the two:
"delivery_info": [
{
"customer": "ABC Store",
"delivery_id": "30808495_BCCC"
}
]- delivery_reference_numbers
- Type: Array
- Required: O
- Description: List of load and stop reference numbers associated with the delivery. These are secondary references used to identify the delivery and are alphanumeric fields. Note*: if Core Track is used as the source of delivery data, these will correspond to the load and stop reference numbers associated with the load / stop*
- direction
- Type: String
- Required: M
- Description: Direction of the trailer, can be "Inbound" or "Outbound"
- load_numbers
- Type: String
- Required: O
- Description: List of load numbers associated with the trailer. These correspond to the "Bill of Lading" value on the delivery object. Will only be populated if the trailer is full
- load_status
- Type: String
- Required: O
- Description: Load status associated with the trailer. This is often updated when the warehouse is finished loading/unloading the trailer. *See WMS API section for more information on load_status
- load_type
- Type: String
- Required: O
- Description: Additional descriptor that can be configured per load status. Used to help differentiate loads and allow for a general categorization of the freight on a trailer
- process_status
- Type: String
- Required: O
- Description: Process status of the trailer. See WMS API section for more information on process_status
Carrier / Transaction Detail
- carrier_name
- Type: String
- Required: M
- Description: Name of the carrier which owns the trailer
- comments
- Type: String
- Required: O
- Description: Comments left by the gate during check-in. If no comments are entered, field will pass as null
- gate_pass_number
- Type: Int(32)
- Required: M
- Description: Gate pass ID which is automatically generated when a trailer is checked into the yard
- is_brokered
- Type: Boolean
- Required: O
- Description: Indicates whether or not the load has been brokered. Default value is false
- scac
- Type: String
- Required: M
- Description: SCAC or carrier code of the company which owns the trailer
- tractor_carrier_name
- Type: String
- Required: O
- Description: Name of the carrier which owns the truck/tractor
- tractor_scac
- Type: String
- Required: O
- Description: SCAC or carrier code of the company which owns the truck/tractor
Additional Attributes Detail
The following fields will only be present if custom attributes are configured on the trailer check-in form. Specifically, the array lists an object with the following fields. If custom attributes are not used by your company, then the additional_attributes array will be empty.
- form
- Type: String
- Required: O
- Description: The data object which the attribute is created for. On the Gate Check-In webhook, this will be trailer
- label
- Type: String
- Required: O
- Description: Label users see for the field in the UI
- name
- Type: String
- Required: O
- Description
- type
- Type: String
- Required: O
- Description: Data type of the custom attribute. Available types include: Text | Option | Toggle (yes/no)
- value
- Type: String/Boolean*
- Required: O
- Description
{
"additional_attributes": [
{
"form": "trailer",
"label": "Building Number",
"name": "building_number",
"type": "Option",
"value": "B8475"
}
],
"appointment_type": "Live",
"audit_trailer": true,
"audit_trailer_notes": null,
"carrier_name": "McClure / Prinzi",
"comments": null,
"delivery_ids": [
"8BD5427B_D2F1"
],
"delivery_info": [
{
"customer": null,
"delivery_id": "30808495_BCCC"
}
],
"delivery_reference_numbers": [
"4858",
"H9948"
],
"direction": "Inbound",
"equipment_type": "Container",
"gate_pass_number": 9839,
"is_brokered": true,
"load_numbers": [
"8BD5427B_D2F1"
],
"load_status": "Full",
"load_type": null,
"location_name": "046",
"location_parent_name": "Storage Yard",
"location_type": "Spot",
"message_type": "GATE_TRANSACTION",
"out_of_service": null,
"out_of_service_notes": null,
"process_status": "Unload",
"scac": "0010",
"seal_number": "79874687",
"seal_status": "Intact",
"site_code": "SS03",
"tractor_carrier_name": "McClure / Prinzi",
"tractor_name": "75768",
"tractor_scac": "0010",
"trailer_arrival_time": "2022-08-31T21:44:09.930416",
"trailer_condition": "Dirty",
"trailer_damage": true,
"trailer_damage_notes": null,
"trailer_departure_time": null,
"trailer_id": 2803,
"trailer_tag": "847584747",
"trailer_number": "H84758",
"trailer_usage": "Over the Road",
"transaction_type": "ARRIVAL",
"turnaway_reason": null
}