Agentic draft stream

POST

/shipping/orders/drafts/build_with_streaming/v1

Creates a draft order from an ad-hoc core or saved template and streams progress events via SSE. When both a core and template ID are supplied, the core drives the build and the template ID is recorded as provenance. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderBuilderStreamEvent)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

order_template_coreobjectOptional

Build input. Required if order_template_id is omitted. When both are provided, this edited core is used instead of the saved template.

order_template_idstringOptional

Saved-template provenance. Required if order_template_core is omitted. When provided, it is authorized for the caller and marked used when the draft opens.

stream_order_parsing_progress_updatesbooleanOptionalDefaults to true

Response

Successful Response

eventenum

progressdouble0-1

errorstringOptional

messagestringOptional

noteslist of stringsOptional

order_idstringOptional

order_short_idstringOptional

summarystringOptional

validation_issueslist of stringsOptional

validation_passedbooleanOptional

Errors

422

Drafts Build with Streaming V1request Unprocessable Entity Error

1	const url = 'https://localhost:8000/shipping/orders/drafts/build_with_streaming/v1';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}