Delete task

DELETE

/shipping/order_templates_new/tasks/v1/:order_template_id/:task_key

DELETE

/shipping/order_templates_new/tasks/v1/:order_template_id/:task_key

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shipping.orderTemplatesNew.tasks.deleteV1("order_template_id", "task_key");
}
main();

{
  "_id": "string",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
  "name": "string",
  "owned_by_org_id": "string",
  "owned_by_user_id": "string",
  "schema_version": 1,
  "archived_at_timestamp": "2024-01-15T09:30:00Z",
  "cargos": [
    {
      "cargo_key": "string",
      "cargo_type": "spare_parts",
      "awb_number": "string",
      "description": "string",
      "height_inches": 1.1,
      "length_inches": 1.1,
      "quantity": 1,
      "schema_version": 1,
      "special_handling_codes": [
        "ACT"
      ],
      "stackable": true,
      "turnable": true,
      "weight_per_piece_pounds": 1.1,
      "width_inches": 1.1
    }
  ],
  "coordinator_assigned_user_ids": [
    "string"
  ],
  "coordinator_department_ids": [
    "string"
  ],
  "coordinator_labels": [
    "string"
  ],
  "coordinator_org_id": "string",
  "description": "string",
  "last_used_at_timestamp": "2024-01-15T09:30:00Z",
  "off_chrt_reference_id": "string",
  "off_chrt_shipper_org_data_id": "string",
  "service_line": "on_demand",
  "shipper_org_id": "string",
  "task_groups": [
    {
      "task_group_key": "string",
      "task_group_type": "chrt_ground_provider",
      "coordinator_setup_notes": "string",
      "driver_id": "string",
      "executor_assigned_user_ids": [
        "string"
      ],
      "executor_org_id": "string",
      "off_chrt_executor_org_data_id": "string",
      "tasks": [
        {
          "task_key": "string",
          "action": "chrt_ground_provider__pickup",
          "cargo_keys": [
            "string"
          ],
          "contact_ids": [
            "string"
          ],
          "coordinator_shipper_account_ids": [
            "string"
          ],
          "datetime_windows_dateparser_str": [
            {
              "time_zone_name": "America/New_York",
              "left_boundary_dateparser_str": "string",
              "right_boundary_dateparser_str": "string"
            }
          ],
          "flight_leg_id": "string",
          "geofence_distance_miles": 1,
          "location": {
            "geometry": {
              "bbox": [
                "string"
              ],
              "coordinates": [
                "string"
              ],
              "type": "string"
            },
            "type": "string",
            "bbox": [
              "string"
            ],
            "id": 1,
            "properties": {
              "address": "string",
              "country_code": "string",
              "name": "string",
              "postal_code": "string"
            }
          },
          "order_placer_comments": "string",
          "schema_version": 1,
          "task_artifacts": [
            {
              "task_artifact_key": "string",
              "type": "image",
              "expected_scan_payloads": [
                "string"
              ],
              "schema_version": 1
            }
          ]
        }
      ],
      "vehicle_type": "sedan"
    }
  ],
  "task_lists_to_apply_at_order_creation": [
    {
      "task_list_id": "string",
      "department_id": "string",
      "entry_tag": "string",
      "initial_deadline_timestamp": "2024-01-15T09:30:00Z"
    }
  ],
  "task_lists_to_apply_at_order_staging": [
    {
      "task_list_id": "string",
      "department_id": "string",
      "entry_tag": "string",
      "initial_deadline_timestamp": "2024-01-15T09:30:00Z"
    }
  ]
}

Deletes a task and its embedded artifacts from an active order template. | authz: min_org_role=operator | () -> (OrderTemplateNew1)

Authentication

AuthorizationBearer

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

Path parameters

order_template_idstringRequired

task_keystringRequiredformat: "uuid4"

Response

Successful Response

_idstring

created_at_timestampstringformat: "date-time"

last_edited_at_timestampstringformat: "date-time"

namestring1-1024 characters

owned_by_org_idstring

Must be a string starting with org_

owned_by_user_idstring

Must be a string starting with user_

schema_versioninteger

archived_at_timestampstring or nullOptionalformat: "date-time"

cargoslist of objectsOptional

coordinator_assigned_user_idslist of stringsOptional

coordinator_department_idslist of stringsOptional

coordinator_labelslist of stringsOptional

coordinator_org_idstring or nullOptional

descriptionstring or nullOptional<=16384 characters

last_used_at_timestampstring or nullOptionalformat: "date-time"

off_chrt_reference_idstring or nullOptionalformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

off_chrt_shipper_org_data_idstring or nullOptional

service_lineenumOptional

Allowed values:

shipper_org_idstring or nullOptional

task_groupslist of objectsOptional

task_lists_to_apply_at_order_creationlist of objectsOptional

task_lists_to_apply_at_order_staginglist of objectsOptional

Errors

422

Unprocessable Entity Error