Update draft

PATCH

/shipping/orders/update_draft/v1/:order_id

Updates service-line and organization assignments on a draft order. | authz_personas=[draft_creator_org_operator] | (OrdersUpdateDraftReq) -> (OrdersUpdateDraftRes)

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Request

This endpoint expects an object.

coordinator_org_idstringOptional

Must be a string starting with org_

coordinator_org_id__set_to_NonebooleanOptionalDefaults to false

off_chrt_shipper_org_data_idstringOptional

off_chrt_shipper_org_data_id__set_to_NonebooleanOptionalDefaults to false

service_lineenumOptional

Allowed values:

shipper_org_idstringOptional

Must be a string starting with org_

shipper_org_id__set_to_NonebooleanOptionalDefaults to false

Response

Successful Response

order_idstring

order_short_idstring

service_lineenum

coordinator_org_idstringOptional

Must be a string starting with org_

off_chrt_shipper_org_data_idstringOptional

shipper_org_idstringOptional

Must be a string starting with org_

Errors

422

Orders Update Draft V1request Unprocessable Entity Error

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.orders.updateDraftV1("order_id", {});
8	}
9	main();

1	{
2	"order_id": "order_id",
3	"order_short_id": "order_short_id",
4	"service_line": "on_demand",
5	"coordinator_org_id": "coordinator_org_id",
6	"off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
7	"shipper_org_id": "shipper_org_id"
8	}