Get by handle

GET

/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

ShipperCourierConnection1object

ShipperForwarderConnection1object

ForwarderCourierConnection1object

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.connections.getByHandleV1("handle");
9	}
10	main();

1	{
2	"schema_version": 1,
3	"shipper_org_id": "string",
4	"courier_org_id": "string",
5	"connected": false,
6	"shipper_customer_id_for_courier_stripe_connect_account": "string",
7	"_id": "string"
8	}

Authentication

Path parameters

Response

Errors