Preview line items

Previews calculated line items for a driver based on a rate sheet and task group. Does not write to the database.

AuthorizationBearer

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

driver_idstringRequired

This endpoint expects an object.

courier_pay_driver_rate_sheet_idstringRequired

ID of the courier pay driver 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

driver_idstring

task_group_idstring

courier_org_idstring

Must be a string starting with org_

line_itemslist of objects

rate_sheet_idstring

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.courierPayDriverLineItemGroups.previewV1("driver_id", {
5	courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
6	task_group_id: "task_group_id"
7	});