OS1 Services
Workflow Service
Execution Task and Macro Payloads
22min
Set of Execution Tasks in a pre-defined logical manner creates an Execution Workflow. Execution Workflows can also include Execution Macro in it which is a reusable set of Execution Tasks.
When you define an Execution Workflow, the request body will have the following important keys:
- Flow- Defines the flow of Execution Tasks (and Execution Macro) that will be executed in a sequence to complete the workflow.
- Input- This key includes necessary information regarding the Execution Task. The payloads provided below shows what inputs are required for a particular Execution Task. For example, the Start Execution Task can have two properties as input- canGoBack (optional) & applicableReasons (required).
- Condition- This specifies the circumstance in which an Execution Task will be executed.
For more information on Execution Workflows, see Workflow Documentation.
📘 Entity, Event, and Reason Codes
Check out the list of Entity, Event, and Reason Codes here.
This documentation will help you understand what inputs you need in order to include an Execution Task or Macro in an Execution Workflow.
An Execution Task (ET) is the smallest atomic task that is performed by an operator. Currently, we have 18 system-defined ETs.
Execution Tasks | Description |
Start | Developers can use this ET to initiate an objective workflow. |
Developers can use this ET to add an ability to verify if the rider is at a specific location at any given point in time. | |
Pick | Developers can use this ET to keep track of the ownership of packages and cash. |
By using "Verify Input" ET, developers can validate whether the provided input (Captured Input ET) matches the response from an API or a static value. | |
This Execution Task enables the developers to capture an image of the shipment. | |
This ET allows developers to capture a number or string input. | |
Deliver | The Deliver ET can be used by developers when the inventory transfer is Payable (Out). |
Display | This ET allows the developer to display an alert message, information, warning, etc to the FE. |
Doodle | This ET allows the developer to capture the digital signature (fingertip trace) of the shipment receiver. |
This ET allows the developer to enable FE to deposit cash at the Delivery center. | |
Form | Developers can use this ET to collect different information in different formats. |
Scan | Developers can use this ET to allow an operator to scan a barcode or QR code. |
This ET enables the developer to define if the terminal endpoint of a workflow was successful. | |
This ET enables the developer to define if the terminal endpoint of a workflow failed. | |
This ET is used by the developers to instruct the app layer to initiate payment flow with payment data. | |
This enables the developers to set an ET for processing payments and generating transaction IDs. | |
This allows the developers to capture the final details of payments (tenant pay ID, transaction ID, amount, etc). | |
Developers can use this ET for capturing and verifying if the given input matches the response from an API or static value. |
Below we have provided the payloads for all the default ETs. For more information on ETs, see Workflow Documentation.
JSON
1{
2 "name": "Start",
3 "entityCode": "0006",
4 "description": "To start the objective workflow ",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "canGoBack": {
15 "title": "Can go back",
16 "type": "boolean",
17 "description": "This attribute enables the developers to revert back to any of the previous ETs."
18 },
19 "applicableReasons": {
20 "title": "Applicable reasons",
21 "description": "Developers can use this attribute to providean Applicable reason code for moving from one ET to the next one.",
22 "type": "object"
23 }
24 },
25 "required": ["applicableReasons"]
26 },
27 "output": {
28 "type": "object",
29 "properties": {
30 "success": {
31 "description": "Success flag for the operation performed by user",
32 "type": "boolean"
33 },
34 "eventCode": {
35 "type": "string",
36 "description": "Event code"
37 },
38 "reasonCode": {
39 "type": "string",
40 "description": "Reason code"
41 },
42 "meta": {
43 "type": "object",
44 "description": "Meta data related to execution of task",
45 "properties": {
46 "startTime": {
47 "type": "number",
48 "description": "Epoch timestamp for the start of task"
49 },
50 "endTime": {
51 "type": "number",
52 "description": "Epoch timestamp for the end of task"
53 },
54 "location": {
55 "type": "object",
56 "description": "Location at start of task",
57 "properties": {
58 "latitude": {
59 "type": "string",
60 "description": "Latitude"
61 },
62 "longitude": {
63 "type": "string",
64 "description": "Longitude"
65 }
66 }
67 },
68 "userDetails": {
69 "type": "string",
70 "description": "Unique identifier of user performing the action"
71 }
72 }
73 }
74 },
75 "required": ["success"]
76 },
77 "canMerge": false
78}
JSON
1{
2 "name": "VerifyLocation",
3 "entityCode": "0021",
4 "description": "Ability to verify if the rider is at a certain location",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Transport"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "geolocation": {
15 "title": "Geo-Location",
16 "description": "Provides the details for a given geo-location such as longitude and latitude.",
17 "type": "object",
18 "properties": {
19 "longitude": {
20 "title": "Longitude",
21 "type": "string",
22 "description": "Longitude for a geolocation",
23 "pattern": "^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,6})?))$"
24 },
25 "latitude": {
26 "title": "Latitude",
27 "type": "string",
28 "description": "Latitude for a geolocation",
29 "pattern": "^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,6})?))$"
30 },
31 "accuracy": {
32 "title": "Accuracy",
33 "type": "number"a,
34 "description": "Accuracy of the geolocation in meters",
35 "minimum": 0
36 },
37 "geofencing": {
38 "title": "Geofencing",
39 "type": "object",
40 "description": "Developers can use this attribute to add details of geo-fencing around the location",
41 "properties": {
42 "radius": {
43 "title": "Radius",
44 "type": "number",
45 "description": "Radius in meters around the location for geo-fencing",
46 "minimum": 1
47 }
48 },
49 "required": ["radius"]
50 }
51 },
52 "required": ["latitude", "longitude", "geofencing"]
53 },
54 "address": {
55 "title": "Address",
56 "type": "string"
57 },
58 "title": {
59 "title": "Title",
60 "type": "string",
61 "description": "Title for the message to be displayed to the FE"
62 },
63 "message": {
64 "title": "Message",
65 "type": "string",
66 "description": "Actual instruction message body for the FE."
67 },
68 "canGoBack": {
69 "title": "Can go back",
70 "type": "boolean",
71 "description": "This attribute enables the developers to revert back to any of the previous ETs."
72 },
73 "applicableReasons": {
74 "title": "Applicable reasons",
75 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
76 "type": "object"
77 }
78 },
79 "required": ["geolocation", "title", "applicableReasons"]
80 },
81 "output": {
82 "type": "object",
83 "properties": {
84 "success": {
85 "description": "Success flag for the operation performed by user",
86 "type": "boolean"
87 },
88 "eventCode": {
89 "type": "string",
90 "description": "Event code"
91 },
92 "reasonCode": {
93 "type": "string",
94 "description": "Reason code"
95 },
96 "meta": {
97 "type": "object",
98 "description": "Meta data related to execution of task",
99 "properties": {
100 "startTime": {
101 "type": "number",
102 "description": "Epoch timestamp for the start of task"
103 },
104 "endTime": {
105 "type": "number",
106 "description": "Epoch timestamp for the end of task"
107 },
108 "location": {
109 "type": "object",
110 "description": "Location at start of task",
111 "properties": {
112 "latitude": {
113 "type": "string",
114 "description": "Latitude"
115 },
116 "longitude": {
117 "type": "string",
118 "description": "Longitude"
119 }
120 }
121 },
122 "userDetails": {
123 "type": "string",
124 "description": "Unique identifier of user performing the action"
125 }
126 }
127 }
128 },
129 "required": ["success"]
130 },
131 "canMerge": false
132}
JSON
1{
2 "name": "Pick",
3 "entityCode": "0009",
4 "description": "Pick (Execution Task) is when the inventory transfer is Receivables (In). This is used to maintain track of ownership of goods and cash",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Logistics"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "items": {
15 "title": "Items",
16 "description": "Developers can use this attribute for their app user to add Package details - items to be picked.",
17 "type": "array",
18 "items": {
19 "type": "object",
20 "description": "Definition of line item",
21 "properties": {
22 "skuId": {
23 "title": "SKU ID",
24 "type": "string",
25 "description": "Shipment ID of the picked items."
26 },
27 "productDescription": {
28 "title": "Product Description",
29 "type": "string",
30 "description": "Developers can use this attribute to get the description of the shipment picked"
31 },
32 "count": {
33 "title": "Item Count",
34 "type": "number",
35 "description": "The count of items in a shipment picked. There can be more than one item in a shipment picked.",
36 "exclusiveMinimum": 0
37 }
38 },
39 "required": ["skuId"]
40 }
41 },
42 "title": {
43 "title": "Title",
44 "type": "string",
45 "description": "Title for the message to be displayed to the FE"
46 },
47 "message": {
48 "title": "Message",
49 "type": "string",
50 "description": "Actual instruction message body for the FE."
51 },
52 "confirmCustodyExchange": {
53 "title": "Confirm custody Exchange",
54 "type": "boolean",
55 "description": "Boolean key to validate the pickup of shipment by FE."
56 },
57 "canGoBack": {
58 "title": "Can go back",
59 "type": "boolean",
60 "description": "This attribute enables the developers to revert back to any of the previous ETs."
61 },
62 "applicableReasons": {
63 "title": "Applicable reasons",
64 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
65 "type": "object"
66 }
67 },
68 "required": ["items", "title", "applicableReasons"]
69 },
70 "output": {
71 "type": "object",
72 "properties": {
73 "success": {
74 "description": "Success flag for the operation performed by user",
75 "type": "boolean"
76 },
77 "eventCode": {
78 "type": "string",
79 "description": "Event code"
80 },
81 "reasonCode": {
82 "type": "string",
83 "description": "Reason code"
84 },
85 "remark": {
86 "type": "string",
87 "description": "Remark captured at time of delivery"
88 },
89 "meta": {
90 "type": "object",
91 "description": "Meta data related to execution of task",
92 "properties": {
93 "startTime": {
94 "type": "number",
95 "description": "Epoch timestamp for the start of task"
96 },
97 "endTime": {
98 "type": "number",
99 "description": "Epoch timestamp for the end of task"
100 },
101 "location": {
102 "type": "object",
103 "description": "Location at start of task",
104 "properties": {
105 "latitude": {
106 "type": "string",
107 "description": "Latitude"
108 },
109 "longitude": {
110 "type": "string",
111 "description": "Longitude"
112 }
113 }
114 },
115 "userDetails": {
116 "type": "string",
117 "description": "Unique identifier of user performing the action"
118 }
119 }
120 }
121 },
122 "required": ["success"]
123 },
124 "canMerge": false
125}
JSON
1{
2 "name": "VerifyInput",
3 "entityCode": "0020",
4 "description": "Ability to verify if the given input matches the response from an API or static value",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "anyOf": [
13 {
14 "type": "object",
15 "properties": {
16 "input": {
17 "title": "Input",
18 "description": "Input entered by user",
19 "type": ["string", "number"]
20 },
21 "value": {
22 "title": "Value",
23 "type": ["string", "number"],
24 "description": "Value of the relevant input"
25 },
26 "title": {
27 "title": "Title",
28 "type": "string",
29 "description": "Title for the message to be displayed to the FE"
30 },
31 "message": {
32 "title": "Message",
33 "type": "string",
34 "description": "The instruction message body for the FE."
35 },
36 "canGoBack": {
37 "title": "Can go back",
38 "type": "boolean",
39 "description": "This attribute enables the developers to revert back to any of the previous ETs."
40 },
41 "applicableReasons": {
42 "title": "Applicable reasons",
43 "description": "Developers can use this attribute to provide the Applicable Reason code for moving from one ET to the next one.",
44 "type": "object"
45 }
46 },
47 "required": ["input", "value", "title", "applicableReasons"]
48 },
49 {
50 "type": "object",
51 "properties": {
52 "input": {
53 "title": "Input",
54 "description": "Input entered by user",
55 "type": ["string", "number"]
56 },
57 "api": {
58 "title": "API",
59 "type": "object",
60 "description": "Api",
61 "properties": {
62 "uri": {
63 "type": "string",
64 "title": "URI",
65 "description": "Verification api URI"
66 },
67 "headers": {
68 "type": "array",
69 "title": "Headers",
70 "description": "Verification api headers",
71 "items": {
72 "type": "object",
73 "properties": {
74 "key": {
75 "type": "string",
76 "title": "Header key"
77 },
78 "value": {
79 "type": "string",
80 "title": "Header value"
81 }
82 }
83 }
84 },
85 "valueJsonPath": {
86 "type": "string",
87 "title": "JSON path of value",
88 "description": "Json path of value to be matched"
89 }
90 },
91 "required": ["uri", "valueJsonPath"]
92 },
93 "title": {
94 "title": "Title",
95 "type": "string",
96 "description": "Title of instruction"
97 },
98 "message": {
99 "title": "Message",
100 "type": "string",
101 "description": "Message of instruction"
102 },
103 "canGoBack": {
104 "title": "Can go back",
105 "type": "boolean",
106 "description": "Can go back"
107 },
108 "applicableReasons": {
109 "title": "Applicable reasons",
110 "description": "applicable reason codes",
111 "type": "object"
112 }
113 },
114 "required": ["input", "api", "title", "applicableReasons"]
115 }
116 ]
117 },
118 "output": {
119 "type": "object",
120 "properties": {
121 "success": {
122 "description": "Boolean to represent result of verification",
123 "type": "boolean"
124 },
125 "eventCode": {
126 "type": "string",
127 "description": "Event code"
128 },
129 "reasonCode": {
130 "type": "string",
131 "description": "Reason code"
132 },
133 "meta": {
134 "type": "object",
135 "description": "Meta data related to execution of task",
136 "properties": {
137 "startTime": {
138 "type": "number",
139 "description": "Epoch timestamp for the start of task"
140 },
141 "endTime": {
142 "type": "number",
143 "description": "Epoch timestamp for the end of task"
144 },
145 "location": {
146 "type": "object",
147 "description": "Location at start of task",
148 "properties": {
149 "latitude": {
150 "type": "string",
151 "description": "Latitude"
152 },
153 "longitude": {
154 "type": "string",
155 "description": "Longitude"
156 }
157 }
158 },
159 "userDetails": {
160 "type": "string",
161 "description": "Unique identifier of user performing the action"
162 }
163 }
164 }
165 },
166 "required": ["success"]
167 },
168 "canMerge": false
169}
JSON
1{
2 "name": "CaptureImage",
3 "entityCode": "0011",
4 "description": "To capture an image",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "resolution": {
15 "title": "Resolution",
16 "description": "The preferred resolution for capturing an image of the shipment.",
17 "type": "object",
18 "properties": {
19 "length": {
20 "title": "Length",
21 "description": "Length of the image in pixels",
22 "type": "number",
23 "exclusiveMinimum": 0
24 },
25 "breadth": {
26 "title": "Breadth",
27 "description": "Breadth of the image in pixels",
28 "type": "number",
29 "exclusiveMinimum": 0
30 }
31 },
32 "required": ["length", "breadth"]
33 },
34 "fileSizeLimit": {
35 "title": "Max file size",
36 "type": "number",
37 "description": "Developers can use this attribute to put Maximum Size limit (in KB) for an image of the shipment to be captured.",
38 "exclusiveMinimum": 0
39 },
40 "captureMode": {
41 "title": "Capture Mode",
42 "description": "By using this attribute developers can allow an FE to capture one or more images of the shipment.",
43 "type": "string",
44 "enum": ["SINGLE", "MULTI"]
45 },
46 "captureCountLimit": {
47 "title": "Max image count",
48 "type": "number",
49 "description": "Developers can put limitation on number of images that can be captured in multi-capture mode for the shipment/s using this attribute.",
50 "minimum": 1
51 },
52 "title": {
53 "title": "Title",
54 "type": "string",
55 "description": "Title for the message to be displayed to the FE"
56 },
57 "message": {
58 "title": "Message",
59 "type": "string",
60 "description": "Actual instruction message body for the FE."
61 },
62 "canGoBack": {
63 "title": "Can go back",
64 "type": "boolean",
65 "description": "This attribute enables the developers to revert back to any of the previous ETs."
66 },
67 "applicableReasons": {
68 "title": "Applicable reasons",
69 "description": "Developers can use this attribute to provide the Applicable Reason code for moving from one ET to the next one.",
70 "type": "object"
71 }
72 },
73 "required": [
74 "resolution",
75 "fileSizeLimit",
76 "captureMode",
77 "title",
78 "applicableReasons"
79 ]
80 },
81 "output": {
82 "type": "object",
83 "properties": {
84 "success": {
85 "description": "Success flag for the operation performed by user",
86 "type": "boolean"
87 },
88 "captures": {
89 "type": "array",
90 "description": "Array of captured images",
91 "items": {
92 "type": "object",
93 "description": "Object to describe details of single image",
94 "properties": {
95 "url": {
96 "type": "string",
97 "description": "Url of image"
98 },
99 "timestamp": {
100 "type": "number",
101 "description": "Epoch timestamp for the image capture"
102 },
103 "file": {
104 "type": "object",
105 "description": "details of file",
106 "properties": {
107 "folder": {
108 "type": "string",
109 "description": "folder name"
110 },
111 "name": {
112 "type": "string",
113 "description": "name of the file"
114 }
115 }
116 }
117 },
118 "required": ["url", "timestamp"]
119 }
120 },
121 "eventCode": {
122 "type": "string",
123 "description": "Event code"
124 },
125 "reasonCode": {
126 "type": "string",
127 "description": "Reason code"
128 },
129 "meta": {
130 "type": "object",
131 "description": "Meta data related to execution of task",
132 "properties": {
133 "startTime": {
134 "type": "number",
135 "description": "Epoch timestamp for the start of task"
136 },
137 "endTime": {
138 "type": "number",
139 "description": "Epoch timestamp for the end of task"
140 },
141 "location": {
142 "type": "object",
143 "description": "Location at start of task",
144 "properties": {
145 "latitude": {
146 "type": "string",
147 "description": "Latitude"
148 },
149 "longitude": {
150 "type": "string",
151 "description": "Longitude"
152 }
153 }
154 },
155 "userDetails": {
156 "type": "string",
157 "description": "Unique identifier of user performing the action"
158 }
159 }
160 }
161 },
162 "required": ["success"]
163 },
164 "canMerge": false
165}
JSON
1{
2 "name": "CaptureInput",
3 "entityCode": "0012",
4 "description": "Ability to capture a number or string input",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "inputType": {
15 "title": "Input Data type",
16 "description": "Developers can declare the type of Data input by using this attribute (String, Boolean, etc).",
17 "type": "string",
18 "enum": ["string", "number"]
19 },
20 "validationRegex": {
21 "title": "Validation Regex",
22 "type": "string",
23 "description": "Validation for the format of input data type."
24 },
25 "title": {
26 "title": "Title",
27 "type": "string",
28 "description": "Title for the message to be displayed to the FE"
29 },
30 "message": {
31 "title": "Message",
32 "type": "string",
33 "description": "Actual instruction message body for the FE."
34 },
35 "canGoBack": {
36 "title": "Can go back",
37 "type": "boolean",
38 "description": "This attribute enables the developers to revert back to any of the previous ETs."
39 },
40 "applicableReasons": {
41 "title": "Applicable reasons",
42 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
43 "type": "object"
44 }
45 },
46 "required": ["inputType", "validationRegex", "title", "applicableReasons"]
47 },
48 "output": {
49 "type": "object",
50 "properties": {
51 "success": {
52 "description": "Success flag for the operation performed by user",
53 "type": "boolean"
54 },
55 "eventCode": {
56 "type": "string",
57 "description": "Event code"
58 },
59 "reasonCode": {
60 "type": "string",
61 "description": "Reason code"
62 },
63 "value": {
64 "description": "Value entered by user",
65 "type": ["string", "number"]
66 },
67 "validated": {
68 "type": "boolean",
69 "description": "Boolean to denote if value was validate successfully"
70 },
71 "attemptCount": {
72 "type": "number",
73 "description": "Number of attempts for this ET"
74 },
75 "meta": {
76 "type": "object",
77 "description": "Meta data related to execution of task",
78 "properties": {
79 "startTime": {
80 "type": "number",
81 "description": "Epoch timestamp for the start of task"
82 },
83 "endTime": {
84 "type": "number",
85 "description": "Epoch timestamp for the end of task"
86 },
87 "location": {
88 "type": "object",
89 "description": "Location at start of task",
90 "properties": {
91 "latitude": {
92 "type": "string",
93 "description": "Latitude"
94 },
95 "longitude": {
96 "type": "string",
97 "description": "Longitude"
98 }
99 }
100 },
101 "userDetails": {
102 "type": "string",
103 "description": "Unique identifier of user performing the action"
104 }
105 }
106 }
107 },
108 "required": ["success"]
109 },
110 "canMerge": false
111}
JSON
1{
2 "name": "Deliver",
3 "entityCode": "0010",
4 "description": "Deliver (Execution Task) is when the inventory transfer is Payables (Out)",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Logistics"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "items": {
15 "title": "Items",
16 "description": "This attribute can be used by the developers to show the list of items to be delivered by FE.",
17 "type": "array",
18 "items": {
19 "type": "object",
20 "description": "Definition of line item",
21 "properties": {
22 "skuId": {
23 "title": "SKU ID",
24 "type": "string",
25 "description": "Shipment ID of the deliverable items."
26 },
27 "productDescription": {
28 "title": "Product Description",
29 "type": "string",
30 "description": "Developers can use this attribute to show the description of the shipment delivered"
31 },
32 "count": {
33 "title": "Item Count",
34 "type": "number",
35 "description": "The count of items in a shipment delivered. There can be more than one item in a shipment delivered.",
36 "exclusiveMinimum": 0
37 }
38 },
39 "required": [
40 "skuId"
41 ]
42 }
43 },
44 "title": {
45 "title": "Title",
46 "type": "string",
47 "description": "Title for the message to be displayed to the FE"
48 },
49 "message": {
50 "title": "Message",
51 "type": "string",
52 "description": "Developers can use this attribute to show the actual instruction message to the FE."
53 },
54 "confirmCustodyExchange": {
55 "title": "Confirm custody Exchange",
56 "type": "boolean",
57 "description": "Boolean key to validate the delivery of the shipment by FE."
58 },
59 "confirmShipments": {
60 "title": "Confirm shipments",
61 "type": "boolean",
62 "description": "Boolean key to validate the number of the shipment delivered by FE."
63 },
64 "canGoBack": {
65 "title": "Can go back",
66 "type": "boolean",
67 "description": "This attribute enables the developers to revert back to any of the previous ETs."
68 },
69 "applicableReasons": {
70 "title": "Applicable reasons",
71 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
72 "type": "object"
73 }
74 },
75 "required": [
76 "items",
77 "title",
78 "applicableReasons"
79 ]
80 },
81 "output": {
82 "type": "object",
83 "properties": {
84 "success": {
85 "description": "Success flag for the operation performed by user",
86 "type": "boolean"
87 },
88 "remark": {
89 "type": "string",
90 "description": "Remark captured at time of delivery"
91 },
92 "eventCode": {
93 "type": "string",
94 "description": "Event code"
95 },
96 "reasonCode": {
97 "type": "string",
98 "description": "Reason code"
99 },
100 "meta": {
101 "type": "object",
102 "description": "Meta data related to execution of task",
103 "properties": {
104 "startTime": {
105 "type": "number",
106 "description": "Epoch timestamp for the start of task"
107 },
108 "endTime": {
109 "type": "number",
110 "description": "Epoch timestamp for the end of task"
111 },
112 "location": {
113 "type": "object",
114 "description": "Location at start of task",
115 "properties": {
116 "latitude": {
117 "type": "string",
118 "description": "Latitude"
119 },
120 "longitude": {
121 "type": "string",
122 "description": "Longitude"
123 }
124 }
125 },
126 "userDetails": {
127 "type": "string",
128 "description": "Unique identifier of user performing the action"
129 }
130 }
131 }
132 },
133 "required": [
134 "success"
135 ]
136 },
137 "canMerge": false
138}
JSON
1{
2 "name": "Display",
3 "entityCode": "0013",
4 "description": "Ability to display an alert message, information, warning, etc to the operator.",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "displayType": {
15 "title": "Display Type",
16 "description": "Developers can use this attribute to show the 'ALERT', 'WARNING', 'MESSAGE', etc. in th UI to the FE.",
17 "type": "string",
18 "enum": ["ALERT", "WARNING", "MESSAGE"]
19 },
20 "text": {
21 "title": "Display Text",
22 "type": "string",
23 "description": "Actual text to be displayed on the screen of an FE with the associated displayType."
24 },
25 "image": {
26 "title": "Display Image URL",
27 "description": "URL of the image to be displayed along associated with the displayType.",
28 "type": "string"
29 },
30 "title": {
31 "title": "Title",
32 "type": "string",
33 "description": "Title for the message to be displayed to the FE"
34 },
35 "message": {
36 "title": "Message",
37 "type": "string",
38 "description": "Actual instruction message body for the FE."
39 },
40 "canGoBack": {
41 "title": "Can go back",
42 "type": "boolean",
43 "description": "This attribute enables the developers to revert back to any of the previous ETs."
44 },
45 "applicableReasons": {
46 "title": "Applicable reasons",
47 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
48 "type": "object"
49 }
50 },
51 "required": ["displayType", "text", "title", "applicableReasons"]
52 },
53 "output": {
54 "type": "object",
55 "properties": {
56 "success": {
57 "description": "Success flag for the operation performed by user",
58 "type": "boolean"
59 },
60 "eventCode": {
61 "type": "string",
62 "description": "Event code"
63 },
64 "reasonCode": {
65 "type": "string",
66 "description": "Reason code"
67 },
68 "meta": {
69 "type": "object",
70 "description": "Meta data related to execution of task",
71 "properties": {
72 "startTime": {
73 "type": "number",
74 "description": "Epoch timestamp for the start of task"
75 },
76 "endTime": {
77 "type": "number",
78 "description": "Epoch timestamp for the end of task"
79 },
80 "location": {
81 "type": "object",
82 "description": "Location at start of task",
83 "properties": {
84 "latitude": {
85 "type": "string",
86 "description": "Latitude"
87 },
88 "longitude": {
89 "type": "string",
90 "description": "Longitude"
91 }
92 }
93 },
94 "userDetails": {
95 "type": "string",
96 "description": "Unique identifier of user performing the action"
97 }
98 }
99 }
100 },
101 "required": ["success"]
102 },
103 "canMerge": false
104}
JSON
1{
2 "name": "Doodle",
3 "entityCode": "0014",
4 "description": "To capture digital signature (fingertip trace)",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "resolution": {
15 "title": "Resolution",
16 "description": "The preferred resolution for doodle image to be captured.",
17 "type": "object",
18 "properties": {
19 "length": {
20 "title": "Length",
21 "description": "Length of the image in pixels",
22 "type": "number",
23 "exclusiveMinimum": 0
24 },
25 "breadth": {
26 "title": "Breadth",
27 "description": "Breadth of the image in pixels",
28 "type": "number",
29 "exclusiveMinimum": 0
30 }
31 },
32 "required": ["length", "breadth"]
33 },
34 "fileSizeLimit": {
35 "title": "Max file size",
36 "type": "number",
37 "description": "Developers can use this attribute to put Maximum Size limit (in KB) for a doodle image to be captured.",
38 "exclusiveMinimum": 0
39 },
40 "penColor": {
41 "title": "Pen color",
42 "type": "string",
43 "description": "Hex code for selection of pen color for capturing signature of the shipment receiver.",
44 "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
45 },
46 "title": {
47 "title": "Title",
48 "type": "string",
49 "description": "Title for the message to be displayed to the FE"
50 },
51 "message": {
52 "title": "Message",
53 "type": "string",
54 "description": "Actual instruction message body for the FE."
55 },
56 "canGoBack": {
57 "title": "Can go back",
58 "type": "boolean",
59 "description": "This attribute enables the developers to revert back to any of the previous ETs."
60 },
61 "applicableReasons": {
62 "title": "Applicable reasons",
63 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
64 "type": "object"
65 }
66 },
67 "required": ["resolution", "fileSizeLimit", "title", "applicableReasons"]
68 },
69 "output": {
70 "type": "object",
71 "properties": {
72 "success": {
73 "description": "Success flag for the operation performed by user",
74 "type": "boolean"
75 },
76 "eventCode": {
77 "type": "string",
78 "description": "Event code"
79 },
80 "reasonCode": {
81 "type": "string",
82 "description": "Reason code"
83 },
84 "url": {
85 "type": "string",
86 "description": "Url of doodle image"
87 },
88 "meta": {
89 "type": "object",
90 "description": "Meta data related to execution of task",
91 "properties": {
92 "startTime": {
93 "type": "number",
94 "description": "Epoch timestamp for the start of task"
95 },
96 "endTime": {
97 "type": "number",
98 "description": "Epoch timestamp for the end of task"
99 },
100 "location": {
101 "type": "object",
102 "description": "Location at start of task",
103 "properties": {
104 "latitude": {
105 "type": "string",
106 "description": "Latitude"
107 },
108 "longitude": {
109 "type": "string",
110 "description": "Longitude"
111 }
112 }
113 },
114 "userDetails": {
115 "type": "string",
116 "description": "Unique identifier of user performing the action"
117 }
118 }
119 },
120 "file": {
121 "type": "object",
122 "description": "details of file",
123 "properties": {
124 "folder": {
125 "type": "string",
126 "description": "folder name"
127 },
128 "name": {
129 "type": "string",
130 "description": "name of the file"
131 }
132 }
133 }
134 },
135 "required": ["success"]
136 },
137 "canMerge": false
138}
JSON
1{
2 "name": "DeliverCash",
3 "entityCode": "0022",
4 "description": "Ability to deposit cash",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "expectedAmount": {
15 "title": "Amount",
16 "description": "Show the data as per the scan if it is an online payment",
17 "type": "object",
18 "properties": {
19 "value": {
20 "title": "Amount",
21 "description": "Value of the amount to be delivered by the FE.",
22 "type": "number",
23 "minimum": 0
24 },
25 "currencyCode": {
26 "title": "Currency code",
27 "description": "Standard alpha codes and numeric codes for the representation of currencies.",
28 "type": "string",
29 "minLength": 3,
30 "maxLength": 3
31 },
32 "minorUnit": {
33 "title": "Minor Code",
34 "description": "Standard minor unit code of the currency.",
35 "type": "number",
36 "minimum": 0,
37 "maximum": 5
38 }
39 },
40 "required": [
41 "value",
42 "currencyCode"
43 ]
44 },
45 "title": {
46 "title": "Title",
47 "type": "string",
48 "description": "Title for the message to be displayed to the FE"
49 },
50 "message": {
51 "title": "Message",
52 "type": "string",
53 "description": "Actual instruction message body for the FE."
54 },
55 "canGoBack": {
56 "title": "Can go back",
57 "type": "boolean",
58 "description": "This attribute enables the developers to revert back to any of the previous ETs."
59 },
60 "confirmCustodyExchange": {
61 "title": "confirm custody exchange",
62 "type": "boolean",
63 "description": "Validate the delivery of cash by FE."
64 },
65 "confirmAmount": {
66 "title": "confirm amount",
67 "type": "boolean",
68 "description": "Developers can use this attribute if amount dropped needs to be confirmed."
69 },
70 "applicableReasons": {
71 "title": "Applicable reasons",
72 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
73 "type": "object"
74 }
75 },
76 "required": [
77 "expectedAmount",
78 "title",
79 "confirmCustodyExchange",
80 "applicableReasons"
81 ]
82 },
83 "output": {
84 "type": "object",
85 "properties": {
86 "success": {
87 "description": "Success flag for the operation performed by user",
88 "type": "boolean"
89 },
90 "amount": {
91 "description": "Amount collected (ISO 4217)",
92 "type": "object",
93 "properties": {
94 "value": {
95 "title": "Amount",
96 "description": "Amount collected",
97 "type": "number",
98 "minimum": 0
99 },
100 "currencyCode": {
101 "title": "Currency code",
102 "description": "Currency code in ISO 4217",
103 "type": "string",
104 "minLength": 3,
105 "maxLength": 3
106 },
107 "minorUnit": {
108 "title": "Minor Code",
109 "description": "Currency minor code in ISO 4217",
110 "type": "number",
111 "minimum": 0,
112 "maximum": 5
113 }
114 },
115 "required": [
116 "value",
117 "currencyCode"
118 ]
119 },
120 "eventCode": {
121 "type": "string",
122 "description": "Event code"
123 },
124 "reasonCode": {
125 "type": "string",
126 "description": "Reason code"
127 },
128 "meta": {
129 "type": "object",
130 "description": "Meta data related to execution of task",
131 "properties": {
132 "startTime": {
133 "type": "number",
134 "description": "Epoch timestamp for the start of task"
135 },
136 "endTime": {
137 "type": "number",
138 "description": "Epoch timestamp for the end of task"
139 },
140 "location": {
141 "type": "object",
142 "description": "Location at start of task",
143 "properties": {
144 "latitude": {
145 "type": "string",
146 "description": "Latitude"
147 },
148 "longitude": {
149 "type": "string",
150 "description": "Longitude"
151 }
152 }
153 },
154 "userDetails": {
155 "type": "string",
156 "description": "Unique identifier of user performing the action"
157 }
158 }
159 }
160 },
161 "required": [
162 "success",
163 "mode",
164 "transactionId"
165 ]
166 },
167 "canMerge": false
168}
JSON
1{
2 "name": "Form",
3 "entityCode": "0015",
4 "description": "To collect different information in different formats",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "jsonSchema": {
15 "title": "JSON Schema",
16 "description": "Using this attribute developers can create a form.",
17 "type": "object"
18 },
19 "uiSchema": {
20 "title": "UI Schame",
21 "description": "Develoeprs can set what all should be shown on UI screen in the form",
22 "type": "object"
23 },
24 "title": {
25 "title": "Title",
26 "type": "string",
27 "description": "Title for the message to be displayed to the FE"
28 },
29 "message": {
30 "title": "Message",
31 "type": "string",
32 "description": "Actual instruction message body for the FE."
33 },
34 "canGoBack": {
35 "title": "Can go back",
36 "type": "boolean",
37 "description": "This attribute enables the developers to revert back to any of the previous ETs."
38 },
39 "applicableReasons": {
40 "title": "Applicable reasons",
41 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
42 "type": "object"
43 }
44 },
45 "required": ["jsonSchema", "uiSchema", "title", "applicableReasons"]
46 },
47 "output": {
48 "type": "object",
49 "properties": {
50 "success": {
51 "description": "Success flag for the operation performed by user",
52 "type": "boolean"
53 },
54 "data": {
55 "description": "Data returned from user input",
56 "type": "object"
57 },
58 "eventCode": {
59 "type": "string",
60 "description": "Event code"
61 },
62 "reasonCode": {
63 "type": "string",
64 "description": "Reason code"
65 },
66 "meta": {
67 "type": "object",
68 "description": "Meta data related to execution of task",
69 "properties": {
70 "startTime": {
71 "type": "number",
72 "description": "Epoch timestamp for the start of task"
73 },
74 "endTime": {
75 "type": "number",
76 "description": "Epoch timestamp for the end of task"
77 },
78 "location": {
79 "type": "object",
80 "description": "Location at start of task",
81 "properties": {
82 "latitude": {
83 "type": "string",
84 "description": "Latitude"
85 },
86 "longitude": {
87 "type": "string",
88 "description": "Longitude"
89 }
90 }
91 },
92 "userDetails": {
93 "type": "string",
94 "description": "Unique identifier of user performing the action"
95 }
96 }
97 }
98 },
99 "required": ["success", "data"]
100 },
101 "canMerge": false
102}
JSON
1{
2 "name": "Scan",
3 "entityCode": "0016",
4 "description": "To scan a barcode or QR code",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "defaultERC": {
15 "title": "Default Event Reason Code",
16 "type": "object",
17 "description": "This attribute is used for determining the Unscanned shipments.",
18 "required": ["eventCode", "reasonCode"],
19 "properties": {
20 "eventCode": {
21 "title": "Event Code",
22 "description": "This attribute is used to enable the developer to set default event code.",
23 "type": "string"
24 },
25 "reasonCode": {
26 "title": "Reason Code",
27 "description": "This attribute is used to enable the developer to set default reason code",
28 "type": "string"
29 }
30 }
31 },
32 "ercSelector": {
33 "title": "Event/Reason Code Selector",
34 "description": "FE will select the ERC (Event and Reason Code) from the dropdown displayed and using this attribute developer can enable an FE to do so.",
35 "type": "array",
36 "items": {
37 "type": "object",
38 "required": ["eventCode", "reasonCode"],
39 "properties": {
40 "eventCode": {
41 "title": "Event Code",
42 "description": "This attribute is used to enable the developer to set default event code.",
43 "type": "string"
44 },
45 "reasonCode": {
46 "title": "Reason Code",
47 "description": "This attribute is used to enable the developer to set default reason code",
48 "type": "array",
49 "items": {
50 "type": "string"
51 },
52 "uniqueItems": true
53 }
54 }
55 }
56 },
57 "scannedInput": {
58 "title": "Scanned Input",
59 "type": "object",
60 "description": "This attribute is used by developers to set the type for scanned inputs. The type of scan to be expected.",
61 "properties": {
62 "scanType": {
63 "title": "Scan Type",
64 "description": "Type of scan",
65 "type": "array",
66 "uniqueItems": true,
67 "items": {
68 "type": "string",
69 "enum": [
70 "QRCODE",
71 "aztec",
72 "codabar",
73 "code39",
74 "code93",
75 "code128",
76 "datamatrix",
77 "ean13",
78 "ean8",
79 "itf14",
80 "pdf417",
81 "upc_e"
82 ]
83 }
84 }
85 },
86 "required": ["scanType"]
87 },
88 "scanMode": {
89 "title": "Scan Mode",
90 "description": "Using this attribute developers can help the user to select the scan mode of Shipments to be delivered/Picked.",
91 "type": "string",
92 "enum": ["SINGLE", "MULTI"]
93 },
94 "scanCountLimit": {
95 "title": "Max scan count",
96 "type": "number",
97 "description": "This attributes helps the developers to set the maximum limit of the items to be scanned in multi-scan mode.",
98 "minimum": 1
99 },
100 "validation": {
101 "title": "Validation",
102 "type": "object",
103 "description": "Regex to validate scanned strings",
104 "properties": {
105 "selectedIndex": {
106 "title": "Selected Index",
107 "description": "This attribute helps the developers to define the type of index selection that can be used.",
108 "type": "number",
109 "default": 0,
110 "minimum": 0,
111 "maximum": 2
112 },
113 "logic": {
114 "title": "Validation Logic",
115 "description": "This attribute is used by the developers to provide the logic for the selected index.",
116 "anyOf": [
117 {
118 "title": "Scans",
119 "minItems": 1,
120 "maxItems": 100,
121 "uniqueItems": true,
122 "type": "array",
123 "description": "List of items to be scanned",
124 "items": {
125 "type": "string",
126 "description": "ID of items to be scanned"
127 }
128 },
129 {
130 "title": "Validation Regex",
131 "type": "string",
132 "description": "Regex to validate scanned strings"
133 },
134 {
135 "title": "Validation API",
136 "type": "object",
137 "description": "API to validate scanned items from.",
138 "properties": {
139 "uri": {
140 "type": "string",
141 "title": "URI",
142 "description": "HTTP API url"
143 },
144 "timeout": {
145 "type": "number",
146 "title": "Timeout for API",
147 "description": "The time after which request will be canceled",
148 "default": 15
149 },
150 "httpMethod": {
151 "title": "HTTP Method",
152 "description": "HTTP Method",
153 "type": "string",
154 "enum": ["PUT", "POST", "GET"]
155 },
156 "headers": {
157 "type": "array",
158 "title": "Headers",
159 "description": "API headers",
160 "items": {
161 "type": "object",
162 "properties": {
163 "key": {
164 "type": "string",
165 "title": "Header key"
166 },
167 "value": {
168 "type": "string",
169 "title": "Header value"
170 }
171 }
172 }
173 },
174 "requestBody": {
175 "type": "object",
176 "title": "HTTP Request Body",
177 "description": "request body object"
178 },
179 "queryParams": {
180 "type": "array",
181 "title": "HTTP Query param",
182 "description": "Query param for request",
183 "items": {
184 "type": "object",
185 "properties": {
186 "key": {
187 "type": "string",
188 "title": "Query key"
189 },
190 "value": {
191 "type": "string",
192 "title": "Query value"
193 }
194 }
195 }
196 },
197 "pathParams": {
198 "type": "array",
199 "title": "HTTP Path param",
200 "description": "Path param for request",
201 "items": {
202 "type": "object",
203 "properties": {
204 "key": {
205 "type": "string",
206 "title": "Path key"
207 },
208 "value": {
209 "type": "string",
210 "title": "Path value"
211 }
212 }
213 }
214 },
215 "responseJsonLogic": {
216 "type": "object",
217 "title": "JSON logic",
218 "description": "Json path to extract the required output from API response"
219 },
220 "errorJsonLogic": {
221 "type": "object",
222 "title": "Json Path",
223 "description": "Json path to extract the required error response"
224 }
225 },
226 "required": [
227 "uri",
228 "httpMethod",
229 "responseJsonLogic",
230 "errorJsonLogic"
231 ]
232 }
233 ]
234 }
235 },
236 "required": ["selectedIndex", "logic"]
237 },
238 "exitOnError": {
239 "title": "Exit on Error",
240 "type": "boolean",
241 "description": "This attribute can be used by the developer to drop the workflow if the scan fails."
242 },
243 "title": {
244 "title": "Title",
245 "type": "string",
246 "description": "Title for the message to be displayed to the FE."
247 },
248 "message": {
249 "title": "Message",
250 "type": "string",
251 "description": "Message of instruction"
252 },
253 "canGoBack": {
254 "title": "Can go back",
255 "type": "boolean",
256 "description": "Can go back"
257 },
258 "applicableReasons": {
259 "title": "Applicable reasons",
260 "description": "applicable reason codes",
261 "type": "object"
262 },
263 "additionalMultiConfig": {
264 "title": "Additional MultiConfig",
265 "description": "This attribute holds additional inputs for developer to provide with exitOnError attribute.",
266 "type": "object",
267 "properties": {
268 "validationType": {
269 "title": "Validation Type",
270 "description": "This attribute can be used by developer to set the validation type for the FE before the FE moves to next ET.",
271 "type": "string",
272 "enum": ["ALL_OR_NONE", "SUBSET_OF_LIST"]
273 }
274 },
275 "required": ["validationType"]
276 }
277 },
278 "required": [
279 "defaultERC",
280 "scannedInput",
281 "scanMode",
282 "title",
283 "applicableReasons",
284 "validation"
285 ]
286 },
287 "output": {
288 "type": "object",
289 "properties": {
290 "success": {
291 "description": "Success flag for the operation performed by user",
292 "type": "boolean"
293 },
294 "eventCode": {
295 "type": "string",
296 "description": "Event code"
297 },
298 "reasonCode": {
299 "type": "string",
300 "description": "Reason code"
301 },
302 "scans": {
303 "type": "array",
304 "description": "Array of scan objects",
305 "items": {
306 "type": "object",
307 "description": "Object to describe details of single scan",
308 "properties": {
309 "value": {
310 "type": "string",
311 "description": "Value of scanned item"
312 },
313 "validated": {
314 "type": "boolean",
315 "description": "Boolean to denote if scan was validate successfully"
316 },
317 "timestamp": {
318 "type": "number",
319 "description": "Epoch timestamp for the scan"
320 }
321 },
322 "required": ["value", "timestamp"]
323 }
324 },
325 "meta": {
326 "type": "object",
327 "description": "Meta data related to execution of task",
328 "properties": {
329 "startTime": {
330 "type": "number",
331 "description": "Epoch timestamp for the start of task"
332 },
333 "endTime": {
334 "type": "number",
335 "description": "Epoch timestamp for the end of task"
336 },
337 "location": {
338 "type": "object",
339 "description": "Location at start of task",
340 "properties": {
341 "latitude": {
342 "type": "string",
343 "description": "Latitude"
344 },
345 "longitude": {
346 "type": "string",
347 "description": "Longitude"
348 }
349 }
350 },
351 "userDetails": {
352 "type": "string",
353 "description": "Unique identifier of user performing the action"
354 }
355 }
356 }
357 },
358 "required": ["success", "scans"]
359 },
360 "canMerge": false,
361 "meta": {
362 "allowFailureFlow": false
363 }
364}
JSON
1{
2 "name": "Completed-Success",
3 "entityCode": "0007",
4 "description": "Ability to define if the terminal endpoint of a workflow is successful",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "canGoBack": {
15 "title": "Can go back",
16 "type": "boolean",
17 "description": "This attribute enables the developers to revert back to any of the previous ETs."
18 },
19 "applicableReasons": {
20 "title": "Applicable reasons",
21 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
22 "type": "object"
23 }
24 },
25 "required": ["applicableReasons"]
26 },
27 "output": {
28 "type": "object",
29 "properties": {
30 "success": {
31 "description": "Success flag for the operation performed by user",
32 "type": "boolean"
33 },
34 "eventCode": {
35 "type": "string",
36 "description": "Event code"
37 },
38 "reasonCode": {
39 "type": "string",
40 "description": "Reason code"
41 },
42 "lastEventCode": {
43 "type": "string",
44 "description": "Last Event code"
45 },
46 "lastReasonCode": {
47 "type": "string",
48 "description": "Last Reason code"
49 },
50 "meta": {
51 "type": "object",
52 "description": "Meta data related to execution of task",
53 "properties": {
54 "startTime": {
55 "type": "number",
56 "description": "Epoch timestamp for the start of task"
57 },
58 "endTime": {
59 "type": "number",
60 "description": "Epoch timestamp for the end of task"
61 },
62 "location": {
63 "type": "object",
64 "description": "Location at start of task",
65 "properties": {
66 "latitude": {
67 "type": "string",
68 "description": "Latitude"
69 },
70 "longitude": {
71 "type": "string",
72 "description": "Longitude"
73 }
74 }
75 },
76 "userDetails": {
77 "type": "string",
78 "description": "Unique identifier of user performing the action"
79 }
80 }
81 }
82 },
83 "required": ["success"]
84 },
85 "canMerge": false
86}
JSON
1{
2 "name": "Completed-Failure",
3 "entityCode": "0008",
4 "description": "Ability to define if the terminal endpoint of a workflow is failure",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "canGoBack": {
15 "title": "Can go back",
16 "type": "boolean",
17 "description": "This attribute enables the developers to revert back to any of the previous ETs."
18 },
19 "applicableReasons": {
20 "title": "Applicable reasons",
21 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
22 "type": "object"
23 }
24 },
25 "required": ["applicableReasons"]
26 },
27 "output": {
28 "type": "object",
29 "properties": {
30 "success": {
31 "description": "Success flag for the operation performed by user",
32 "type": "boolean"
33 },
34 "eventCode": {
35 "type": "string",
36 "description": "Event code"
37 },
38 "reasonCode": {
39 "type": "string",
40 "description": "Reason code"
41 },
42 "lastEventCode": {
43 "type": "string",
44 "description": "Last Event code"
45 },
46 "lastReasonCode": {
47 "type": "string",
48 "description": "Last Reason code"
49 },
50 "meta": {
51 "type": "object",
52 "description": "Meta data related to execution of task",
53 "properties": {
54 "startTime": {
55 "type": "number",
56 "description": "Epoch timestamp for the start of task"
57 },
58 "endTime": {
59 "type": "number",
60 "description": "Epoch timestamp for the end of task"
61 },
62 "location": {
63 "type": "object",
64 "description": "Location at start of task",
65 "properties": {
66 "latitude": {
67 "type": "string",
68 "description": "Latitude"
69 },
70 "longitude": {
71 "type": "string",
72 "description": "Longitude"
73 }
74 }
75 },
76 "userDetails": {
77 "type": "string",
78 "description": "Unique identifier of user performing the action"
79 }
80 }
81 }
82 },
83 "required": ["success"]
84 },
85 "canMerge": false
86}
JSON
1{
2 "name": "InitPayment",
3 "entityCode": "0017",
4 "description": "To instruct the app layer to initiate payment flow with payment data.",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "amount": {
15 "title": "Amount",
16 "description": "The amount to be displayed on the FE screen. Right now it is just cash.",
17 "type": "object",
18 "properties": {
19 "value": {
20 "title": "Amount",
21 "description": "Value of the amount to be collected by the FE.",
22 "type": "number",
23 "minimum": 0
24 },
25 "currencyCode": {
26 "title": "Currency code",
27 "description": "Standard alpha codes and numeric codes for the representation of currencies.",
28 "type": "string",
29 "minLength": 3,
30 "maxLength": 3
31 },
32 "minorUnit": {
33 "title": "Minor Code",
34 "description": "Standard minor unit code of the currency.",
35 "type": "number",
36 "minimum": 0,
37 "maximum": 5
38 }
39 },
40 "required": ["value", "currencyCode"]
41 },
42 "allowedModes": {
43 "title": "Allowed Modes list",
44 "type": "array",
45 "description": "This attribute allows developers to set the different modes of payments to be accepted. Example: Cash, Credit, etc.",
46 "items": {
47 "type": "string",
48 "enum": ["CASH", "UPI", "PAYMENT_LINK"]
49 },
50 "minItems": 1,
51 "uniqueItems": true
52 },
53 "title": {
54 "title": "Title",
55 "type": "string",
56 "description": "Title for the message to be displayed to the FE."
57 },
58 "message": {
59 "title": "Message",
60 "type": "string",
61 "description": "Actual instruction message body for the FE."
62 },
63 "canGoBack": {
64 "title": "Can go back",
65 "type": "boolean",
66 "description": "This attribute enables the developers to revert back to any of the previous ETs."
67 },
68 "applicableReasons": {
69 "title": "Applicable reasons",
70 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
71 "type": "object"
72 }
73 },
74 "required": ["amount", "allowedModes", "title", "applicableReasons"]
75 },
76 "output": {
77 "type": "object",
78 "properties": {
79 "success": {
80 "description": "Success flag for the operation performed by user",
81 "type": "boolean"
82 },
83 "transactionId": {
84 "description": "Unique transaction id",
85 "type": "string"
86 },
87 "paymentMode": {
88 "description": "Payment mode selected by user",
89 "type": "string",
90 "enum": ["CASH", "UPI", "PAYMENT_LINK"]
91 },
92 "eventCode": {
93 "type": "string",
94 "description": "Event code"
95 },
96 "reasonCode": {
97 "type": "string",
98 "description": "Reason code"
99 },
100 "meta": {
101 "type": "object",
102 "description": "Meta data related to execution of task",
103 "properties": {
104 "startTime": {
105 "type": "number",
106 "description": "Epoch timestamp for the start of task"
107 },
108 "endTime": {
109 "type": "number",
110 "description": "Epoch timestamp for the end of task"
111 },
112 "location": {
113 "type": "object",
114 "description": "Location at start of task",
115 "properties": {
116 "latitude": {
117 "type": "string",
118 "description": "Latitude"
119 },
120 "longitude": {
121 "type": "string",
122 "description": "Longitude"
123 }
124 }
125 },
126 "userDetails": {
127 "type": "string",
128 "description": "Unique identifier of user performing the action"
129 }
130 }
131 }
132 },
133 "required": ["success", "paymentMode", "transactionId"]
134 },
135 "canMerge": false
136}
JSON
1{
2 "name": "ProcessPayment",
3 "entityCode": "0018",
4 "description": "To process a payment and generate transaction IDs",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "amount": {
15 "title": "Amount",
16 "description": "This attribute allows the develoepr to show the data as per the scan if it is an online payment (UPI or other online payment method).",
17 "type": "object",
18 "properties": {
19 "value": {
20 "title": "Amount",
21 "description": "Value of the amount to be collected by the FE.",
22 "type": "number",
23 "minimum": 0
24 },
25 "currencyCode": {
26 "title": "Currency code",
27 "description": "Standard alpha codes and numeric codes for the representation of currencies.",
28 "type": "string",
29 "minLength": 3,
30 "maxLength": 3
31 },
32 "minorUnit": {
33 "title": "Minor Code",
34 "description": "Standard minor unit code of the currency.",
35 "type": "number",
36 "minimum": 0,
37 "maximum": 5
38 }
39 },
40 "required": ["value", "currencyCode"]
41 },
42 "paymentMode": {
43 "title": "Payment mode",
44 "description": "This attribute is used to the allowed payment modes - UPI, Credit Card, etc.",
45 "type": "string",
46 "enum": ["CASH", "UPI", "PAYMENT_LINK"]
47 },
48 "title": {
49 "title": "Title",
50 "type": "string",
51 "description": "Title of instruction"
52 },
53 "message": {
54 "title": "Message",
55 "type": "string",
56 "description": "Message of instruction"
57 },
58 "canGoBack": {
59 "title": "Can go back",
60 "type": "boolean",
61 "description": "Can go back"
62 },
63 "transactionId": {
64 "title": "transaction id",
65 "type": "string",
66 "description": "transaction id"
67 },
68 "applicableReasons": {
69 "title": "Applicable reasons",
70 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
71 "type": "object"
72 }
73 },
74 "required": [
75 "amount",
76 "paymentMode",
77 "title",
78 "transactionId",
79 "applicableReasons"
80 ]
81 },
82 "output": {
83 "type": "object",
84 "properties": {
85 "success": {
86 "description": "Success flag for the operation performed by user",
87 "type": "boolean"
88 },
89 "transactionId": {
90 "description": "Unique transaction id",
91 "type": "string"
92 },
93 "collectedAmount": {
94 "description": "Amount collected (ISO 4217)",
95 "type": "object",
96 "properties": {
97 "value": {
98 "title": "Amount",
99 "description": "Amount collected",
100 "type": "number",
101 "minimum": 0
102 },
103 "currencyCode": {
104 "title": "Currency code",
105 "description": "Currency code in ISO 4217",
106 "type": "string",
107 "minLength": 3,
108 "maxLength": 3
109 },
110 "minorUnit": {
111 "title": "Minor Code",
112 "description": "Currency minor code in ISO 4217",
113 "type": "number",
114 "minimum": 0,
115 "maximum": 5
116 }
117 },
118 "required": ["value", "currencyCode"]
119 },
120 "paymentMeta": {
121 "description": "Payment meta data",
122 "type": "object"
123 },
124 "eventCode": {
125 "type": "string",
126 "description": "Event code"
127 },
128 "reasonCode": {
129 "type": "string",
130 "description": "Reason code"
131 },
132 "meta": {
133 "type": "object",
134 "description": "Meta data related to execution of task",
135 "properties": {
136 "startTime": {
137 "type": "number",
138 "description": "Epoch timestamp for the start of task"
139 },
140 "endTime": {
141 "type": "number",
142 "description": "Epoch timestamp for the end of task"
143 },
144 "location": {
145 "type": "object",
146 "description": "Location at start of task",
147 "properties": {
148 "latitude": {
149 "type": "string",
150 "description": "Latitude"
151 },
152 "longitude": {
153 "type": "string",
154 "description": "Longitude"
155 }
156 }
157 },
158 "userDetails": {
159 "type": "string",
160 "description": "Unique identifier of user performing the action"
161 }
162 }
163 },
164 "paymentMode": {
165 "title": "Payment mode",
166 "description": "Payment mode",
167 "type": "string",
168 "enum": ["CASH", "UPI", "PAYMENT_LINK"]
169 }
170 },
171 "required": ["success", "collectedAmount", "transactionId", "paymentMode"]
172 },
173 "canMerge": false
174}
JSON
1{
2 "name": "CompletePayment",
3 "entityCode": "0019",
4 "description": "To record final details of payments (tenant payID, transaction ID, amount etc).",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "expectedAmount": {
15 "title": "Expected Amount",
16 "description": "By using this attribute developers can show the data of the complete payments.",
17 "type": "object",
18 "properties": {
19 "value": {
20 "title": "Amount",
21 "description": "Value of the complete amount.",
22 "type": "number",
23 "minimum": 0
24 },
25 "currencyCode": {
26 "title": "Currency code",
27 "description": "Standard alpha codes and numeric codes for the representation of currencies.",
28 "type": "string",
29 "minLength": 3,
30 "maxLength": 3
31 },
32 "minorUnit": {
33 "title": "Minor Code",
34 "description": "Standard minor unit code of the currency.",
35 "type": "number",
36 "minimum": 0,
37 "maximum": 5
38 }
39 },
40 "required": ["value", "currencyCode"]
41 },
42 "collectedAmount": {
43 "title": "Collected Amount",
44 "description": "This attributes can be used to enter the amount to be collected by the FE.",
45 "type": "object",
46 "properties": {
47 "value": {
48 "title": "Amount",
49 "description": "This attribute will help to enter the actual value of the amount to be collected.",
50 "type": "number",
51 "minimum": 0
52 },
53 "currencyCode": {
54 "title": "Currency code",
55 "description": "Standard alpha codes and numeric codes for the representation of currencies.",
56 "type": "string",
57 "minLength": 3,
58 "maxLength": 3
59 },
60 "minorUnit": {
61 "title": "Minor Code",
62 "description": "Standard minor unit code of the currency.",
63 "type": "number",
64 "minimum": 0,
65 "maximum": 5
66 }
67 },
68 "required": ["value", "currencyCode"]
69 },
70 "transactionId": {
71 "title": "Platform Transaction Id",
72 "description": "Developers can use this attribute to show the transaction Id of the payment. It is only used in case of online payment",
73 "type": "string"
74 },
75 "tenantTransactionId": {
76 "title": "Tenant Transaction Id",
77 "description": "Platform based internal transaction ID to keep the track of online transaction.",
78 "type": "string"
79 },
80 "title": {
81 "title": "Title",
82 "type": "string",
83 "description": "Title for the message to be displayed to the FE"
84 },
85 "message": {
86 "title": "Message",
87 "type": "string",
88 "description": "Actual instruction message body for the FE."
89 },
90 "canGoBack": {
91 "title": "Can go back",
92 "type": "boolean",
93 "description": "This attribute enables the developers to revert back to any of the previous ETs."
94 },
95 "paymentMode": {
96 "title": "Payment mode",
97 "description": "Payment mode",
98 "type": "string",
99 "enum": ["CASH", "UPI", "PAYMENT_LINK"]
100 },
101 "applicableReasons": {
102 "title": "Applicable reasons",
103 "description": "Developers can use this attribute to provide Applicable Reason code for moving from one ET to the next one.",
104 "type": "object"
105 }
106 },
107 "required": [
108 "expectedAmount",
109 "collectedAmount",
110 "transactionId",
111 "tenantTransactionId",
112 "title",
113 "paymentMode",
114 "applicableReasons"
115 ]
116 },
117 "output": {
118 "type": "object",
119 "properties": {
120 "success": {
121 "description": "Success flag for the operation performed by user",
122 "type": "boolean"
123 },
124 "eventCode": {
125 "type": "string",
126 "description": "Event code"
127 },
128 "reasonCode": {
129 "type": "string",
130 "description": "Reason code"
131 },
132 "meta": {
133 "type": "object",
134 "description": "Meta data related to execution of task",
135 "properties": {
136 "startTime": {
137 "type": "number",
138 "description": "Epoch timestamp for the start of task"
139 },
140 "endTime": {
141 "type": "number",
142 "description": "Epoch timestamp for the end of task"
143 },
144 "location": {
145 "type": "object",
146 "description": "Location at start of task",
147 "properties": {
148 "latitude": {
149 "type": "string",
150 "description": "Latitude"
151 },
152 "longitude": {
153 "type": "string",
154 "description": "Longitude"
155 }
156 }
157 },
158 "userDetails": {
159 "type": "string",
160 "description": "Unique identifier of user performing the action"
161 }
162 }
163 },
164 "paymentMode": {
165 "title": "Payment mode",
166 "description": "Payment mode",
167 "type": "string",
168 "enum": ["CASH", "UPI", "PAYMENT_LINK"]
169 },
170 "collectedAmount": {
171 "title": "Collected Amount",
172 "description": "Amount collected (ISO 4217)",
173 "type": "object",
174 "properties": {
175 "value": {
176 "title": "Amount",
177 "description": "Amount",
178 "type": "number",
179 "minimum": 0
180 },
181 "currencyCode": {
182 "title": "Currency code",
183 "description": "Currency code in ISO 4217",
184 "type": "string",
185 "minLength": 3,
186 "maxLength": 3
187 },
188 "minorUnit": {
189 "title": "Minor Code",
190 "description": "Currency minor code in ISO 4217",
191 "type": "number",
192 "minimum": 0,
193 "maximum": 5
194 }
195 },
196 "required": ["value", "currencyCode"]
197 }
198 },
199 "required": ["success", "paymentMode", "collectedAmount"]
200 },
201 "canMerge": false
202}
JSON
1{
2 "name": "ValidateOtp",
3 "entityCode": "0052",
4 "description": "Ability to capture and verify if the given input matches the response from an API or static value.",
5 "tag": [
6 {
7 "name": "usage",
8 "value": "Utility"
9 }
10 ],
11 "inputs": {
12 "type": "object",
13 "properties": {
14 "generationLogic": {
15 "title": "Logic for generation",
16 "description": "When do you want to generate the OTP.",
17 "type": "object",
18 "properties": {
19 "generateOnLoad": {
20 "title": "Generation on load",
21 "type": "boolean",
22 "description": "Generate OTP via FE device"
23 },
24 "api": {
25 "title": "API",
26 "type": "object",
27 "description": "Generation api",
28 "properties": {
29 "uri": {
30 "type": "string",
31 "title": "URI",
32 "description": "HTTP API url"
33 },
34 "timeout": {
35 "type": "number",
36 "title": "Timeout for API",
37 "description": "The time after which request will be canceled"
38 },
39 "httpMethod": {
40 "title": "HTTP Method",
41 "description": "HTTP Method",
42 "type": "string",
43 "enum": ["PUT", "POST", "GET"]
44 },
45 "headers": {
46 "type": "array",
47 "title": "Headers",
48 "description": "API headers",
49 "items": {
50 "type": "object",
51 "properties": {
52 "key": {
53 "type": "string",
54 "title": "Header key"
55 },
56 "value": {
57 "type": "string",
58 "title": "Header value"
59 }
60 }
61 }
62 },
63 "requestBody": {
64 "type": "object",
65 "title": "HTTP Request Body",
66 "description": "request body object"
67 },
68 "queryParams": {
69 "type": "array",
70 "title": "HTTP Query param",
71 "description": "Query param for request",
72 "items": {
73 "type": "object",
74 "properties": {
75 "key": {
76 "type": "string",
77 "title": "Query key"
78 },
79 "value": {
80 "type": "string",
81 "title": "Query value"
82 }
83 }
84 }
85 },
86 "pathParams": {
87 "type": "array",
88 "title": "HTTP Path param",
89 "description": "Path param for request",
90 "items": {
91 "type": "object",
92 "properties": {
93 "key": {
94 "type": "string",
95 "title": "Path key"
96 },
97 "value": {
98 "type": "string",
99 "title": "Path value"
100 }
101 }
102 }
103 },
104 "responseJsonLogic": {
105 "type": "object",
106 "title": "Response JSON logic",
107 "description": "Json path to extract the required output from API response"
108 },
109 "errorJsonLogic":