List order events

GET

/shipping/orders/order_events/list/v1/:order_id

GET

/shipping/orders/order_events/list/v1/:order_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.listV1("order_id", {
8         filter_action: [
9             "shipping.order.draft_started",
10         ],
11         filter_org_id: "filter_org_id",
12         filter_timestamp_gte: "2024-01-15T09:30:00Z",
13         filter_timestamp_lte: "2024-01-15T09:30:00Z",
14         filter_user_id: "filter_user_id",
15         page: 1,
16         page_size: 1,
17         sort_by: "timestamp",
18         sort_order: "asc",
19     });
20 }
21 main();

1 {
2   "items": [
3     {
4       "_id": "_id",
5       "action": "shipping.order.draft_started",
6       "actor": {},
7       "order_id": "order_id",
8       "schema_version": 1,
9       "timestamp": "2024-01-15T09:30:00Z",
10       "entities": [
11         {}
12       ],
13       "order_short_id": "order_short_id",
14       "org_public_data": {
15         "_id": "_id",
16         "name": "name",
17         "org_id": "org_id",
18         "org_type": "provider",
19         "schema_version": 1
20       },
21       "user_name": "user_name"
22     }
23   ],
24   "total_count": 1
25 }

Lists event log entries for an order with organization and user display data hydrated, filtering, sorting, and pagination. | authz: min_org_role=administrator | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (OrderEventListRes)

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Query parameters

sort_by"timestamp"Optional

Field to sort by

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_actionenumOptional

Filter by order event action(s)

filter_user_idstringOptional

Filter by actor user ID

filter_org_idstringOptional

Filter by actor org ID

filter_timestamp_gtedatetimeOptional

Filter timestamp >= value

filter_timestamp_ltedatetimeOptional

Filter timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Order Events List V1request Unprocessable Entity Error