Entity, Event, and Reason Codes

State transitions are sequential. To reach the end state for any object, the object must be transitioned through the previous states.

For any object that is using the default configuration, the reason code is always R-0001.

Container Event Codes

When an instance of a Container is instantiated, its initial state is created.

To transition a Container to a new state, use the Apply Event on Container endpoint.

CodeTransition to StateSubstate
E-025openedopened
E-026closedclosed
E-027completedcompleted
E-028competedDead

Participant Event Codes

When an instance of a Participant is instantiated, its initial state is onboarding.

To transition a Participant to a new state, use the Apply Event to Instance endpoint.

CodeTransition to stateSubstate
E-022activeactive
E-023inactiveinactive
E-024inactivedead

Order Event Codes

When an instance of an Order is instantiated, its initial state is initiated.

CodeTransition to stateSubstate
E-601createdcreated
E-602closedclosed
E-603inProgressinProgress
E-604closedclosed
E-605executedexecuted
E-606closedclosed

Workflow Entity, Event codes, and Reason Codes

Workflow Entity Codes

CodeDescription
0006Start Execution Task (ET)
0007Completed- Success ET
0008Completed- Failure ET
0009Pick
0010Deliver
0011Capture Image
0012Capture Input
0013Display
0014Doodle
0015Form
0016Scan
0017InitPayment
0018Process Payment
0019Complete Payment
0020Verify Input
0021Verify Location
0022Deliver Cash

Workflow Event Codes

CodeDescription
E-010Entity Success
E-011Entity Failure

Workflow Reason Codes

CodeDescription
0011Containment Zone
0013Reschedule Delivery
0014Cancel Delivery
0015Reattempt Drop
0019Customer Refused To Sign
0020Payment Mode/Amount Dispute
0022Customer Asked For Open Delivery
0023Consignee Opened Package And Refused To Accept
0024Entry Restricted Area
0025Address Quality Issue
0026Not Attempted
0027Consignee Refused Order
0028Consignee Seized Package
0029Consignee Unavailable
0041Delivered To Consignee
0042Delivered To Security
0043Delivered to Other As Per Consignee