Preview line items

Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.

AuthorizationBearer

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

This endpoint expects an object.

shipper_pay_courier_rate_sheet_idstringRequired

ID of the shipper pay courier rate sheet

task_group_idstringRequired

ID of the task group

dangerous_goodsbooleanOptionalDefaults to false

Whether the shipment contains dangerous goods

holidaybooleanOptionalDefaults to false

Whether the delivery is on a holiday

weekendbooleanOptionalDefaults to false

Whether the delivery is on a weekend

after_hoursbooleanOptionalDefaults to false

Whether the delivery is after hours

Successful Response

schema_versioninteger

task_group_idstring

courier_org_idstring

Must be a string starting with org_

rate_sheet_idstring

line_itemslist of objects

shipper_org_idstring or null

off_chrt_shipper_org_info_idstring or null

order_cancelledboolean or nullDefaults to false

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	const client = new ChrtClient({ token: "YOUR_TOKEN" });
4	await client.shipperPayCourierLineItemGroups.previewV1({
5	shipper_pay_courier_rate_sheet_id: "shipper_pay_courier_rate_sheet_id",
6	task_group_id: "task_group_id"
7	});

1	{
2	"schema_version": 1,
3	"task_group_id": "string",
4	"courier_org_id": "string",
5	"rate_sheet_id": "string",
6	"line_items": [
7	{
8	"schema_version": 1,
9	"item": "base_rate",
10	"quantity": 1.1,
11	"rate": 1.1,
12	"comment": "string",
13	"created_at": "2024-01-15T09:30:00Z",
14	"uuid_str": "string"
15	}
16	],
17	"shipper_org_id": "string",
18	"off_chrt_shipper_org_info_id": "string",
19	"order_cancelled": false
20	}