Get by order short ID

GET

/operations/cases/by_order_short_id/v1/:order_short_id

GET

/operations/cases/by_order_short_id/v1/:order_short_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.operations.cases.getByOrderShortIdV1("order_short_id");
8 }
9 main();

1 {
2   "_id": "_id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "order_id": "order_id",
5   "org_id": "org_id",
6   "schema_version": 1,
7   "assigned_user_ids": [
8     "assigned_user_ids"
9   ],
10   "billing_review_status": "not_started",
11   "case_s3_object_metadata_ids": [
12     "case_s3_object_metadata_ids"
13   ],
14   "department_id": "department_id",
15   "messages": [
16     {
17       "message": "message",
18       "org_id": "org_id",
19       "timestamp": "2024-01-15T09:30:00Z",
20       "user_id": "user_id",
21       "id": "id"
22     }
23   ]
24 }

Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)

Authentication

AuthorizationBearer

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

Path parameters

order_short_idstringRequired

Response

Successful Response

_idstring

created_atdatetime

order_idstring

org_idstring

Must be a string starting with org_

schema_versioninteger

assigned_user_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.

case_s3_object_metadata_idslist of strings

department_idstring

messageslist of objects

Errors

422

Cases Get by Order Short ID V1request Unprocessable Entity Error