Preview | Chrt

1 import { ChrtClient } from "@chrt-inc/typescript-sdk"; 2 3 async function main() { 4 const client = new ChrtClient({ 5 environment: "https://localhost:8000", 6 token: "YOUR_TOKEN_HERE", 7 }); 8 await client.shipperPayCourierStatements.previewV1({ 9 order_id_or_short_id: "string", 10 }); 11 } 12 main();

1 { 2 "task_groups": [ 3 { 4 "schema_version": 1, 5 "_id": "string", 6 "order_id": "string", 7 "order_short_id": "string", 8 "created_by_org_id": "string", 9 "created_by_user_id": "string", 10 "draft_started_at_timestamp": "2024-01-15T09:30:00Z", 11 "task_group_type": "chrt_ground_courier", 12 "task_ids": [ 13 "string" 14 ], 15 "courier_org_id": "string", 16 "driver_id": "string", 17 "task_group_s3_object_metadata_ids": [ 18 "string" 19 ], 20 "status": "draft", 21 "staged_at_timestamp": "2024-01-15T09:30:00Z", 22 "in_progress_at_timestamp": "2024-01-15T09:30:00Z", 23 "completed_at_timestamp": "2024-01-15T09:30:00Z", 24 "skipped_at_timestamp": "2024-01-15T09:30:00Z", 25 "exception_at_timestamp": "2024-01-15T09:30:00Z", 26 "order_cancelled": false, 27 "task_group_mileage": { 28 "tasks_mileage": 1.1, 29 "deadhead_mileage": 1.1 30 }, 31 "flight_number": "string", 32 "fa_flight_id": "string", 33 "messages": [ 34 { 35 "message": "string", 36 "user_id": "string", 37 "org_id": "string", 38 "timestamp": "2024-01-15T09:30:00Z" 39 } 40 ] 41 } 42 ], 43 "line_item_groups": [ 44 { 45 "schema_version": 1, 46 "task_group_id": "string", 47 "courier_org_id": "string", 48 "rate_sheet_id": "string", 49 "line_items": [ 50 { 51 "schema_version": 1, 52 "item": "base_rate", 53 "quantity": 1.1, 54 "rate": 1.1, 55 "comment": "string", 56 "created_at_timestamp": "2024-01-15T09:30:00Z", 57 "uuid_str": "string" 58 } 59 ], 60 "_id": "string", 61 "shipper_org_id": "string", 62 "off_chrt_shipper_org_id": "string", 63 "order_cancelled": false 64 } 65 ], 66 "total_amount": 1.1, 67 "statement_ready": true 68 }

Previews a shipper-to-courier statement showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierStatementReq) -> (StatementPreviewResponse)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

order_id_or_short_idstringRequired

Response

Successful Response

task_groupslist of objects

line_item_groupslist of objects

total_amountdouble

statement_readyboolean

Authentication

Request

Response

Errors