API ReferenceOff Chrt Shipper Org Info

Create connection info

Creates connection information for working with off-platform shipper organizations.

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
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
company_namestring or nullOptional
stripe_connect_shipper_pay_courier_customer_idstring or nullOptional

Response

Successful Response

Errors