List (via POST) for provider operators

POST

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

POST

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

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.orders.expanded.listForProviderOperatorsV1({
        filter_awb_number: "filter_awb_number",
        filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_coordinator_assigned_user_ids: [
            "filter_coordinator_assigned_user_ids",
        ],
        filter_coordinator_department_ids: [
            "filter_coordinator_department_ids",
        ],
        filter_coordinator_labels: [
            "filter_coordinator_labels",
        ],
        filter_coordinator_org_id: "filter_coordinator_org_id",
        filter_coordinator_shipper_account_ids: [
            "filter_coordinator_shipper_account_ids",
        ],
        filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_executor_department_ids: [
            "filter_executor_department_ids",
        ],
        filter_executor_org_id: "filter_executor_org_id",
        filter_has_invoice: true,
        filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_last_delivery_task_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_last_delivery_task_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
        filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
        filter_order_classification_by_task_group_type: [
            "chrt_ground_provider",
        ],
        filter_order_ids: [
            "filter_order_ids",
        ],
        filter_service_line: [
            "on_demand",
        ],
        filter_shipper_org_id: "filter_shipper_org_id",
        filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_status: [
            "draft",
        ],
        page: 1,
        page_size: 1,
        provider_role: "all",
        search: "search",
        sort_by: "draft_started_at_timestamp",
        sort_order: "asc",
        body: {},
    });
}
main();

{
  "items": [
    {
      "order": {
        "_id": "_id",
        "created_by_org_id": "created_by_org_id",
        "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
        "schema_version": 1,
        "short_id": "short_id"
      },
      "provider_roles": [
        "coordinator"
      ],
      "coordinator_departments": [
        {
          "_id": "_id",
          "created_at": "2024-01-15T09:30:00Z",
          "created_by_user_id": "created_by_user_id",
          "department_type": "aerospace",
          "name": "name",
          "org_id": "org_id",
          "schema_version": 1,
          "short_id": "short_id"
        }
      ],
      "coordinator_org_company_name": "coordinator_org_company_name",
      "coordinator_org_handle": "coordinator_org_handle",
      "coordinator_shipper_accounts": [
        {
          "_id": "_id",
          "created_by_org_id": "created_by_org_id",
          "created_by_user_id": "created_by_user_id",
          "name": "name",
          "schema_version": 1
        }
      ],
      "coordinator_task_lists_to_apply_at_order_staging_expanded": [
        {
          "task_list_to_apply": {
            "task_list_id": "task_list_id"
          }
        }
      ],
      "notification_intents_ad_hoc": [
        {
          "_id": "_id",
          "contact_id": "contact_id",
          "created_at_timestamp": "2024-01-15T09:30:00Z",
          "created_by_org_id": "created_by_org_id",
          "created_by_user_id": "created_by_user_id",
          "schema_version": 1
        }
      ],
      "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
      "shipper_org_company_name": "shipper_org_company_name",
      "task_groups_expanded": [
        {
          "task_group": {
            "_id": "_id",
            "created_by_org_id": "created_by_org_id",
            "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
            "order_id": "order_id",
            "order_short_id": "order_short_id",
            "schema_version": 1,
            "task_group_type": "chrt_ground_provider"
          }
        }
      ],
      "unassigned_cargos": [
        {
          "_id": "_id",
          "cargo_type": "spare_parts",
          "created_by_org_id": "created_by_org_id",
          "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
          "order_id": "order_id",
          "order_short_id": "order_short_id",
          "schema_version": 1
        }
      ]
    }
  ],
  "total_count": 1
}

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_order_idsstringOptional

Filter by selected order ids

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_last_delivery_task_completed_at_timestamp_ltedatetimeOptional

Filter by last delivery completion time, inclusive.

filter_last_delivery_task_completed_at_timestamp_gtedatetimeOptional

Filter by last delivery completion time, inclusive.

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_executor_department_idsstringOptional

Filter by executor department IDs

filter_off_chrt_executor_org_data_idstringOptional

Filter by off-CHRT executor org data ID

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_idsstringOptional

Filter by coordinator department IDs

filter_coordinator_assigned_user_idsstringOptional

filter_coordinator_labelsstringOptional

Filter by all supplied coordinator labels (exact matches).

Request

This endpoint expects an object.

expand_accountsbooleanOptionalDefaults to false

expand_cargosbooleanOptionalDefaults to false

expand_contactsbooleanOptionalDefaults to false

expand_coordinator_departmentsbooleanOptionalDefaults to false

expand_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_org_handlebooleanOptionalDefaults to false

expand_coordinator_task_lists_to_apply_at_order_stagingbooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults to false

expand_executor_departmentsbooleanOptionalDefaults 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