Retrieve for provider operators

POST

/shipping/task_groups/expanded/for_provider_operators/v1/:task_group_id

POST

/shipping/task_groups/expanded/for_provider_operators/v1/:task_group_id

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.taskGroups.expanded.forProviderOperatorsV1("task_group_id", {});
}
main();

{
  "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",
    "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
    "completed_at_timestamp": "2024-01-15T09:30:00Z",
    "coordinator_org_id": "coordinator_org_id",
    "coordinator_setup_notes": "coordinator_setup_notes",
    "created_by_user_id": "created_by_user_id",
    "driver_id": "driver_id",
    "exception_at_timestamp": "2024-01-15T09:30:00Z",
    "executor_org_id": "executor_org_id",
    "flight_leg_ids": [
      "flight_leg_ids"
    ],
    "flight_setup_notes": "flight_setup_notes",
    "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
    "messages": [
      {
        "message": "message",
        "org_id": "org_id",
        "timestamp": "2024-01-15T09:30:00Z",
        "user_id": "user_id"
      }
    ],
    "mileage_estimated": 1.1,
    "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
    "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
    "order_off_chrt_reference_id": "order_off_chrt_reference_id",
    "shipper_org_id": "shipper_org_id",
    "skipped_at_timestamp": "2024-01-15T09:30:00Z",
    "staged_at_timestamp": "2024-01-15T09:30:00Z",
    "status": "draft",
    "task_group_s3_object_metadata_ids": [
      "task_group_s3_object_metadata_ids"
    ],
    "task_ids": [
      "task_ids"
    ],
    "vehicle_type": "sedan",
    "wait_time_total_minutes": 1.1
  },
  "awb_numbers": [
    "awb_numbers"
  ],
  "coordinator_org_company_name": "coordinator_org_company_name",
  "coordinator_org_handle": "coordinator_org_handle",
  "coordinator_org_id": "coordinator_org_id",
  "driver": {
    "_id": "_id",
    "org_id": "org_id",
    "schema_version": 1,
    "user_id": "user_id",
    "archived_at_timestamp": "2024-01-15T09:30:00Z",
    "auto_assign_enabled": true,
    "available_according_to_driver": true,
    "available_according_to_operators": true,
    "email_address_primary": "email_address_primary",
    "email_address_secondary": "email_address_secondary",
    "first_name": "first_name",
    "last_name": "last_name",
    "last_seen_at_location": {
      "geometry": {
        "type": "GeometryCollection",
        "geometries": [
          {
            "type": "LineString",
            "coordinates": [
              []
            ]
          }
        ]
      },
      "type": "Feature",
      "id": 1
    },
    "last_seen_at_location_city": "last_seen_at_location_city",
    "last_seen_at_location_large_city": "last_seen_at_location_large_city",
    "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
    "phone_number_primary": "phone_number_primary",
    "phone_number_secondary": "phone_number_secondary",
    "status": "unassigned",
    "vehicle_types": [
      "sedan"
    ],
    "waiting": true
  },
  "executor_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",
      "location": {
        "geometry": {
          "type": "GeometryCollection",
          "geometries": [
            {
              "type": "LineString",
              "coordinates": [
                []
              ]
            }
          ]
        },
        "type": "Feature"
      },
      "operator_user_ids": [
        "operator_user_ids"
      ]
    }
  ],
  "executor_org_company_name": "executor_org_company_name",
  "executor_org_handle": "executor_org_handle",
  "executor_org_id": "executor_org_id",
  "off_chrt_executor_org_company_name": "off_chrt_executor_org_company_name",
  "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
  "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
  "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
  "shipper_org_company_name": "shipper_org_company_name",
  "shipper_org_id": "shipper_org_id",
  "tasks_expanded": [
    {
      "task": {
        "_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,
        "short_id": "short_id",
        "task_group_id": "task_group_id"
      },
      "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
        }
      ],
      "contacts": [
        {
          "_id": "_id",
          "created_by_org_id": "created_by_org_id",
          "name": "name",
          "schema_version": 1
        }
      ],
      "task_artifacts": [
        {
          "_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_id": "task_group_id",
          "task_id": "task_id",
          "type": "image"
        }
      ]
    }
  ]
}

Retrieves an expanded task group when the caller’s provider org is its coordinator, executor, or both. Coordinator-only callers receive empty executor_org_notes; executor-only callers receive empty coordinator_shipper_account_ids. Executor notes are limited to the caller’s org. | authz_personas=[coordinator_org_operators, executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

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

task_groupobject

awb_numberslist of stringsOptional

coordinator_org_company_namestringOptional

coordinator_org_handlestringOptionalformat: "^@[a-zA-Z0-9_-]+$"2-30 characters

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

coordinator_org_idstringOptional

Must be a string starting with org_

driverobjectOptional

executor_departmentslist of objectsOptional

executor_org_company_namestringOptional

executor_org_handlestringOptionalformat: "^@[a-zA-Z0-9_-]+$"2-30 characters

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

executor_org_idstringOptional

Must be a string starting with org_

off_chrt_executor_org_company_namestringOptional

off_chrt_executor_org_data_idstringOptional

off_chrt_shipper_org_company_namestringOptional

off_chrt_shipper_org_data_idstringOptional

shipper_org_company_namestringOptional

shipper_org_idstringOptional

Must be a string starting with org_

tasks_expandedlist of objectsOptional

Errors

422

Expanded for Provider Operators V1request Unprocessable Entity Error