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         search: "search",
9         page: 1,
10         page_size: 1,
11     });
12 }
13 main();

1 {
2   "items": [
3     {
4       "connected": true,
5       "shipper_org_info_for_connections": {
6         "_id": "conn_9f8b7c6d5e4a3b2c1d0e",
7         "email_address_primary": "contact@fastshiplogistics.com",
8         "schema_version": 1,
9         "shipper_org_id": "org_fastship_001",
10         "contact_first_name": "Emily",
11         "contact_last_name": "Johnson",
12         "email_address_secondary": "support@fastshiplogistics.com",
13         "industry": "Logistics and Transportation",
14         "job_title": "Operations Manager",
15         "notes": "Preferred contact for urgent shipments.",
16         "phone_number_primary": "+1-415-555-0198",
17         "phone_number_secondary": "+1-415-555-0123",
18         "shipper_user_id": "user_emilyj_789",
19         "street_address": {
20           "geometry": {
21             "type": "Point",
22             "coordinates": [
23               -122.4194,
24               37.7749
25             ]
26           },
27           "type": "Feature",
28           "id": "loc_001",
29           "properties": {
30             "address": "123 Market St, San Francisco, CA 94103",
31             "name": "FastShip Logistics HQ"
32           }
33         }
34       }
35     }
36   ],
37   "total_count": 1
38 }

Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle. | () -> (ShipperConnectionListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Search by company name or handle

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Connections List Shippers V1request Unprocessable Entity Error