Get shipper info

GET

/orgs/org_info_for_connections/shipper/v1

GET

/orgs/org_info_for_connections/shipper/v1

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.orgInfoForConnections.shipper.getV1();
8 }
9 main();

200Retrieved

1 {
2   "_id": "_id",
3   "email_address_primary": "email_address_primary",
4   "schema_version": 1,
5   "shipper_org_id": "shipper_org_id",
6   "contact_first_name": "contact_first_name",
7   "contact_last_name": "contact_last_name",
8   "email_address_secondary": "email_address_secondary",
9   "industry": "industry",
10   "job_title": "job_title",
11   "notes": "notes",
12   "phone_number_primary": "phone_number_primary",
13   "phone_number_secondary": "phone_number_secondary",
14   "shipper_user_id": "shipper_user_id",
15   "street_address": {
16     "geometry": {
17       "type": "GeometryCollection",
18       "geometries": [
19         {
20           "type": "LineString",
21           "coordinates": [
22             []
23           ]
24         }
25       ]
26     },
27     "type": "Feature",
28     "bbox": [
29       {
30         "key": "value"
31       }
32     ],
33     "id": 1,
34     "properties": {
35       "address": "address",
36       "name": "name"
37     }
38   }
39 }

Retrieves shipper organization connection information for the caller’s organization. | () -> (ShipperOrgInfoForConnections1)

Authentication

AuthorizationBearer

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

Response

Successful Response

_idstring

email_address_primarystring

schema_versioninteger

shipper_org_idstring

Must be a string starting with org_

contact_first_namestring

contact_last_namestring

email_address_secondarystring

industrystring

job_titlestring

notesstring<=524288 characters

phone_number_primarystring

phone_number_secondarystring

shipper_user_idstring

Must be a string starting with user_

street_addressobject

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.