List (via POST) for provider operators

POST

/shipping/orders/expanded/list/for_provider_operators/v1

POST

/shipping/orders/expanded/list/for_provider_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.listForProviderOperatorsV1({
8         filter_awb_number: "filter_awb_number",
9         filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
10         filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
11         filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
12         filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
13         filter_coordinator_assigned_user_ids: [
14             "filter_coordinator_assigned_user_ids",
15         ],
16         filter_coordinator_department_id: "filter_coordinator_department_id",
17         filter_coordinator_label: "filter_coordinator_label",
18         filter_coordinator_org_id: "filter_coordinator_org_id",
19         filter_coordinator_shipper_account_ids: [
20             "filter_coordinator_shipper_account_ids",
21         ],
22         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
23         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
24         filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
25         filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
26         filter_executor_org_id: "filter_executor_org_id",
27         filter_has_invoice: true,
28         filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
29         filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
30         filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
31         filter_order_classification_by_task_group_type: [
32             "chrt_ground_provider",
33         ],
34         filter_service_line: [
35             "on_demand",
36         ],
37         filter_shipper_org_id: "filter_shipper_org_id",
38         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
39         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
40         filter_status: [
41             "draft",
42         ],
43         page: 1,
44         page_size: 1,
45         provider_role: "all",
46         search: "search",
47         sort_by: "draft_started_at_timestamp",
48         sort_order: "asc",
49         body: {},
50     });
51 }
52 main();

1 {
2   "items": [
3     {
4       "order": {
5         "_id": "_id",
6         "created_by_org_id": "created_by_org_id",
7         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
8         "schema_version": 1,
9         "short_id": "short_id"
10       },
11       "provider_roles": [
12         "coordinator"
13       ],
14       "coordinator_org_company_name": "coordinator_org_company_name",
15       "coordinator_org_handle": "coordinator_org_handle",
16       "notification_intents_ad_hoc": [
17         {
18           "_id": "_id",
19           "contact_id": "contact_id",
20           "created_at_timestamp": "2024-01-15T09:30:00Z",
21           "created_by_org_id": "created_by_org_id",
22           "created_by_user_id": "created_by_user_id",
23           "schema_version": 1
24         }
25       ],
26       "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
27       "shipper_org_company_name": "shipper_org_company_name",
28       "task_groups_expanded": [
29         {
30           "task_group": {
31             "_id": "_id",
32             "created_by_org_id": "created_by_org_id",
33             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
34             "order_id": "order_id",
35             "order_short_id": "order_short_id",
36             "schema_version": 1,
37             "task_group_type": "chrt_ground_provider"
38           }
39         }
40       ]
41     }
42   ],
43   "total_count": 1
44 }

Lists expanded orders where the caller’s provider org is the coordinator, an executor, or both. Each order appears once with role-filtered task-group details. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListForProviderRes)

Authentication

AuthorizationBearer

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

Query parameters

provider_roleenumOptional

Allowed values:

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, off-CHRT reference ID, and AWB)

filter_statusenumOptional

filter_service_lineenumOptional

Filter by service line

Allowed values:

filter_order_classification_by_task_group_typeenumOptional

Filter by global order classification (OBC takes precedence over flight, then ground)

Allowed values:

filter_awb_numberstringOptionalformat: "^\d{3}-\d{8}$"

Filter by exact AWB number

filter_has_invoicebooleanOptional

Filter by whether the order has any invoice

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

filter_shipper_org_idstringOptional

filter_off_chrt_shipper_org_data_idstringOptional

filter_coordinator_shipper_account_idsstringOptional

Filter by coordinator shipper account IDs

filter_coordinator_department_idstringOptional

filter_coordinator_assigned_user_idsstringOptional

filter_coordinator_labelstringOptional

Request

This endpoint expects an object.

expand_cargosbooleanOptionalDefaults to false

expand_contactsbooleanOptionalDefaults to false

expand_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_org_handlebooleanOptionalDefaults 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 Provider Operators V1request Unprocessable Entity Error