List | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.trackingIntegrations.tive.shipments.listV1({
        sort_by: "chrt_created_at_timestamp",
        sort_order: "asc",
        page: 1,
        page_size: 1,
        filter_tive_device_object_id: "filter_tive_device_object_id",
        filter_tive_shipment_id: "filter_tive_shipment_id",
        filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
    });
}
main();

{
  "items": [
    {
      "schema_version": 1,
      "_id": "shp_9f8b7c6d5e4a3b2c1d0e",
      "org_id": "org_1234567890abcdef",
      "tive_device_object_id": "dev_abcdef1234567890",
      "tive_shipment_id": "shipment_20240115_001",
      "chrt_created_at_timestamp": "2024-01-15T09:30:00Z",
      "chrt_updated_at_timestamp": "2024-01-15T12:45:00Z",
      "tive_public_shipment_id": "public_shipment_20240115_001",
      "tive_shipment_status": {
        "status": "in_transit",
        "last_location": "Dallas, TX",
        "temperature_celsius": 4.5,
        "battery_level_percent": 85
      }
    }
  ],
  "total_count": 1
}

Lists Tive shipments with filtering, sorting, and pagination. Scoped to the caller’s organization. | authz: min_org_role=operator | () -> (TiveShipmentListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenum or nullOptional

Field to sort by

Allowed values:

sort_orderenum or nullOptional

Sort order (asc or desc)

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

filter_tive_device_object_idstring or nullOptional

Filter by Tive device object ID

filter_tive_shipment_idstring or nullOptional

Filter by Tive shipment ID (exact match)

filter_chrt_created_at_timestamp_gtedatetime or nullOptional

Filter by chrt_created_at_timestamp >= value

filter_chrt_created_at_timestamp_ltedatetime or nullOptional

Filter by chrt_created_at_timestamp <= value

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Shipments List V1request Unprocessable Entity Error