Get by handle

GET

/orgs/connections/by_handle/:handle/v1

Gets connection between caller’s org and org with specified handle. | () -> (ShipperCourierConnection1 | ShipperForwarderConnection1 | ForwarderCourierConnection1 | None)

Authentication

AuthorizationBearer

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

Path parameters

handlestringRequired

Response

Successful Response

Shipper Courier Connection1object

Shipper Forwarder Connection1object

Forwarder Courier Connection1object

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.orgs.connections.getByHandleV1("handle");
8	}
9	main();

1	{
2	"schema_version": 1,
3	"shipper_org_id": "shipper_org_id",
4	"courier_org_id": "courier_org_id",
5	"connected": true,
6	"shipper_customer_id_for_courier_stripe_connect_account": "shipper_customer_id_for_courier_stripe_connect_account",
7	"default_rate_sheet__routed": "default_rate_sheet__routed",
8	"default_rate_sheet__on_demand": "default_rate_sheet__on_demand",
9	"_id": "_id"
10	}

Authentication

Path parameters

Response

Errors