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.
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.
Code | Transition to State | Substate |
|---|---|---|
E-025 | opened | opened |
E-026 | closed | closed |
E-027 | completed | completed |
E-028 | competed | Dead |
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.
Code | Transition to state | Substate |
|---|---|---|
E-022 | active | active |
E-023 | inactive | inactive |
E-024 | inactive | dead |
When an instance of an Order is instantiated, its initial state is initiated.
Code | Transition to state | Substate |
|---|---|---|
E-601 | created | created |
E-602 | closed | closed |
E-603 | inProgress | inProgress |
E-604 | closed | closed |
E-605 | executed | executed |
E-606 | closed | closed |
Code | Description |
|---|---|
0006 | Start Execution Task (ET) |
0007 | Completed- Success ET |
0008 | Completed- Failure ET |
0009 | Pick |
0010 | Deliver |
0011 | Capture Image |
0012 | Capture Input |
0013 | Display |
0014 | Doodle |
0015 | Form |
0016 | Scan |
0017 | InitPayment |
0018 | Process Payment |
0019 | Complete Payment |
0020 | Verify Input |
0021 | Verify Location |
0022 | Deliver Cash |
Code | Description |
|---|---|
E-010 | Entity Success |
E-011 | Entity Failure |
Code | Description |
|---|---|
0011 | Containment Zone |
0013 | Reschedule Delivery |
0014 | Cancel Delivery |
0015 | Reattempt Drop |
0019 | Customer Refused To Sign |
0020 | Payment Mode/Amount Dispute |
0022 | Customer Asked For Open Delivery |
0023 | Consignee Opened Package And Refused To Accept |
0024 | Entry Restricted Area |
0025 | Address Quality Issue |
0026 | Not Attempted |
0027 | Consignee Refused Order |
0028 | Consignee Seized Package |
0029 | Consignee Unavailable |
0041 | Delivered To Consignee |
0042 | Delivered To Security |
0043 | Delivered to Other As Per Consignee |
📘NOTE
Along with Event Codes, app developers can now define the underlying Reason Codes too. This enables developers to define different Event Codes as needed by the business and associate them with the success and failure of ETs.