Integration Notes

Practical guidance for working with VLMS events

Order

Detecting Order Creation

When an order is created, the system emits multiple events as various fields are populated. To reliably detect a new order, listen for the OrderDateChanged event where OrderDateType is OrderCreated.

Tip

Don't rely on the first event you receive for an order as the creation signal. Wait for OrderDateChanged with OrderDateType: OrderCreated to confirm the order exists.

Order Assignment Events

The OrderAssignment event uses an AssigningAction field to indicate different assignment types, including DriverAssignment and CarrierAssignment. See the Reference page for the full list of AssigningAction values.

Tip

For carrier assignments, OrderAssignment with AssigningAction: CarrierAssignment is equivalent to OrderCarrierAssigned. Similarly, CarrierUnAssignment is equivalent to OrderCarrierUnassigned.

Order Relations and Load Membership

OrderRelationChanged and LoadOrderAdded/LoadOrderRemoved can signal similar events when orders are added to or removed from loads. If you're tracking load membership changes, you may receive both event types.

Load

Detecting Load Creation

To detect when a new load is created, listen for the OrderDateChanged event where OrderDateType is OrderCreated and OrderType is LoadParent.

Load Delivery Events

LoadOrderCompleted is triggered when the entire load (LoadParent) or an Individual (OrderType) order is marked as Delivered.

Tip

LoadOrderCompleted fires once when the LoadParent is delivered, not when each LoadChild is delivered. To track load child deliveries, use OrderDateChanged where OrderDateType is Delivered and OrderType is LoadChild. This event includes the LoadParentId field.

Client

Detecting Client Creation

To detect when a new client is created, listen for the ClientUpdated event where IsCreated is true. When IsCreated is false, the event represents an update to an existing client.

Appointment

Detecting Appointment Creation

To detect when a new appointment is created, listen for the AppointmentStatusChanged event where IsCreated is true. When IsCreated is false, the event represents a status change on an existing appointment.