Set billing review status

PATCH

/shipping/order_groups/set_billing_review_status/v1/:order_group_id

PATCH

/shipping/order_groups/set_billing_review_status/v1/:order_group_id

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.setBillingReviewStatusV1("order_group_id", {
8         billing_review_status: "not_started",
9     });
10 }
11 main();

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

Sets the order group’s operator billing-review status. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderGroupSetBillingReviewStatusReq) -> (OrderGroup1)

Authentication

AuthorizationBearer

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

Path parameters

order_group_idstringRequired

Request

This endpoint expects an object.

billing_review_statusenumRequired

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.

Allowed values:

Response

Successful Response

_idstring

created_at_timestampdatetime

created_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

last_edited_at_timestampdatetime

namestring<=512 characters

owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger

short_idstring

billing_review_statusenum

descriptionstring<=524288 characters

order_idslist of strings

Errors

422

Order Groups Set Billing Review Status V1request Unprocessable Entity Error