Get by ID

GET

/orgs/off_chrt_shipper_org/v1/:id

GET

/orgs/off_chrt_shipper_org/v1/:id

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.offChrtShipperOrg.getByIdV1("id");
8 }
9 main();

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

Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful Response

_idstring

created_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

email_address_primarystring

schema_versioninteger

company_namestring

contact_first_namestring

contact_last_namestring

email_address_secondarystring

industrystring

job_titlestring

notesstring<=524288 characters

phone_number_primarystring

phone_number_secondarystring

shipper_customer_id_for_stripe_connect_accountstring

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.

Errors

422

Off Chrt Shipper Org Get by ID V1request Unprocessable Entity Error