List by org (lister)

GET

/listing/listings/list_by_org/v1

GET

/listing/listings/list_by_org/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.listing.listings.listByOrgV1({
8         filter_audience: "providers",
9         sort_by: "created_at_timestamp",
10         sort_order: "asc",
11         page: 1,
12         page_size: 1,
13         filter_task_group_id: "filter_task_group_id",
14         filter_order_id: "filter_order_id",
15         filter_created_by_org_id: "filter_created_by_org_id",
16         filter_created_by_user_id: "filter_created_by_user_id",
17         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
18         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
19         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
20         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
21     });
22 }
23 main();

1 {
2   "items": [
3     {
4       "listing_description": "Urgent shipment of electronics from warehouse A to distribution center B",
5       "task_group_id": "tg_9f8e7d6c5b4a3",
6       "task_group_summary_for_bidders": "Handle fragile electronics with priority delivery within 24 hours",
7       "audience": "providers",
8       "created_by_user_id": "user_abc123def456",
9       "created_by_org_id": "org_12345abcde",
10       "created_at_timestamp": "2024-01-15T09:30:00Z",
11       "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
12       "status": "open",
13       "order_id": "order_20240115_001",
14       "order_short_id": "ORD-015",
15       "_id": "listing_00123abc",
16       "schema_version": 1,
17       "pro_forma_line_items": [
18         {
19           "item": "base_rate",
20           "rate": 150.75,
21           "quantity": 1,
22           "provenance": "rate_sheet"
23         }
24       ],
25       "share_pro_forma_line_items": true,
26       "participant_provider_org_ids": [
27         "org_12345abcde"
28       ],
29       "org_bidding_group_ids": [
30         "bg_67890fghij"
31       ],
32       "participant_driver_ids": [
33         "driver_98765zyxwv"
34       ],
35       "driver_bidding_group_ids": [
36         "dbg_54321lkjhg"
37       ],
38       "type": "dispatch",
39       "auto_award_first_accept": true,
40       "auto_open_priced_bid_threads": true,
41       "internal_notes": "Ensure all items are double packed and labeled fragile",
42       "order_off_chrt_reference_id": "ref_20240115A",
43       "accepted_bid_thread_id": "bidthread_7890abcd"
44     }
45   ],
46   "total_count": 1
47 }

Lists listings owned (created) by the caller’s org with filtering, sorting, and pagination. Lister view. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ListingListRes)

Authentication

AuthorizationBearer

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

Query parameters

filter_audienceenumOptional

Filter to a single audience (PROVIDERS or DRIVERS). Lister-only — bidder routes hardcode audience.

Allowed values:

sort_byenumOptional

Field to sort by.

Allowed values:

sort_orderenumOptional

Sort order (asc or desc).

Allowed values:

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_statusenumOptional

Filter by listing status(es). Multi-select.

Allowed values:

filter_typeenumOptional

Filter by listing type(s). Multi-select.

Allowed values:

filter_task_group_idstringOptional

Filter to listings for this task group.

filter_order_idstringOptional

Filter to listings on this order.

filter_created_by_org_idstringOptional

Filter to listings created by this provider org (lister). Mostly useful on bidder views to slice by lister.

filter_created_by_user_idstringOptional

Filter to listings created by this operator (audit).

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value (inclusive).

filter_last_edited_at_timestamp_gtedatetimeOptional

Filter last_edited_at_timestamp >= value (inclusive).

filter_last_edited_at_timestamp_ltedatetimeOptional

Filter last_edited_at_timestamp <= value (inclusive).

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Listings List by Org V1request Unprocessable Entity Error