List expanded drafts

POST

/shipping/order_drafts/expanded/list/v1

POST

/shipping/order_drafts/expanded/list/v1

1 const url = 'https://localhost:8000/shipping/order_drafts/expanded/list/v1?sort_by=draft_started_at_timestamp&sort_order=asc&page=1&page_size=1&search=search&filter_draft_started_at_timestamp_lte=2024-01-15T09%3A30%3A00Z&filter_draft_started_at_timestamp_gte=2024-01-15T09%3A30%3A00Z&filter_executor_org_id=filter_executor_org_id&filter_coordinator_org_id=filter_coordinator_org_id&filter_shipper_org_id=filter_shipper_org_id&filter_off_chrt_shipper_org_id=filter_off_chrt_shipper_org_id';
2 const options = {
3   method: 'POST',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "items": [
3     {
4       "order": {
5         "_id": "order_123456789",
6         "created_by_org_id": "org_987654321",
7         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
8         "schema_version": 1,
9         "short_id": "ORD12345"
10       },
11       "cargos": [
12         {
13           "_id": "cargo_1234567890",
14           "cargo_type": "spare_parts",
15           "created_by_org_id": "org_987654321",
16           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
17           "order_id": "order_123456789",
18           "order_short_id": "ORD12345",
19           "schema_version": 1
20         }
21       ],
22       "coordinator_org_company_name": "Global Logistics Inc.",
23       "coordinator_org_handle": "@GlobalLogistics",
24       "notification_intents_ad_hoc": [
25         {
26           "_id": "notif_abc123",
27           "created_at_timestamp": "2024-01-15T09:30:00Z",
28           "created_by_org_id": "org_987654321",
29           "created_by_user_id": "user_123456789",
30           "directory_entry_id": "direntry_456789",
31           "schema_version": 1
32         }
33       ],
34       "off_chrt_shipper_org_company_name": "OffChrt Shipping Co.",
35       "shipper_org_company_name": "Acme Shippers Ltd.",
36       "task_groups_expanded": [
37         {
38           "task_group": {
39             "_id": "taskgroup_789012345",
40             "created_by_org_id": "org_987654321",
41             "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
42             "order_id": "order_123456789",
43             "order_short_id": "ORD12345",
44             "schema_version": 1,
45             "task_group_type": "chrt_ground_provider"
46           }
47         }
48       ]
49     }
50   ],
51   "total_count": 1
52 }

Lists expanded draft orders for the organization with filtering, sorting, pagination, and optional search. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_by"draft_started_at_timestamp"Optional

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_draft_started_at_timestamp_ltedatetimeOptional

filter_draft_started_at_timestamp_gtedatetimeOptional

filter_executor_org_idstringOptional

filter_coordinator_org_idstringOptional

filter_shipper_org_idstringOptional

filter_off_chrt_shipper_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 V1request Unprocessable Entity Error