Show Dispatch Rule

GET

/dispatch/rules/%7Bdispatch_rule_id%7D

GET

/dispatch/rules/%7Bdispatch_rule_id%7D

1 curl https://https//https/dispatch/rules/%7Bdispatch_rule_id%7D \
2      -H "{{tenant_key_name}}: X-Tenant-ID" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
3   "name": "Urgent Delivery Rule",
4   "description": "Dispatch rule for urgent deliveries requiring immediate attention",
5   "isActive": true,
6   "conditions": [
7     {
8       "field": "priority",
9       "operator": "equals",
10       "value": "high"
11     },
12     {
13       "field": "packageWeight",
14       "operator": "less_than",
15       "value": 10
16     }
17   ],
18   "actions": [
19     {
20       "type": "assign_driver",
21       "parameters": {
22         "driverId": "driver_789"
23       }
24     },
25     {
26       "type": "send_notification",
27       "parameters": {
28         "message": "Urgent delivery assigned to you",
29         "channel": "sms"
30       }
31     }
32   ],
33   "createdAt": "2024-05-10T09:15:00Z",
34   "updatedAt": "2024-06-01T12:00:00Z"
35 }

Get details of a specific dispatch rule including its conditions, actions, and configuration.

Response

Successful response

Headers

Response