Get by order

GET

/operations/cases/by_order/v1/:order_id

GET

/operations/cases/by_order/v1/:order_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.getByOrderV1("order_id");
8 }
9 main();

1 {
2   "schema_version": 1,
3   "order_id": "order_987654321",
4   "_id": "case_0001a2b3c4d5",
5   "org_id": "org_chrtcorp",
6   "created_by_user_id": "user_admin",
7   "created_at": "2024-01-15T09:30:00Z",
8   "order_ref": "ORD12345_2024",
9   "order_short_id": "ORD12345",
10   "department_id": "dept_logistics",
11   "assigned_operator_user_ids": [
12     "user_jdoe",
13     "user_asmith"
14   ],
15   "case_s3_object_metadata_ids": [
16     "s3meta_00123abc",
17     "s3meta_00456def"
18   ],
19   "status": "open",
20   "needs_action": true,
21   "messages": [
22     {
23       "message": "Initial case created for order ORD12345_2024.",
24       "user_id": "user_jdoe",
25       "org_id": "org_chrtcorp",
26       "timestamp": "2024-01-15T09:30:00Z",
27       "id": "msg_1001"
28     }
29   ],
30   "enabled_check_keys": [
31     "shipping.order.placed.order_details_reviewed"
32   ],
33   "disabled_check_keys": [
34     "shipping.task_group.driver_assigned.insurance_valid"
35   ],
36   "checks": [
37     {
38       "schema_version": 1,
39       "check": "shipping.order.placed.order_details_reviewed",
40       "entity_id": "order_987654321",
41       "status": "not_started",
42       "completed_at_timestamp": null
43     }
44   ],
45   "checks_summary": {
46     "schema_version": 1,
47     "applied_checklist_ids": [
48       "checklist_standard_shipping"
49     ],
50     "success_count": 3,
51     "failure_count": 1,
52     "unsure_count": 0,
53     "error_count": 0,
54     "failure_check_keys": [
55       "shipping.task_group.driver_assigned.vehicle_type_compatible"
56     ],
57     "unsure_check_keys": [],
58     "error_check_keys": []
59   }
60 }

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

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Response

Successful Response

schema_versioninteger

order_idstring

_idstring

org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

created_atdatetime

order_refstringformat: "^[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).

order_short_idstring

department_idstring

assigned_operator_user_idslist of strings

case_s3_object_metadata_idslist of strings

statusenum

needs_actionbooleanDefaults to true

messageslist of objects

enabled_check_keyslist of enums

disabled_check_keyslist of enums

checkslist of objects

checks_summaryobject

Denormalized summary cache for Case.checks plus applied-Checklist log.

Embedded at Case.checks_summary. Rewritten on every mutation of Case.checks (or applied_checklist_ids) so the operator dashboard can filter / sort / count Cases without scanning the checks array. Dismissed checks are excluded from every cache field.

OperationsEventEnum is exported alongside this model because the Case-level event log (forthcoming) will key off the same vocabulary; keeping the import here documents the shared dependency.

Errors

422

Cases Get by Order V1request Unprocessable Entity Error