List (via POST) for shipper operators

POST

/shipping/orders/expanded/list/for_shipper_operators/v1

POST

/shipping/orders/expanded/list/for_shipper_operators/v1

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.expanded.listForShipperOperatorsV1({
8         sort_by: "draft_started_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         search: "search",
13         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
14         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
15         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
16         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
17         filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
18         filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
19         filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
20         filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
21         filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
22         filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
23         filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
24         filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
25         filter_executor_org_id: "filter_executor_org_id",
26         filter_coordinator_org_id: "filter_coordinator_org_id",
27         body: {},
28     });
29 }
30 main();

1 {
2   "items": [
3     {
4       "order": {
5         "_id": "order_abc123xyz",
6         "created_by_org_id": "org_987654321",
7         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
8         "schema_version": 1,
9         "short_id": "ORD-20240115-001"
10       },
11       "coordinator_org_company_name": "Global Logistics Inc.",
12       "coordinator_org_handle": "@GlobalLogistics",
13       "notification_intents_ad_hoc": [
14         {
15           "_id": "notif_1234567890",
16           "created_at_timestamp": "2024-01-15T09:30:00Z",
17           "created_by_org_id": "org_987654321",
18           "created_by_user_id": "user_123456789",
19           "directory_entry_id": "dir_456789123",
20           "schema_version": 1
21         }
22       ],
23       "off_chrt_shipper_org_company_name": "OffChrt Shipping Co.",
24       "shipper_org_company_name": "Acme Shippers Ltd.",
25       "task_groups_expanded": [
26         {
27           "task_group": {
28             "_id": "tg_0011223344",
29             "created_by_org_id": "org_987654321",
30             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
31             "order_id": "order_abc123xyz",
32             "order_short_id": "ORD-20240115-001",
33             "schema_version": 1,
34             "task_group_type": "chrt_ground_provider"
35           }
36         }
37       ]
38     }
39   ],
40   "total_count": 1
41 }

Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenumOptional

sort_orderenumOptional

Sort order (asc or desc)

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

searchstringOptional

Full-text search query (searches order short_id and off_chrt_reference_id)

filter_statusenumOptional

filter_draft_started_at_timestamp_ltedatetimeOptional

filter_draft_started_at_timestamp_gtedatetimeOptional

filter_staged_at_timestamp_ltedatetimeOptional

filter_staged_at_timestamp_gtedatetimeOptional

filter_in_progress_at_timestamp_ltedatetimeOptional

filter_in_progress_at_timestamp_gtedatetimeOptional

filter_completed_at_timestamp_ltedatetimeOptional

filter_completed_at_timestamp_gtedatetimeOptional

filter_cancelled_at_timestamp_ltedatetimeOptional

filter_cancelled_at_timestamp_gtedatetimeOptional

filter_exception_at_timestamp_ltedatetimeOptional

filter_exception_at_timestamp_gtedatetimeOptional

filter_executor_org_idstringOptional

filter_coordinator_org_idstringOptional

Request

This endpoint expects an object.

expand_cargosbooleanOptionalDefaults to false

expand_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_org_handlebooleanOptionalDefaults to false

expand_directory_entriesbooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults to false

expand_executor_org_company_namebooleanOptionalDefaults to false

expand_executor_org_handlebooleanOptionalDefaults to false

expand_notification_intents_ad_hocbooleanOptionalDefaults to false

expand_off_chrt_shipper_org_company_namebooleanOptionalDefaults to false

expand_shipper_org_company_namebooleanOptionalDefaults to false

expand_task_artifactsbooleanOptionalDefaults to false

expand_tasksbooleanOptionalDefaults to false

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Expanded List for Shipper Operators V1request Unprocessable Entity Error