API ReferenceShippingOrdersDrafts

Open draft

Opens a new draft order shell with org assignments based on caller’s organization type. | authz: min_org_role=operator | (OrdersOpenDraftReq) -> (OrdersOpenDraftRes)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
coordinator_org_idstringOptional

Must be a string starting with org_

creation_idempotency_keystringOptional

Optional key, unique per caller org, that makes draft creation idempotent: re-sending the same key returns the already-created draft instead of creating a duplicate.

department_idstringOptional
labelstringOptional
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
order_schedule_idstringOptional
Order schedule provenance for scheduled draft creation.
order_schedule_run_idempotency_keystringOptional
Idempotency key for one scheduled order run.
order_template_idstringOptional

Saved order template that seeded this draft. Used as template-build provenance.

service_lineenumOptional
Allowed values:
shipper_org_idstringOptional

Must be a string starting with org_

task_lists_to_apply_at_order_creationlist of objectsOptional

OperationsTaskList applications to materialize on the Order for the coordinator org at draft creation, each with optional department override and first-deadline pin.

task_lists_to_apply_at_order_staginglist of objectsOptional
OperationsTaskList applications stored on the Order for deferred application at staging, each with an optional department override.

Response

Successful Response
order_idstring
order_short_idstring

Errors

422
Drafts Open V1request Unprocessable Entity Error