By task group

GET

/listing/listings/by_task_group/v1/:task_group_id

GET

/listing/listings/by_task_group/v1/:task_group_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.listings.byTaskGroupV1("task_group_id");
8 }
9 main();

1 [
2   {
3     "_id": "_id",
4     "audience": "providers",
5     "created_at_timestamp": "2024-01-15T09:30:00Z",
6     "created_by_org_id": "created_by_org_id",
7     "created_by_user_id": "created_by_user_id",
8     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
9     "listing_description": "listing_description",
10     "order_id": "order_id",
11     "order_short_id": "order_short_id",
12     "status": "open",
13     "task_group_id": "task_group_id",
14     "task_group_summary_for_bidders": "task_group_summary_for_bidders",
15     "accepted_bid_thread_id": "accepted_bid_thread_id",
16     "auto_award_first_accept": true,
17     "auto_open_priced_bid_threads": true,
18     "driver_bidding_group_ids": [
19       "driver_bidding_group_ids"
20     ],
21     "internal_notes": "internal_notes",
22     "order_off_chrt_reference_id": "order_off_chrt_reference_id",
23     "org_bidding_group_ids": [
24       "org_bidding_group_ids"
25     ],
26     "participant_driver_ids": [
27       "participant_driver_ids"
28     ],
29     "participant_provider_org_ids": [
30       "participant_provider_org_ids"
31     ],
32     "pro_forma_line_items": [
33       {
34         "currency_code": "USD",
35         "description": "description",
36         "line_item_type": "base_rate",
37         "provenance": "rate_sheet",
38         "quantity": 1.1,
39         "unit_price": 1.1
40       }
41     ],
42     "schema_version": 1,
43     "share_pro_forma_line_items": true,
44     "type": "dispatch"
45   }
46 ]

Fetches all listings for a single task group. Typically returns one or two (dual-audience siblings) OPEN listings during active bidding plus any terminal history. Visible only to the task group’s coordinator. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[Listing1])

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Response

Successful Response

_idstring

audienceenum

created_at_timestampdatetime

created_by_org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

last_edited_at_timestampdatetime

listing_descriptionstring

order_idstring

order_short_idstring

statusenum

task_group_idstring

task_group_summary_for_biddersstring

accepted_bid_thread_idstringOptional

auto_award_first_acceptbooleanOptionalDefaults to false

auto_open_priced_bid_threadsbooleanOptionalDefaults to false

driver_bidding_group_idslist of stringsOptional

internal_notesstringOptional<=524288 characters

order_off_chrt_reference_idstringOptionalformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, ’.’, ’_’, ’~’, ’-’ (RFC 3986 unreserved).

org_bidding_group_idslist of stringsOptional

participant_driver_idslist of stringsOptional

participant_provider_org_idslist of stringsOptional

pro_forma_line_itemslist of objectsOptional

schema_versionintegerOptionalDefaults to 1

share_pro_forma_line_itemsbooleanOptionalDefaults to false

typeenumOptional

Errors

422

Listings by Task Group V1request Unprocessable Entity Error