List shippers

GET

/orgs/connections/shippers/list/v1

GET

/orgs/connections/shippers/list/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.connections.listShippersV1();
8 }
9 main();

200Retrieved

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

Lists shipper organizations based on the caller’s organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (list[ShipperConnectionRes])

Authentication

AuthorizationBearer

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

Response

Successful Response

shipper_org_info_for_connectionsobject

connectedboolean