Update task artifact

PATCH

/shipping/order_templates_new/task_artifacts/v1/:order_template_id/:task_artifact_key

PATCH

/shipping/order_templates_new/task_artifacts/v1/:order_template_id/:task_artifact_key

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.shipping.orderTemplatesNew.taskArtifacts.patchUpdateV1("order_template_id", "task_artifact_key", {});
8 }
9 main();

1 {
2   "_id": "order_template_12345",
3   "created_at_timestamp": "2024-01-10T08:00:00Z",
4   "last_edited_at_timestamp": "2024-01-14T16:45:00Z",
5   "name": "Spare Parts Shipment Template",
6   "owned_by_org_id": "org_1234",
7   "owned_by_user_id": "user_5678",
8   "schema_version": 1,
9   "archived_at_timestamp": "2024-01-15T09:30:00Z",
10   "cargos": [
11     {
12       "cargo_key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
13       "cargo_type": "spare_parts",
14       "awb_number": "020-12345678",
15       "description": "Replacement engine parts for Boeing 737",
16       "girth_inches": 24.5,
17       "height_inches": 12,
18       "length_inches": 36,
19       "quantity": 10,
20       "schema_version": 1,
21       "stackable": true,
22       "turnable": false,
23       "weight_pounds": 150,
24       "width_inches": 18
25     }
26   ],
27   "coordinator_assigned_user_ids": [
28     "user_7890"
29   ],
30   "coordinator_department_id": "dept_4567",
31   "coordinator_label": "Ground Operations Coordinator",
32   "coordinator_org_id": "org_1234",
33   "description": "Template for handling spare parts shipments",
34   "last_used_at_timestamp": "2024-01-15T09:30:00Z",
35   "off_chrt_reference_id": "SPRTS_20240115",
36   "off_chrt_shipper_org_data_id": "shipper_data_001",
37   "service_line": "on_demand",
38   "shipper_org_id": "org_9876",
39   "task_groups": [
40     {
41       "task_group_key": "4a1b2c3d-5678-90ab-cdef-1234567890ab",
42       "task_group_type": "chrt_ground_provider",
43       "coordinator_setup_notes": "Ensure all parts are inspected before pickup",
44       "driver_id": "driver_4321",
45       "executor_assigned_user_ids": [
46         "user_2345"
47       ],
48       "executor_org_id": "org_1234",
49       "off_chrt_executor_org_data_id": "exec_data_001",
50       "tasks": [
51         {
52           "task_key": "9f8e7d6c-5b4a-3210-fedc-ba9876543210",
53           "datetime_windows_dateparser_str": [
54             {
55               "time_zone_name": "America/New_York"
56             }
57           ]
58         }
59       ],
60       "vehicle_type": "sedan"
61     }
62   ],
63   "task_lists_to_apply_at_order_creation": [
64     {
65       "task_list_id": "tasklist_001",
66       "department_id": "dept_4567",
67       "initial_deadline_timestamp": "2024-01-16T12:00:00Z"
68     }
69   ],
70   "task_lists_to_apply_at_order_staging": [
71     {
72       "task_list_id": "tasklist_002",
73       "department_id": "dept_4567",
74       "initial_deadline_timestamp": "2024-01-17T08:00:00Z"
75     }
76   ]
77 }

Updates a task artifact in an active order template. | authz: min_org_role=operator | (OrderTemplateNewTaskArtifactClientUpdate1) -> (OrderTemplateNew1)

Authentication

AuthorizationBearer

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

Path parameters

order_template_idstringRequired

task_artifact_keystringRequired

Request

This endpoint expects an object.

expected_scan_payloadslist of stringsOptional

typeenum or nullOptional

Allowed values:

Response

Successful Response

_idstring

created_at_timestampdatetime

last_edited_at_timestampdatetime

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_timestampdatetime or null

cargoslist of objects

coordinator_assigned_user_idslist of strings

coordinator_department_idstring or null

coordinator_labelstring or null

coordinator_org_idstring or null

Must be a string starting with org_

descriptionstring or null<=16384 characters

last_used_at_timestampdatetime or null

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

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, ’.’, ’_’, ’~’, ’-’ (RFC 3986 unreserved).

off_chrt_shipper_org_data_idstring or null

service_lineenum

shipper_org_idstring or null

Must be a string starting with org_

task_groupslist of objects

task_lists_to_apply_at_order_creationlist of objects

task_lists_to_apply_at_order_staginglist of objects

Errors

422

Task Artifacts Patch Update V1request Unprocessable Entity Error