Routing events
These are the routing events. Each one reaches a webhook subscription as the data of a webhook delivery, whose type is the event type shown under its heading. Every required property is always present; a nullable one may be null.
ContainerInducted
Section titled “ContainerInducted”Type: jtWMS.Routing.Events.V1.ContainerInducted
Published by the Routing service when a container is inducted onto the conveyor and its journey opens. Carries the whole journey: its destination (null while unresolved), topology version and path start.
Payload: The journey just opened (Status InTransit).
| Property | Type | Required | Description |
|---|---|---|---|
JourneyId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
ContainerCode |
string | Yes | |
ContainerKind |
string, one of PickTote, BatchTote, ShippingCarton, Unknown |
Yes | |
DestinationId |
string (uuid), nullable | Yes | Null while the destination is unresolved; the exception destination after an Exception decision. |
DestinationCode |
string, nullable | Yes | |
DestinationType |
string, one of PackStation, PutWallInduction, ShipSortLane, Exception, null, nullable |
Yes | |
TopologyVersion |
integer | Yes | The routing topology version the container was inducted under. |
Status |
string, one of InTransit, Arrived, Exception, Loaded, Superseded |
Yes | |
InductionNodeCode |
string | Yes | |
LastNodeCode |
string | Yes | The last node the container was seen at. |
Recirculations |
integer | Yes | |
OrderIds |
array of strings (uuid) | Yes | |
ShipmentId |
string (uuid), nullable | Yes | |
RaisedException |
boolean | Yes | |
InductedAt |
string (date-time) | Yes | |
ArrivedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes |
ContainerDiverted
Section titled “ContainerDiverted”Type: jtWMS.Routing.Events.V1.ContainerDiverted
Published by the Routing service when it decides a container’s exit at a decision point: Route along its path, Recirculate on the loop back, or Exception toward the exception destination. Carries the whole journey and the decision. An anonymous no-read (no container code, no journey) publishes none; its RoutingExceptionRaised carries it.
Payload: The journey after the decision, and the decision.
| Property | Type | Required | Description |
|---|---|---|---|
JourneyId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
ContainerCode |
string | Yes | |
ContainerKind |
string, one of PickTote, BatchTote, ShippingCarton, Unknown |
Yes | |
DestinationId |
string (uuid), nullable | Yes | Null while the destination is unresolved; the exception destination after an Exception decision. |
DestinationCode |
string, nullable | Yes | |
DestinationType |
string, one of PackStation, PutWallInduction, ShipSortLane, Exception, null, nullable |
Yes | |
TopologyVersion |
integer | Yes | The routing topology version the container was inducted under. |
Status |
string, one of InTransit, Arrived, Exception, Loaded, Superseded |
Yes | |
InductionNodeCode |
string | Yes | |
LastNodeCode |
string | Yes | The last node the container was seen at. |
Recirculations |
integer | Yes | |
OrderIds |
array of strings (uuid) | Yes | |
ShipmentId |
string (uuid), nullable | Yes | |
RaisedException |
boolean | Yes | |
InductedAt |
string (date-time) | Yes | |
ArrivedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes | |
ScannerCode |
string | Yes | |
DecisionPointCode |
string | Yes | |
Decision |
string, one of Route, Recirculate, Exception |
Yes | |
ExitNodeCode |
string | Yes | |
DecidedAt |
string (date-time) | Yes |
ContainerArrived
Section titled “ContainerArrived”Type: jtWMS.Routing.Events.V1.ContainerArrived
Published by the Routing service when a container reaches a destination’s node. Carries the whole journey: Arrived at its own destination, or Exception when misrouted.
Payload: The journey after the arrival (Status Arrived at its own destination, Exception when misrouted), and where it arrived.
| Property | Type | Required | Description |
|---|---|---|---|
JourneyId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
ContainerCode |
string | Yes | |
ContainerKind |
string, one of PickTote, BatchTote, ShippingCarton, Unknown |
Yes | |
DestinationId |
string (uuid), nullable | Yes | Null while the destination is unresolved; the exception destination after an Exception decision. |
DestinationCode |
string, nullable | Yes | |
DestinationType |
string, one of PackStation, PutWallInduction, ShipSortLane, Exception, null, nullable |
Yes | |
TopologyVersion |
integer | Yes | The routing topology version the container was inducted under. |
Status |
string, one of InTransit, Arrived, Exception, Loaded, Superseded |
Yes | |
InductionNodeCode |
string | Yes | |
LastNodeCode |
string | Yes | The last node the container was seen at. |
Recirculations |
integer | Yes | |
OrderIds |
array of strings (uuid) | Yes | |
ShipmentId |
string (uuid), nullable | Yes | |
RaisedException |
boolean | Yes | |
InductedAt |
string (date-time) | Yes | |
ArrivedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes | |
ArrivedAtNodeCode |
string | Yes | |
ArrivedAtDestinationCode |
string | Yes |
RoutingExceptionRaised
Section titled “RoutingExceptionRaised”Type: jtWMS.Routing.Events.V1.RoutingExceptionRaised
Published by the Routing service when it raises a routing exception (an alert): an unknown container, a no-read or a container with no destination sent to the exception destination after one recirculation, a misroute, or a shipment Outbound refused at load close-out. Carries the whole exception.
Payload: The exception just raised (Status Open).
| Property | Type | Required | Description |
|---|---|---|---|
RoutingExceptionId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
Type |
string, one of UnknownContainer, NoRead, NoDestination, Misroute, ShipFailed |
Yes | |
Status |
string, one of Open, Acknowledged |
Yes | |
JourneyId |
string (uuid), nullable | Yes | |
ContainerCode |
string, nullable | Yes | Null for an anonymous no-read. |
NodeCode |
string, nullable | Yes | |
LoadId |
string (uuid), nullable | Yes | The load whose shipment Outbound refused, for ShipFailed. |
Detail |
string | Yes | |
RaisedAt |
string (date-time) | Yes | |
AcknowledgedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes |
LoadOpened
Section titled “LoadOpened”Type: jtWMS.Routing.Events.V1.LoadOpened
Published by the Routing service when a load (one trailer visit) is opened at a dock door. Carries the whole load.
Payload: The load just opened (Status Open, no containers).
| Property | Type | Required | Description |
|---|---|---|---|
LoadId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
DockDoorId |
string (uuid) | Yes | |
DockDoorCode |
string | Yes | |
TrailerNumber |
string | Yes | |
CarrierCode |
string, nullable | Yes | |
Status |
string, one of Open, Closed |
Yes | |
Containers |
array of objects | Yes | |
Containers[].ContainerCode |
string | Yes | |
Containers[].JourneyId |
string (uuid) | Yes | |
Containers[].ShipmentId |
string (uuid), nullable | Yes | |
Containers[].OrderId |
string (uuid), nullable | Yes | |
Containers[].LoadedAt |
string (date-time) | Yes | |
Shipments |
array of objects | Yes | |
Shipments[].ShipmentId |
string (uuid) | Yes | |
Shipments[].OrderId |
string (uuid), nullable | Yes | |
Shipments[].ShipStatus |
string, one of Pending, Requested, Shipped, ShipFailed |
Yes | |
Shipments[].ErrorCode |
string, nullable | Yes | Outbound’s reason, for ShipFailed. |
OpenedAt |
string (date-time) | Yes | |
ClosedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes |
ContainerLoaded
Section titled “ContainerLoaded”Type: jtWMS.Routing.Events.V1.ContainerLoaded
Published by the Routing service when a carton is scanned onto a load. Carries the whole load and the carton’s code.
Payload: The load after the carton was added, and the carton’s code.
| Property | Type | Required | Description |
|---|---|---|---|
LoadId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
DockDoorId |
string (uuid) | Yes | |
DockDoorCode |
string | Yes | |
TrailerNumber |
string | Yes | |
CarrierCode |
string, nullable | Yes | |
Status |
string, one of Open, Closed |
Yes | |
Containers |
array of objects | Yes | |
Containers[].ContainerCode |
string | Yes | |
Containers[].JourneyId |
string (uuid) | Yes | |
Containers[].ShipmentId |
string (uuid), nullable | Yes | |
Containers[].OrderId |
string (uuid), nullable | Yes | |
Containers[].LoadedAt |
string (date-time) | Yes | |
Shipments |
array of objects | Yes | |
Shipments[].ShipmentId |
string (uuid) | Yes | |
Shipments[].OrderId |
string (uuid), nullable | Yes | |
Shipments[].ShipStatus |
string, one of Pending, Requested, Shipped, ShipFailed |
Yes | |
Shipments[].ErrorCode |
string, nullable | Yes | Outbound’s reason, for ShipFailed. |
OpenedAt |
string (date-time) | Yes | |
ClosedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes | |
ContainerCode |
string | Yes |
LoadClosed
Section titled “LoadClosed”Type: jtWMS.Routing.Events.V1.LoadClosed
Published by the Routing service when a load is closed and its complete shipments are sent to Outbound to ship. Carries the whole load.
Payload: The closed load, its shipments Requested from Outbound.
| Property | Type | Required | Description |
|---|---|---|---|
LoadId |
string (uuid) | Yes | |
FacilityId |
string (uuid) | Yes | |
DockDoorId |
string (uuid) | Yes | |
DockDoorCode |
string | Yes | |
TrailerNumber |
string | Yes | |
CarrierCode |
string, nullable | Yes | |
Status |
string, one of Open, Closed |
Yes | |
Containers |
array of objects | Yes | |
Containers[].ContainerCode |
string | Yes | |
Containers[].JourneyId |
string (uuid) | Yes | |
Containers[].ShipmentId |
string (uuid), nullable | Yes | |
Containers[].OrderId |
string (uuid), nullable | Yes | |
Containers[].LoadedAt |
string (date-time) | Yes | |
Shipments |
array of objects | Yes | |
Shipments[].ShipmentId |
string (uuid) | Yes | |
Shipments[].OrderId |
string (uuid), nullable | Yes | |
Shipments[].ShipStatus |
string, one of Pending, Requested, Shipped, ShipFailed |
Yes | |
Shipments[].ErrorCode |
string, nullable | Yes | Outbound’s reason, for ShipFailed. |
OpenedAt |
string (date-time) | Yes | |
ClosedAt |
string (date-time), nullable | Yes | |
UpdatedAt |
string (date-time) | Yes |