EDI 214/322: Load Status

EDI 214 and 322 transactions contain Load status information, including appointments and exceptions.

For EDI REST: See additional documentation for payload examples and other endpoint information.

For EDI SOAP (deprecated): See the EDI Specification Guide for payload examples.

EDI 214

Carriers and Vendors send EDI 214 transactions (inbound) to the Revenova Partner VAN, who then send them to the TMS, and the TMS queues EDI 214 transactions (outbound) for retrieval by the Partner VAN.

Inbound Transactions

Load stop status updates match on the Stop Number first, and then the City, State, and Country. If no Stop Number is provided, matching is based on the Stop Account and must match the City. The State and Country must also match, if present.

Time Zones

The TMS accepts time zones as an optional element when received from inbound EDI 214 transactions. Time zone information is managed as described below.

The Time Zone is set for Stop Level Events such as arrivals, departures, and appointment times in the following scenarios:

• The Stop Location record in the TMS has a time zone.

  • The time zone is set to the Stop location's time zone.

• If the time zone on the EDI 214 differs from the Stop location time zone, the time on the 214 is translated to the Stop location time zone.

• If the Stop Location does not have a time zone.

  • The time from the EDI 214 is accepted.

• In Transit X6 Load tracking updates are processed as Load events. If a time zone is received in an X6 214 update, it is converted to GMT.

• If an EDI 214 transaction does not contain a time zone, the transaction time is converted to the Stop location's time zone.

Time zones follow the following hierarchy.

Event

↓

Stop

↓

Location

↓

User

↓

GMT

Time Zones are sent in outbound 214 transactions in Local Time (LT).

Geolocations

Latitude and longitude coordinates are optional elements that may be included in inbound EDI 214 transactions. Geolocation coordinates are stored on the Load in the Last Reported Geolocation field. City/State combinations are not matched to the geolocation coordinates.

Event Code

The Event Code field is displayed on the Load EDI Transactions related list. Event Codes are received on inbound EDI 214 transactions. See the table below for a list of supported inbound Event Codes.

Unknown codes are saved as Carrier Status Comments.

Outbound Transactions

Outbound EDI 214 transactions are processed as Platform Events.

For EDI REST: Partner VANs call the GET EDI Service endpoint to receive all queued 214 transactions.

For EDI SOAP: The TMS makes the SendLoadStatusMessages API call to send all queued 214 transactions to the Trading Partner VAN and/or Trading Partner(s) as X6 transactions.

No EDI 997 transaction is returned to the TMS.

Note: The TMS sends the Load’s Stop information including those with the same Location for multiple stops on a Load.

Outbound Criteria

The EDIJob generates an X6 (In Transit) 214 EDI Transaction when the following criteria are met. To send EDI 214 transactions in regular intervals, set the Location Update Send Frequency field on the Shipper/Consignee (Customer) Transportation Profile on the Load to determine the frequency EDI 214 (X6) transactions are generated. When tracking customer Loads, EDI 214 transactions are created and queued in a Pending Status.

The following criteria are required to generate and queue outbound 214 EDI Transactions.

• The Load EDI Status field must be one of the following values.

  • Accepted

  • Updated

  • Pending

• The Customer on the Load must be an EDI Location that is configured appropriately as a Trading Partner.

• The Load EDI SCAC field must match the EDI Location SCAC field for the customer Trading Partner.

• All Load Stops must have an Account location.

Warning: Stops that use Geolocation instead of an Account reference (such as Same as Customer or Account Address) do not generate outbound EDI 214 transactions.

• The Load Customer Transportation Profile Location Update Send Frequency must have a value and past the length of time set in the value. Transactions are not generated until the time value elapses from the previous location update.

• The Load Last Reported City field must have a value.

• The last Stop Expected Date field must either have no value or must be within 10 days in the past.

• The Load EDI Provider field must match the Revenova customer EDI Provider.

• The Load Status field must not be one of the values below.

  • Delivered

  • Completed

  • Cancelled

  • Declined

  • Expired

When the above criteria are met for a Load, an outbound 214 EDI Transaction is generated and queued in the following scenarios.

1. The initial appointment 214 EDI Transaction and a 990 EDI Transaction are generated when a 204 EDI Transaction is auto-accepted.

   1. When an inbound EDI 204 EDI Transactions (Load Tender) is received, the generated outbound 214 EDI Transaction for accepting the Tender includes the Appointment Time fields from the 204 EDI Transaction.

2. The initial appointment 214 EDI Transaction and a 990 EDI Transaction are generated when the Load EDI Status is manually set to Accept.

