Get by order ref

GET

/operations/cases/by_order_ref/v1/:order_ref

GET

/operations/cases/by_order_ref/v1/:order_ref

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.getByOrderRefV1("order_ref");
8 }
9 main();

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

Retrieves the case for a given order ID, short ID, or off-chrt reference 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_refstringRequired

Order ID, short ID, or off-chrt reference ID

Response

Successful Response

schema_versioninteger

order_idstring

_idstring

org_idstring

Must be a string starting with org_

created_atdatetime

department_idstring or null

assigned_user_idslist of strings

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

messageslist of objects

Errors

422

Cases Get by Order Ref V1request Unprocessable Entity Error