Create org | Chrt

Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientCreate1) -> (PydanticObjectId)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

schema_versionintegerRequired

email_address_primarystringRequired

company_namestring or nullOptional

industrystring or nullOptional

street_addressobject or nullOptional

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

contact_first_namestring or nullOptional

contact_last_namestring or nullOptional

phone_number_primarystring or nullOptionalformat: "phone"

phone_number_secondarystring or nullOptionalformat: "phone"

email_address_secondarystring or nullOptional

job_titlestring or nullOptional

notesstring or nullOptional

shipper_customer_id_for_stripe_connect_accountstring or nullOptional

default_rate_sheet__routedstring or nullOptional

default_rate_sheet__on_demandstring or nullOptional

Response

Successful Response

1	import { ChrtClient, ChrtEnvironment } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	environment: ChrtEnvironment.Local,
6	token: "YOUR_TOKEN_HERE",
7	});
8	await client.offChrtShipperOrg.createV1({
9	schema_version: 1,
10	email_address_primary: "contact@globalshipper.com",
11	});
12	}
13	main();

Authentication

Request

Response

Errors