List by order

import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        environment: ChrtEnvironment.Local,
        token: "YOUR_TOKEN_HERE",
    });
    await client.notifications.adHoc.listByOrderIdV1("order_id");
}
main();

[
  {
    "schema_version": 1,
    "created_at_timestamp": "2024-01-15T09:30:00Z",
    "created_by_org_id": "org_9f8e7d6c5b4a3",
    "created_by_user_id": "user_123abc456def",
    "order_id": "order_20240115_0001",
    "directory_entry_id": "dir_789xyz654wvu",
    "_id": "notif_001a2b3c4d5e6f7g8h9i",
    "email_events": [
      "shipping.order.staged"
    ],
    "push_events": [
      "shipping.order.staged"
    ],
    "sms_events": [
      "shipping.order.staged"
    ]
  }
]

Lists all ad-hoc notification intents for an order. | authz: min_org_role=operator | () -> (list[NotificationIntentAdHoc1])

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Response

Successful Response

schema_versioninteger

created_at_timestampstringformat: "date-time"

created_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

order_idstring

directory_entry_idstring

_idstring

email_eventslist of enums or null

Allowed values:

push_eventslist of enums or null

Allowed values:

sms_eventslist of enums or null

Allowed values:

Authentication

Path parameters

Response

Errors