Add order

POST

/shipping/order_groups/add_order/v1/:order_group_id/:order_id

Adds an order to an order group. The caller’s org must be the coordinator or an executor on the order, and the order must not already belong to another of the caller’s groups. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroup1)

Authentication

AuthorizationBearer

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

Path parameters

order_group_idstringRequired

order_idstringRequired

Response

Successful Response

schema_versioninteger

namestring<=512 characters

_idstring

short_idstring

owned_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

created_by_org_idstring

Must be a string starting with org_

created_at_timestampdatetime

last_edited_at_timestampdatetime

descriptionstring<=524288 characters

order_idslist of strings

billing_review_statusenum

Operator-driven billing-review flag for an OrderGroup (group-level) or a Case (per-order, per-org). Distinct from the derived billing settlement state - this is a manual triage status the operator flips.

Errors

422

Order Groups Add Order 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.orderGroups.addOrderV1("order_group_id", "order_id");
8	}
9	main();

1	{
2	"schema_version": 1,
3	"name": "name",
4	"_id": "_id",
5	"short_id": "short_id",
6	"owned_by_org_id": "owned_by_org_id",
7	"created_by_user_id": "created_by_user_id",
8	"created_by_org_id": "created_by_org_id",
9	"created_at_timestamp": "2024-01-15T09:30:00Z",
10	"last_edited_at_timestamp": "2024-01-15T09:30:00Z",
11	"description": "description",
12	"order_ids": [
13	"order_ids"
14	],
15	"billing_review_status": "not_started"
16	}