List for driver bidder

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.listing.listings.listForDriverBidderV1({
        sort_by: "created_at_timestamp",
        sort_order: "asc",
        page: 1,
        page_size: 1,
        filter_task_group_id: "filter_task_group_id",
        filter_order_id: "filter_order_id",
        filter_created_by_org_id: "filter_created_by_org_id",
        filter_created_by_user_id: "filter_created_by_user_id",
        filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
    });
}
main();

{
  "items": [
    {
      "_id": "listing_9f8b7c6d5a4e3f21",
      "listing_description": "Urgent dispatch needed for refrigerated cargo from Port of Seattle to Spokane warehouse.",
      "task_group_id": "tg_4a3b2c1d9e8f7g6h",
      "task_group_summary_for_bidders": "Refrigerated cargo transport, priority delivery within 24 hours.",
      "audience": "drivers",
      "created_by_user_id": "user_abc123xyz",
      "created_by_org_id": "org_7f6e5d4c3b2a1f0e",
      "created_at_timestamp": "2024-04-10T14:22:00Z",
      "last_edited_at_timestamp": "2024-04-12T08:15:00Z",
      "status": "open",
      "order_id": "order_20240410_001",
      "order_short_id": "ORD-0410-001",
      "schema_version": 1,
      "pro_forma_line_items": [
        {
          "item": "base_rate",
          "rate": 1500,
          "quantity": 1,
          "provenance": "rate_sheet"
        },
        {
          "item": "fuel",
          "rate": 300.5,
          "quantity": 1,
          "provenance": "ad_hoc",
          "comments": "Fuel surcharge due to increased prices"
        }
      ],
      "share_pro_forma_line_items": true,
      "participant_provider_org_ids": [
        "org_7f6e5d4c3b2a1f0e"
      ],
      "org_bidding_group_ids": [
        "bidgroup_12345"
      ],
      "participant_driver_ids": [
        "driver_98765"
      ],
      "driver_bidding_group_ids": [
        "driverbidgroup_54321"
      ],
      "type": "dispatch",
      "auto_award_first_accept": false,
      "auto_open_priced_bid_threads": true,
      "order_off_chrt_reference_id": "REF20240410A",
      "accepted_bid_thread_id": null
    }
  ],
  "total_count": 1
}

Lists DRIVERS-audience listings where the caller (resolved to a Driver of their org) is a snapshot participant. Driver-side bidder view with filtering, sorting, and pagination. Returns the bidder shape (no internal_notes). | authz: allowed_org_types=[provider], min_org_role=driver | () -> (ListingForBidderListRes)

Authentication

AuthorizationBearer

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

Query parameters

sort_byenum or nullOptional

Field to sort by.

Allowed values:

sort_orderenum or nullOptional

Sort order (asc or desc).

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

filter_statusenum or nullOptional

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

Allowed values:

filter_typeenum or nullOptional

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

Allowed values:

filter_task_group_idstring or nullOptional

Filter to listings for this task group.

filter_order_idstring or nullOptional

Filter to listings on this order.

filter_created_by_org_idstring or nullOptional

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

filter_created_by_user_idstring or nullOptional

Filter to listings created by this operator (audit).

filter_created_at_timestamp_gtedatetime or nullOptional

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltedatetime or nullOptional

Filter created_at_timestamp <= value (inclusive).

filter_last_edited_at_timestamp_gtedatetime or nullOptional

Filter last_edited_at_timestamp >= value (inclusive).

filter_last_edited_at_timestamp_ltedatetime or nullOptional

Filter last_edited_at_timestamp <= value (inclusive).

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Listings List for Driver Bidder V1request Unprocessable Entity Error