List for driver bidder

GET

/listing/listings/list_for_driver_bidder/v1

GET

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

1 {
2   "items": [
3     {
4       "listing": {
5         "_id": "_id",
6         "listing_description": "listing_description",
7         "task_group_id": "task_group_id",
8         "task_group_summary_for_bidders": "task_group_summary_for_bidders",
9         "audience": "providers",
10         "created_by_user_id": "created_by_user_id",
11         "created_by_org_id": "created_by_org_id",
12         "created_at_timestamp": "2024-01-15T09:30:00Z",
13         "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
14         "status": "open",
15         "order_id": "order_id",
16         "order_short_id": "order_short_id"
17       },
18       "task_group": {}
19     }
20   ],
21   "total_count": 1
22 }

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 with tasks and mileage (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_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 for Driver Bidder V1request Unprocessable Entity Error