Update orgs

PATCH

/shipping/order_drafts/update/v1/:order_id

Updates coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)

AuthorizationBearer

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

order_idstringRequired

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_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_reference_id__set_to_NonebooleanOptionalDefaults to false

off_chrt_shipper_org_idstringOptional

off_chrt_shipper_org_id__set_to_NonebooleanOptionalDefaults to false

shipper_org_idstringOptional

Must be a string starting with org_

shipper_org_id__set_to_NonebooleanOptionalDefaults to false

Successful Response

order_idstring

order_short_idstring

coordinator_org_idstring

Must be a string starting with org_

off_chrt_reference_idstringformat: "^[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_idstring

shipper_org_idstring

Must be a string starting with org_

422

Order Drafts Update V1request Unprocessable Entity Error

1	const url = 'https://localhost:8000/shipping/order_drafts/update/v1/order_id';
2	const options = {
3	method: 'PATCH',
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	}

1	{
2	"order_id": "order_id",
3	"order_short_id": "order_short_id",
4	"coordinator_org_id": "coordinator_org_id",
5	"off_chrt_reference_id": "off_chrt_reference_id",
6	"off_chrt_shipper_org_id": "off_chrt_shipper_org_id",
7	"shipper_org_id": "shipper_org_id"
8	}