List for listing (lister)

GET

/listing/bid_threads/list_for_listing/v1/:listing_id

GET

/listing/bid_threads/list_for_listing/v1/:listing_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.listing.bidThreads.listForListingV1("listing_id", {
8         sort_by: "created_at_timestamp",
9         sort_order: "asc",
10         page: 1,
11         page_size: 1,
12         filter_listing_id: "filter_listing_id",
13         filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
14         filter_bidder_driver_id: "filter_bidder_driver_id",
15         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
16         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
17         filter_status_changed_at_timestamp_gte: "2024-01-15T09:30:00Z",
18         filter_status_changed_at_timestamp_lte: "2024-01-15T09:30:00Z",
19     });
20 }
21 main();

1 {
2   "items": [
3     {
4       "listing_id": "listing_9f8b7c6d5a4e3f21",
5       "created_at_timestamp": "2024-01-15T09:30:00Z",
6       "status": "open",
7       "status_changed_at_timestamp": "2024-01-15T09:30:00Z",
8       "bids": [
9         {
10           "action": "submit",
11           "acted_by_user_id": "user_98765fghij",
12           "from_lister": true,
13           "created_at_timestamp": "2024-01-15T09:30:00Z"
14         }
15       ],
16       "_id": "bidthread_abc123xyz789",
17       "schema_version": 1,
18       "bidder_provider_org_id": "org_12345abcde",
19       "bidder_driver_id": "driver_67890xyz",
20       "accepted_pro_forma_line_items": [
21         {
22           "item": "base_rate",
23           "rate": 1500,
24           "quantity": 1,
25           "provenance": "rate_sheet",
26           "schema_version": 1,
27           "comments": null,
28           "units": "usd",
29           "adjustment": null,
30           "adjustment_comments": null,
31           "rate_sheet_id": "rs_20240115",
32           "created_at_timestamp": "2024-01-10T08:00:00Z"
33         }
34       ]
35     }
36   ],
37   "total_count": 1
38 }

Lists all bid threads on a listing with filtering, sorting, and pagination. Lister-only — the listing must belong to the caller’s org. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (BidThreadListRes)

Authentication

AuthorizationBearer

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

Path parameters

listing_idstringRequired

Query parameters

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 thread status(es). Multi-select.

Allowed values:

filter_listing_idstringOptional

Filter to threads on this listing. Lister route ignores this field (path param wins); bidder route uses it to slice within the caller’s bidder universe.

filter_bidder_provider_org_idstringOptional

Filter to threads where the bidder is this provider org. Useful on lister views to slice by bidder.

filter_bidder_driver_idstringOptional

Filter to threads where the bidder is this driver. Useful on lister views to slice by driver bidder.

filter_created_at_timestamp_gtedatetimeOptional

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltedatetimeOptional

Filter created_at_timestamp <= value (inclusive).

filter_status_changed_at_timestamp_gtedatetimeOptional

Filter status_changed_at_timestamp >= value (inclusive).

filter_status_changed_at_timestamp_ltedatetimeOptional

Filter status_changed_at_timestamp <= value (inclusive).

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Bid Threads List for Listing V1request Unprocessable Entity Error