List (via POST) for forwarder operators

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.orders.expanded.listForForwarderOperatorsV1({
        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:30:00Z",
        filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_order_cancelled: true,
        body: {},
    });
}
main();

{
  "items": [
    {
      "order": {
        "schema_version": 1,
        "_id": "_id",
        "short_id": "short_id",
        "created_by_org_type": "courier",
        "created_by_org_id": "created_by_org_id",
        "created_by_user_id": "created_by_user_id",
        "draft_started_at_timestamp": "2024-01-15T09:30:00Z"
      },
      "forwarder_org_company_name": "forwarder_org_company_name",
      "forwarder_org_handle": "forwarder_org_handle",
      "shipper_org_company_name": "shipper_org_company_name",
      "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
      "notification_intents_ad_hoc": [
        {
          "schema_version": 1,
          "created_at_timestamp": "2024-01-15T09:30:00Z",
          "created_by_org_id": "created_by_org_id",
          "created_by_user_id": "created_by_user_id",
          "order_id": "order_id",
          "directory_entry_id": "directory_entry_id",
          "_id": "_id"
        }
      ],
      "task_groups_expanded": [
        {
          "task_group": {
            "schema_version": 1,
            "_id": "_id",
            "order_id": "order_id",
            "order_short_id": "order_short_id",
            "created_by_org_id": "created_by_org_id",
            "created_by_user_id": "created_by_user_id",
            "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
            "task_group_type": "chrt_ground_courier"
          }
        }
      ]
    }
  ],
  "total_count": 1
}

Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[forwarder], 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

Request

This endpoint expects an object.

expand_forwarder_org_company_namebooleanOptionalDefaults to false

expand_forwarder_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_courier_org_company_namebooleanOptionalDefaults to false

expand_courier_org_handlebooleanOptionalDefaults to false

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Expanded List for Forwarder Operators V1request Unprocessable Entity Error