3. Changes to the following Stop fields generate and queue an EDI 214 transaction when a Stop date or time field is adjusted OR when a Carrier arrives or departs a Stop location.

   1. Appointment Time

   2. Arrival Date

   3. Arrival Time

   4. Departure Date

   5. Departure Time

   6. Expected Date

   7. Loading/Unloading Complete Date

   8. Loading/Unloading Complete Time

Run the EDIWatcherJob to send outbound EDI 214 location updates to customers for In Transit Loads. An EDI 214 is sent each time the Load Status is In Transit, and the time has elapsed since the last sent transaction set by the Location Update Send Frequency field.

Note: The status time for these EDI 214 transactions use the org’s Default Time Zone selected in Setup → Company Information. Updating this default time zone takes about 18 hours before EDI 214 (X6) transactions update the status time using the new time zone.

The TMS does not send an event code in outbound EDI 214 transactions. The partner VAN retrieves the EDI 214 transaction and applies the following event codes as appropriate. The table below provides TMS field updates that generate the EDI 214 transaction and the subsequent event code that is later interpreted/added by the VAN. Reference the values below to determine when the TMS generates an outbound EDI 214 transaction.

Stop Number

Outbound EDI 214 transactions include the Stop Number in the currentLocation element. Load Stops are searched, and the first Stop not in a Departed status determines the current Stop Number sent in the transaction. See the API EDI documentation for specific element information.

Geolocations

Latitude and longitude coordinates are elements sent by the TMS in outbound EDI 214 transactions. The geolocation values from the Stop come from the Location field and use the Account’s ShippingLatitude and ShippingLongitude fields.

Caution: The Geocodes for Account Shipping Address must be active in Setup → Data Integration Rules to have the latitude and longitude values for Stop events to populate correctly in outbound EDI 214 transactions. See the Geocode Data Integration Rules Salesforce help article for more information.

If the Account does not have geocodes for the Shipping Address, the latitude and longitude for Stop events use the Last Reported Geolocation of the Load instead.

When Load Status is In Transit, the geolocation in the outbound EDI 214 transaction for location status (X6) uses the current Last Reported Geolocation value of the Load.

Bulk Send EDI 214 (Outbound)

Send or resend EDI 214 status transactions in bulk. Select the appropriate Loads from the Load list view and select EDI Status from the drop-down.

The BulkEDI214Send Visualforce Page displays with the selected Loads. Click the Send button to send the EDI 214 transactions to each Load.

The Status column describes the EDI 214 transactions that were sent for that Load. Each line that begins with a Stop number (Stop 1, for example) is one outbound EDI 214 transaction for that Load.

When the Send Appointments First box is checked, the TMS sends EDI 214 transactions regarding appointment details for each Stop first, and then the arrival and departure information for the Stops after.

Troubleshooting

Status Error: “Not an EDI Load”

This error occurs when the Load does not have a value in the EDI Provider field.

Resolution

Enter the EDI Provider that matches the Revenova customer’s EDI Provider to make the Load an EDI Load. An EDI Load is indicated with the blue “EDI” pill in the Customer Banner LWC.

Status Error: “The outbound 214 cannot be sent because the stop is missing an account in the Location field.”

This error occurs when a Stop does not have an Account reference in the Location field.

Resolution

Ensure that all Stops have an Account in the Location field to send EDI 214 transactions.

Send EDI 214 Load Tracking Modal

When the Customer Quote is accepted, the Send Tracking Updates button becomes available in the Customer Banner LWC. Select the button to open the Load Tracking Administration modal.

For EDI Loads, the Send EDI 214 Update Now button is available. Select the button to send EDI 214 transactions with Arrival and Departure details. Each Stop that has Arrival and Departure Dates are sent as one EDI 214 transaction.

EDI 322

Outbound EDI 322 Terminal Operations and Intermodal Ramp Activity transaction updates are processed the same as as EDI 214 transactions.

Inbound Transactions

Inbound EDI 322 transactions contain movement events and CLM car location messages.

• Inbound EDI 322 Load Status Message transactions are matched based on the shipmentId to the TMS Load Number.

• The Event Code received in the transaction determines the Stop information that is updated. See the Event Codes table below for specific logic.

• If the EDI transaction contains a Waybill Number, Booking Number, or Seal Number these values are saved to the Load.

  • Any existing values in these fields are overwritten with the values from the EDI 322 transaction.

Stop Matching

The information received in the EDI 322 transaction is used to identify/match the current Load Stop based on the following criteria.

• Some scenarios have no matches based on the Stop Number, Lat/Lon, or City/State.

  • The first Stop without a Departure Date has not yet departed.

  • This stop is the current Stop.

• If still no match is found, all other Stops have Departure Date fields populated.

  • The last Stop on the Load is the current Stop.

Event Codes

These event codes are processed for inbound EDI 214 and 322 transactions.