List for bidder

GET

/listing/bid_threads/list_for_bidder/v1

GET

/listing/bid_threads/list_for_bidder/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.listing.bidThreads.listForBidderV1({
        filter_bidder_driver_id: "filter_bidder_driver_id",
        filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
        filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_listing_id: "filter_listing_id",
        filter_status: [
            "open",
        ],
        filter_status_changed_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_status_changed_at_timestamp_lte: "2024-01-15T09:30:00Z",
        page: 1,
        page_size: 1,
        sort_by: "created_at_timestamp",
        sort_order: "asc",
    });
}
main();

{
  "items": [
    {
      "_id": "_id",
      "bids": [
        {
          "acted_by_user_id": "acted_by_user_id",
          "action": "submit",
          "created_at_timestamp": "2024-01-15T09:30:00Z",
          "from_lister": true
        }
      ],
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "listing_id": "listing_id",
      "status": "open",
      "status_changed_at_timestamp": "2024-01-15T09:30:00Z",
      "accepted_pro_forma_line_items": [
        {
          "currency_code": "USD",
          "description": "description",
          "line_item_type": "base_rate",
          "provenance": "rate_sheet",
          "quantity": 1.1,
          "unit_price": 1.1
        }
      ],
      "bidder_driver_id": "bidder_driver_id",
      "bidder_provider_org_id": "bidder_provider_org_id",
      "schema_version": 1
    }
  ],
  "total_count": 1
}

Lists bid threads where the caller is the bidder — either as the bidder org (operator+) or as the bidder driver (driver). Filtering, sorting, and pagination supported. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (BidThreadListRes)

Authentication

AuthorizationBearer

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

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 Bidder V1request Unprocessable Entity Error