Retrieve (via POST) for provider operators

POST

/shipping/orders/expanded/for_provider_operators/v1/:order_ref

POST

/shipping/orders/expanded/for_provider_operators/v1/:order_ref

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

{
  "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",
    "awb_numbers": [
      "awb_numbers"
    ],
    "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
    "completed_at_timestamp": "2024-01-15T09:30:00Z",
    "coordinator_assigned_user_ids": [
      "coordinator_assigned_user_ids"
    ],
    "coordinator_department_ids": [
      "coordinator_department_ids"
    ],
    "coordinator_labels": [
      "coordinator_labels"
    ],
    "coordinator_org_id": "coordinator_org_id",
    "coordinator_shipper_account_ids": [
      "coordinator_shipper_account_ids"
    ],
    "coordinator_task_lists_to_apply_at_order_staging": [
      {
        "task_list_id": "task_list_id"
      }
    ],
    "created_by_user_id": "created_by_user_id",
    "creation_idempotency_key": "creation_idempotency_key",
    "exception_at_timestamp": "2024-01-15T09:30:00Z",
    "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
    "invoice_ids": [
      "invoice_ids"
    ],
    "last_delivery_task_completed_at_timestamp": "2024-01-15T09:30:00Z",
    "off_chrt_reference_id": "off_chrt_reference_id",
    "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
    "order_classification_by_task_group_type": "chrt_ground_provider",
    "order_schedule_id": "order_schedule_id",
    "order_schedule_run_idempotency_key": "order_schedule_run_idempotency_key",
    "order_template_new_id": "order_template_new_id",
    "service_line": "on_demand",
    "shipper_org_id": "shipper_org_id",
    "staged_at_timestamp": "2024-01-15T09:30:00Z",
    "status": "draft",
    "task_group_details": [
      {
        "task_group_id": "task_group_id",
        "task_group_type": "chrt_ground_provider"
      }
    ]
  },
  "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",
      "location": {
        "geometry": {
          "type": "GeometryCollection",
          "geometries": [
            {
              "type": "LineString",
              "coordinates": [
                []
              ]
            }
          ]
        },
        "type": "Feature"
      },
      "operator_user_ids": [
        "operator_user_ids"
      ]
    }
  ],
  "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,
      "location": {
        "geometry": {
          "type": "GeometryCollection",
          "geometries": [
            {
              "type": "LineString",
              "coordinates": [
                []
              ]
            }
          ]
        },
        "type": "Feature"
      },
      "off_chrt_org_data_id": "off_chrt_org_data_id",
      "org_id": "org_id"
    }
  ],
  "coordinator_task_lists_to_apply_at_order_staging_expanded": [
    {
      "task_list_to_apply": {
        "task_list_id": "task_list_id"
      },
      "operations_task_list": {
        "_id": "_id",
        "created_at_timestamp": "2024-01-15T09:30:00Z",
        "created_by_user_id": "created_by_user_id",
        "name": "name",
        "org_id": "org_id",
        "schema_version": 1,
        "updated_at_timestamp": "2024-01-15T09:30:00Z"
      }
    }
  ],
  "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,
      "email_events": [
        "shipping.order.staged"
      ],
      "order_id": "order_id",
      "push_events": [
        "shipping.order.staged"
      ],
      "session_id": "session_id",
      "sms_events": [
        "shipping.order.staged"
      ]
    }
  ],
  "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"
      },
      "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"
      },
      "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"
        }
      ],
      "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"
          }
        }
      ]
    }
  ],
  "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,
      "awb_number": "awb_number",
      "awb_number_line_items_generated": true,
      "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
      "created_by_user_id": "created_by_user_id",
      "delivered_at_timestamp": "2024-01-15T09:30:00Z",
      "description": "description",
      "device_ids": [
        "device_ids"
      ],
      "exception_at_timestamp": "2024-01-15T09:30:00Z",
      "girth_inches": 1.1,
      "height_inches": 1.1,
      "in_transit_at_timestamp": "2024-01-15T09:30:00Z",
      "length_inches": 1.1,
      "quantity": 1,
      "skipped_at_timestamp": "2024-01-15T09:30:00Z",
      "special_handling_codes": [
        "ACT"
      ],
      "stackable": true,
      "staged_at_timestamp": "2024-01-15T09:30:00Z",
      "status": "draft",
      "turnable": true,
      "weight_pounds": 1.1,
      "width_inches": 1.1
    }
  ]
}

Retrieves an expanded order for a provider org that is the coordinator, an executor, or both. Executor-only callers receive only their task groups. Drafts are visible only to operators in the creating provider org; coordinator responses include unassigned_cargos when expand_cargos is requested. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpandedForProvider)

Authentication

AuthorizationBearer

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

Path parameters

order_refstringRequired

Order ID, short ID, or off-chrt reference ID

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

orderobject

Provider view: full order when coordinator; when executor only, task groups are filtered to the provider’s own and other executors’ operational fields are redacted.

provider_roleslist of enums

Allowed values:

coordinator_departmentslist of objectsOptional

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_shipper_accountslist of objectsOptional

coordinator_task_lists_to_apply_at_order_staging_expandedlist of objectsOptional

notification_intents_ad_hoclist of objectsOptional

off_chrt_shipper_org_company_namestringOptional

shipper_org_company_namestringOptional

task_groups_expandedlist of objectsOptional

unassigned_cargoslist of objectsOptional

Errors

422

Expanded for Provider Operators V1request Unprocessable Entity Error