Create cargo

POST

/shipping/order_templates_new/cargos/v1/:order_template_id

POST

/shipping/order_templates_new/cargos/v1/:order_template_id

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.cargos.postCreateV1("order_template_id", {
8         cargo_type: "spare_parts",
9     });
10 }
11 main();

1 {
2   "_id": "_id",
3   "created_at_timestamp": "2024-01-15T09:30:00Z",
4   "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
5   "name": "name",
6   "owned_by_org_id": "owned_by_org_id",
7   "owned_by_user_id": "owned_by_user_id",
8   "schema_version": 1,
9   "archived_at_timestamp": "2024-01-15T09:30:00Z",
10   "cargos": [
11     {
12       "cargo_key": "cargo_key",
13       "cargo_type": "spare_parts",
14       "awb_number": "awb_number",
15       "description": "description",
16       "girth_inches": 1.1,
17       "height_inches": 1.1,
18       "length_inches": 1.1,
19       "quantity": 1,
20       "schema_version": 1,
21       "stackable": true,
22       "turnable": true,
23       "weight_pounds": 1.1,
24       "width_inches": 1.1
25     }
26   ],
27   "coordinator_assigned_user_ids": [
28     "coordinator_assigned_user_ids"
29   ],
30   "coordinator_department_id": "coordinator_department_id",
31   "coordinator_label": "coordinator_label",
32   "coordinator_org_id": "coordinator_org_id",
33   "description": "description",
34   "last_used_at_timestamp": "2024-01-15T09:30:00Z",
35   "off_chrt_reference_id": "off_chrt_reference_id",
36   "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
37   "service_line": "on_demand",
38   "shipper_org_id": "shipper_org_id",
39   "task_groups": [
40     {
41       "task_group_key": "task_group_key",
42       "task_group_type": "chrt_ground_provider",
43       "coordinator_setup_notes": "coordinator_setup_notes",
44       "driver_id": "driver_id",
45       "executor_assigned_user_ids": [
46         "executor_assigned_user_ids"
47       ],
48       "executor_org_id": "executor_org_id",
49       "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
50       "tasks": [
51         {
52           "task_key": "task_key",
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": "task_list_id",
66       "department_id": "department_id",
67       "initial_deadline_timestamp": "2024-01-15T09:30:00Z"
68     }
69   ],
70   "task_lists_to_apply_at_order_staging": [
71     {
72       "task_list_id": "task_list_id",
73       "department_id": "department_id",
74       "initial_deadline_timestamp": "2024-01-15T09:30:00Z"
75     }
76   ]
77 }

Adds cargo to an active order template. | authz: min_org_role=operator | (OrderTemplateNewCargoClientCreate1) -> (OrderTemplateNew1)

Authentication

AuthorizationBearer

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

Path parameters

order_template_idstringRequired

Request

This endpoint expects an object.

cargo_typeenumRequired

awb_numberstringOptionalformat: "^\d{3}-\d{8}$"

IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. ‘020-12345678’.

descriptionstringOptional<=524288 characters

girth_inchesdoubleOptional

height_inchesdoubleOptional

length_inchesdoubleOptional

quantityintegerOptional

schema_versionintegerOptionalDefaults to 1

stackablebooleanOptional

turnablebooleanOptional

weight_poundsdoubleOptional

width_inchesdoubleOptional

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_timestampdatetimeOptional

cargoslist of objectsOptional

coordinator_assigned_user_idslist of stringsOptional

coordinator_department_idstringOptional

coordinator_labelstringOptional

coordinator_org_idstringOptional

Must be a string starting with org_

descriptionstringOptional<=16384 characters

last_used_at_timestampdatetimeOptional

off_chrt_reference_idstringOptionalformat: "^[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_idstringOptional

service_lineenumOptional

shipper_org_idstringOptional

Must be a string starting with org_

task_groupslist of objectsOptional

task_lists_to_apply_at_order_creationlist of objectsOptional

task_lists_to_apply_at_order_staginglist of objectsOptional

Errors

422

Cargos Post Create V1request Unprocessable Entity Error