Get order event

GET

/shipping/orders/order_events/v1/:order_event_id

GET

/shipping/orders/order_events/v1/:order_event_id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.shipping.orders.orderEvents.getV1("order_event_id");
8 }
9 main();

1 {
2   "_id": "_id",
3   "action": "shipping.order.draft_started",
4   "actor": {
5     "org_id": "org_id",
6     "system": "shipping_state_sync",
7     "user_id": "user_id"
8   },
9   "order_id": "order_id",
10   "schema_version": 1,
11   "timestamp": "2024-01-15T09:30:00Z",
12   "entities": [
13     {
14       "account": {
15         "_id": "_id",
16         "created_by_org_id": "created_by_org_id",
17         "created_by_user_id": "created_by_user_id",
18         "name": "name",
19         "schema_version": 1
20       },
21       "cargo": {
22         "_id": "_id",
23         "cargo_type": "spare_parts",
24         "created_by_org_id": "created_by_org_id",
25         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
26         "order_id": "order_id",
27         "order_short_id": "order_short_id",
28         "schema_version": 1
29       },
30       "contact": {
31         "_id": "_id",
32         "created_by_org_id": "created_by_org_id",
33         "name": "name",
34         "schema_version": 1
35       },
36       "modification": {
37         "key": "value"
38       },
39       "order": {
40         "_id": "_id",
41         "created_by_org_id": "created_by_org_id",
42         "created_by_user_id": "created_by_user_id",
43         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
44         "schema_version": 1,
45         "short_id": "short_id"
46       },
47       "task": {
48         "_id": "_id",
49         "created_by_org_id": "created_by_org_id",
50         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
51         "order_id": "order_id",
52         "order_short_id": "order_short_id",
53         "schema_version": 1,
54         "task_group_id": "task_group_id"
55       },
56       "task_artifact": {
57         "_id": "_id",
58         "created_by_org_id": "created_by_org_id",
59         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
60         "order_id": "order_id",
61         "order_short_id": "order_short_id",
62         "schema_version": 1,
63         "task_group_id": "task_group_id",
64         "task_id": "task_id",
65         "type": "image"
66       },
67       "task_artifact_s3_object_metadata": {
68         "_id": "_id",
69         "schema_version": 1,
70         "task_artifact_id": "task_artifact_id",
71         "uploaded_at_timestamp": "2024-01-15T09:30:00Z",
72         "uploaded_by_org_id": "uploaded_by_org_id",
73         "uploaded_by_user_id": "uploaded_by_user_id"
74       },
75       "task_group": {
76         "_id": "_id",
77         "created_by_org_id": "created_by_org_id",
78         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
79         "order_id": "order_id",
80         "order_short_id": "order_short_id",
81         "schema_version": 1,
82         "task_group_type": "chrt_ground_provider"
83       },
84       "task_group_s3_object_metadata": {
85         "_id": "_id",
86         "schema_version": 1,
87         "task_group_id": "task_group_id",
88         "uploaded_at_timestamp": "2024-01-15T09:30:00Z",
89         "uploaded_by_org_id": "uploaded_by_org_id",
90         "uploaded_by_user_id": "uploaded_by_user_id"
91       }
92     }
93   ],
94   "order_short_id": "order_short_id",
95   "org_public_data": {
96     "_id": "_id",
97     "name": "name",
98     "org_id": "org_id",
99     "org_type": "provider",
100     "schema_version": 1,
101     "description": "description",
102     "email_address": "email_address",
103     "handle": "handle",
104     "industry": "industry",
105     "phone_number": "phone_number",
106     "street_address": {
107       "geometry": {
108         "type": "GeometryCollection",
109         "geometries": [
110           {
111             "type": "LineString",
112             "coordinates": [
113               []
114             ]
115           }
116         ]
117       },
118       "type": "Feature",
119       "id": 1
120     }
121   },
122   "user_name": "user_name"
123 }

Retrieves a single order event log entry by its ID with organization and user name hydrated. | authz: min_org_role=administrator | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (OrderEventExpanded1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

order_event_idstringRequired

Response

Successful Response

_idstring

actionenum

Canonical vocabulary for shipping order-event and notification actions.

actorobject

order_idstring

schema_versioninteger

timestampdatetime

entitieslist of objectsOptional

order_short_idstringOptional

org_public_dataobjectOptional

user_namestringOptional

Errors

422

Order Events Get V1request Unprocessable Entity Error