Update draft

PATCH

/shipping/order_schedules/draft/update/v1/:order_schedule_id

Updates a draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)

Authentication

AuthorizationBearer

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

Path parameters

order_schedule_idstringRequired

Request

This endpoint expects an object.

auto_stagebooleanOptional

descriptionstringOptional

description__set_to_NonebooleanOptionalDefaults to false

namestringOptional

order_template_coreobjectOptional

NOTE - some fields have multiple values and must be properly mapped to an entity by the order builder, e.g. for driver_ids each resolves to a single task group

Shared seed of an order build: the order text + long-lived references. Reused by the library template (OrderTemplateBase1) and the ad-hoc kickoff payload so the fields the builder seeds from can't drift. (Mirrors TaskCore1.) NOTE - some fields have multiple values and must be properly mapped to an entity by the order builder, e.g. for `driver_ids` each resolves to a single task group

schedule_specobjectOptional

Response

Successful Response

Errors

422

Draft Update 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.orderSchedules.draft.updateV1("order_schedule_id", {});
8	}
9	main();