By id

GET

/listing/listings/by_id/v1/:listing_id

GET

/listing/listings/by_id/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.listings.byIdV1("listing_id");
8 }
9 main();

1 {
2   "listing": {
3     "_id": "listing_987654321",
4     "listing_description": "Urgent delivery of electronics from warehouse to retail store",
5     "task_group_id": "tg_123456789",
6     "task_group_summary_for_bidders": "Pickup at warehouse, deliver to retail location, handle with care",
7     "audience": "providers",
8     "created_by_user_id": "user_123456789",
9     "created_by_org_id": "org_987654321",
10     "created_at_timestamp": "2024-04-10T08:15:00Z",
11     "last_edited_at_timestamp": "2024-04-12T14:45:00Z",
12     "status": "open",
13     "order_id": "order_20240410_001",
14     "order_short_id": "ORD20240410",
15     "schema_version": 1,
16     "pro_forma_line_items": [
17       {
18         "item": "base_rate",
19         "rate": 150.75,
20         "quantity": 1,
21         "provenance": "rate_sheet"
22       }
23     ],
24     "share_pro_forma_line_items": true,
25     "participant_provider_org_ids": [
26       "org_456789123"
27     ],
28     "org_bidding_group_ids": [
29       "bidding_group_001"
30     ],
31     "participant_driver_ids": [
32       "driver_789123456"
33     ],
34     "driver_bidding_group_ids": [
35       "driver_bidding_group_01"
36     ],
37     "type": "dispatch",
38     "auto_award_first_accept": true,
39     "auto_open_priced_bid_threads": true,
40     "order_off_chrt_reference_id": "REF12345_ABC",
41     "accepted_bid_thread_id": "bid_thread_555666777"
42   },
43   "task_group": {
44     "mileage_estimated": 125.4,
45     "tasks": [
46       {
47         "task_id": "task_001_pickup",
48         "action": "chrt_ground_provider__pickup",
49         "location": {
50           "type": "Feature",
51           "geometry": {
52             "type": "Point",
53             "coordinates": [
54               -122.4014,
55               37.7858
56             ]
57           },
58           "properties": {
59             "address": "1234 Warehouse Rd, San Francisco, CA 94107",
60             "name": "Main Warehouse"
61           },
62           "id": "loc_warehouse_01"
63         }
64       },
65       {
66         "task_id": "task_002_deliver",
67         "action": "chrt_ground_provider__deliver",
68         "location": {
69           "type": "Feature",
70           "geometry": {
71             "type": "Point",
72             "coordinates": [
73               -122.4065,
74               37.789
75             ]
76           },
77           "properties": {
78             "address": "5678 Market St, San Francisco, CA 94103",
79             "name": "Retail Store"
80           },
81           "id": "loc_retail_01"
82         }
83       }
84     ]
85   }
86 }

Fetches a listing by id in the bidder-facing shape with tasks and mileage. Visible to the lister and to snapshot participants (as bidder — provider org or driver). Listers wanting the full record call by_id_for_lister/v1. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (ListingForBidder1)

Authentication

AuthorizationBearer

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

Path parameters

listing_idstringRequired

Response

Successful Response

listingobject

Bidder-facing response shape — same as Listing1 minus internal_notes.

Used by get__listings_by_id_v1, list_for_provider_bidder/v1, and list_for_driver_bidder/v1. Constructed from a validated Listing1; field-shape parity is enforced at import time by limited_model_checker below.

task_groupobject

Errors

422

Listings by ID V1request Unprocessable Entity Error