List (via POST) for coordinator operators

POST

/shipping/orders/expanded/list/for_coordinator_operators/v1

Lists expanded orders where the caller’s provider org is the coordinator. Filtering, sorting, pagination, optional search. | authz: allowed_org_types=[provider], 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

Allowed values:

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_exception_at_timestamp_ltedatetimeOptional

filter_exception_at_timestamp_gtedatetimeOptional

filter_order_cancelled_at_timestamp_ltedatetimeOptional

filter_order_cancelled_at_timestamp_gtedatetimeOptional

filter_order_cancelledbooleanOptional

filter_executor_org_idstringOptional

filter_shipper_org_idstringOptional

filter_off_chrt_shipper_org_idstringOptional

Request

This endpoint expects an object.

expand_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_org_handlebooleanOptionalDefaults to false

expand_shipper_org_company_namebooleanOptionalDefaults to false

expand_off_chrt_shipper_org_company_namebooleanOptionalDefaults to false

expand_notification_intents_ad_hocbooleanOptionalDefaults to false

expand_tasksbooleanOptionalDefaults to false

expand_cargosbooleanOptionalDefaults to false

expand_task_artifactsbooleanOptionalDefaults to false

expand_directory_entriesbooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults to false

expand_executor_org_company_namebooleanOptionalDefaults to false

expand_executor_org_handlebooleanOptionalDefaults to false

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Expanded List for Coordinator Operators V1request Unprocessable Entity Error

Validation Error

detaillist of objects

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.listForCoordinatorOperatorsV1({
8	sort_by: "draft_started_at_timestamp",
9	sort_order: "asc",
10	body: {},
11	});
12	}
13	main();

1	{
2	"detail": [
3	{
4	"loc": [
5	"string"
6	],
7	"msg": "string",
8	"type": "string",
9	"input": {},
10	"ctx": {
11	"string": {}
12	}
13	}
14	]
15	}