Skip to main content

Messages

The LocusOne API is a task execution system that will interpret Job messages and respond with JobResults. Each message sent to the LocusOne API must have a type indicated by the <EventType> element within the message. For example, a NEW OrderJob can be sent from a customer system to the LocusOne API. Then the LocusOne API will respond with OrderJobResults.

Select To Download

There are several workflows available within the LocusOne system to control work management.
Each workflow has it's own Message Types:

  • Picking - This is the workflow to pick outbound orders
    • OrderJob - The Locus-Inbound message for sending picking work to Locus
    • OrderJobResult - This is the Locus-Outbound message for sending picking events to the WMS
    • MissionSummary - (Optional) This is a Locus-Outbound robot mission level message that summarizes the Jobs/Totes for an event
      • Note: Currently only the Induct event is supported for the MissionSummary message.
  • Putaway - This is the workflow to putaway inbound product
    • PutawayJobRequest - (Optional) The Locus-Outbound mesage for Locus to request putaway work in the event that there is none found for the Licenseplate scanned
    • PutawayJob - The Locus-Inbound message for sending putaway work to Locus
    • PutawayJobResult - The Locus-Outbound message sending putaway events to the WMS
  • Inventory Counting - A workflow under the Picking workflow, this is the workflow for oportunistic counting of a location after a Pick has been actioned.
    • InventoryCountRequest - The Locus-Outbound message requesting to verify the current robot location should be counted
    • InventoryCountResponse - The Locus-Inbound message with the count information
    • InventoryCountResult - The Locus-Outbound message with the count results
  • Users - This message workflow is for managing Locus users
    • User - The Locus-Inbound message to create/update/delete users
    • UserResult - The Locus-Outbound message with the result of the above User message
  • Transport - The workflow to manage point to point transport with the Locus bots
    • MoveJob - The Locus-Inbound message for sending point to point work to Locus
    • MoveJobResult - The Locus-Outbound message for sending point to point events to the WMS
  • Heartbeats This message workflow is for optional heartbeat messages verifying the REST protocol is operational
    • HeartbeatToLocus - A Locus-Inbound heartbeat message
    • HeartbeatToLocusResponse - A Locus-Outbound response to the above inbound heartbeat message
    • HeartbeatFromLocus - A Locus-Outbound heartbeat message
    • HeartbeatFromLocusResponse - A Locus-Inbound response to the above outbound heartbeat message