By id (lister)

GET

/listing/listings/by_id_for_lister/v1/:listing_id

GET

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

1 {
2   "listing_description": "Full truckload shipment from Los Angeles to Chicago",
3   "task_group_id": "tg_9f8e7d6c5b4a3",
4   "task_group_summary_for_bidders": "Transport 20 pallets of electronics, fragile, temperature controlled",
5   "audience": "providers",
6   "created_by_user_id": "user_abc123def456",
7   "created_by_org_id": "org_12345abcde",
8   "created_at_timestamp": "2024-01-15T09:30:00Z",
9   "last_edited_at_timestamp": "2024-01-20T14:45:00Z",
10   "status": "open",
11   "order_id": "order_789xyz123",
12   "order_short_id": "ORD789XYZ",
13   "_id": "listing_00123abc",
14   "schema_version": 1,
15   "pro_forma_line_items": [
16     {
17       "item": "base_rate",
18       "rate": 1500,
19       "quantity": 1,
20       "provenance": "rate_sheet",
21       "schema_version": 1,
22       "comments": "Base rate for standard delivery",
23       "units": "usd",
24       "adjustment": -100,
25       "adjustment_comments": "Discount applied for early booking",
26       "rate_sheet_id": "rs_20240115_01",
27       "created_at_timestamp": "2024-01-15T09:30:00Z"
28     }
29   ],
30   "share_pro_forma_line_items": true,
31   "participant_provider_org_ids": [
32     "org_12345abcde"
33   ],
34   "org_bidding_group_ids": [
35     "bg_67890fghij"
36   ],
37   "participant_driver_ids": [
38     "driver_54321zyxwv"
39   ],
40   "driver_bidding_group_ids": [
41     "dbg_09876lkjhg"
42   ],
43   "type": "dispatch",
44   "auto_award_first_accept": true,
45   "auto_open_priced_bid_threads": true,
46   "internal_notes": "Handle with care: fragile electronics, ensure temperature does not exceed 25°C",
47   "order_off_chrt_reference_id": "REF20240115A",
48   "accepted_bid_thread_id": "bidthread_456def789"
49 }

Fetches the full listing record (including internal_notes). Restricted to the lister org — bidders use by_id/v1. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Listing1)

Authentication

AuthorizationBearer

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

Path parameters

listing_idstringRequired

Response

Successful Response

listing_descriptionstring

task_group_idstring

task_group_summary_for_biddersstring

audienceenum

created_by_user_idstring

Must be a string starting with user_

created_by_org_idstring

Must be a string starting with org_

created_at_timestampdatetime

last_edited_at_timestampdatetime

statusenum

order_idstring

order_short_idstring

_idstring

schema_versionintegerDefaults to 1

pro_forma_line_itemslist of objects

share_pro_forma_line_itemsbooleanDefaults to false

participant_provider_org_idslist of strings

org_bidding_group_idslist of strings

participant_driver_idslist of strings

driver_bidding_group_idslist of strings

typeenum

auto_award_first_acceptbooleanDefaults to false

auto_open_priced_bid_threadsbooleanDefaults to false

internal_notesstring<=524288 characters

order_off_chrt_reference_idstringformat: "^[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).

accepted_bid_thread_idstring

Errors

422

Listings by ID for Lister V1request Unprocessable Entity Error