List by order

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

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

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

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Ad Hoc List by Order ID V1request Unprocessable Entity Error