List shippers

GET

/orgs/connections/shippers/list/for_coordinator/v1

GET

/orgs/connections/shippers/list/for_coordinator/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.listShippersForCoordinatorV1({
8         filter_connected: true,
9         page: 1,
10         page_size: 1,
11         search: "search",
12     });
13 }
14 main();

1 {
2   "items": [
3     {
4       "shipper_coordinator_connection": {
5         "_id": "_id",
6         "coordinator_org_id": "coordinator_org_id",
7         "schema_version": 1
8       },
9       "off_chrt_shipper_org_data": {
10         "_id": "_id",
11         "created_by_user_id": "created_by_user_id",
12         "name": "name",
13         "org_type": "provider",
14         "owned_by_org_id": "owned_by_org_id",
15         "schema_version": 1
16       },
17       "shipper_org_public_data": {
18         "_id": "_id",
19         "name": "name",
20         "org_id": "org_id",
21         "org_type": "provider",
22         "schema_version": 1
23       }
24     }
25   ],
26   "total_count": 1
27 }

Lists the caller’s shipper connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider] | () -> (ShipperCoordinatorConnectionsForCoordinatorListRes)

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Search by organization identity details

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_connectedbooleanOptional

Filter by connection status

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Connections List Shippers for Coordinator V1request Unprocessable Entity Error