Get by order short ID

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.operations.cases.getByOrderShortIdV1("order_short_id");
}
main();

{
  "schema_version": 1,
  "order_id": "order_id",
  "_id": "_id",
  "org_id": "org_id",
  "created_by_user_id": "created_by_user_id",
  "created_at": "2024-01-15T09:30:00Z",
  "order_ref": "order_ref",
  "order_short_id": "order_short_id",
  "department_id": "department_id",
  "assigned_operator_user_ids": [
    "assigned_operator_user_ids"
  ],
  "case_s3_object_metadata_ids": [
    "case_s3_object_metadata_ids"
  ],
  "status": "open",
  "needs_action": true,
  "messages": [
    {
      "message": "message",
      "user_id": "user_id",
      "org_id": "org_id",
      "timestamp": "2024-01-15T09:30:00Z",
      "id": "id"
    }
  ]
}

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

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

Allowed values:

needs_actionbooleanDefaults to true

messageslist of objects

Errors

422

Cases Get by Order Short ID V1request Unprocessable Entity Error