Get | Chrt

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.trackingIntegrations.tive.shipments.getV1({
        tive_shipment_id: "shipment_9f8b7c6d5a4e3f2b1c0d",
    });
}
main();

{
  "schema_version": 1,
  "_id": "shp_1234567890abcdef",
  "org_id": "org_9876543210fedcba",
  "tive_device_object_id": "device_abcdef1234567890",
  "tive_shipment_id": "shipment_9f8b7c6d5a4e3f2b1c0d",
  "chrt_created_at_timestamp": "2024-01-15T09:30:00Z",
  "chrt_updated_at_timestamp": "2024-01-15T09:30:00Z",
  "tive_public_shipment_id": "public_shipment_0011223344",
  "tive_shipment_status": {
    "status": "in_transit",
    "last_location": "Dallas, TX",
    "estimated_delivery": "2024-01-20T18:00:00Z"
  }
}

Retrieves a single Tive shipment by its ID. Scoped to the caller’s organization. | authz: min_org_role=operator | () -> (TiveShipment1)

Authentication

AuthorizationBearer

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

Query parameters

tive_shipment_idstringRequired

Response

Successful Response

schema_versioninteger

_idstring

org_idstring

Must be a string starting with org_

tive_device_object_idstring

tive_shipment_idstring

chrt_created_at_timestampdatetime

chrt_updated_at_timestampdatetime

tive_public_shipment_idstring or null

tive_shipment_statusmap from strings to any

Errors

422

Shipments Get V1request Unprocessable Entity Error