Retrieve booking record

GET

/integrations/webcargo_bookings/retrieve/v1/:task_group_id

GET

/integrations/webcargo_bookings/retrieve/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.integrations.webcargoBookings.retrieveV1("task_group_id");
8 }
9 main();

1 {
2   "_id": "_id",
3   "awb_number": "awb_number",
4   "booking_rate": {
5     "commodity_classification": [
6       {}
7     ],
8     "connection": {
9       "general_charges": [
10         {}
11       ],
12       "segments": [
13         {}
14       ]
15     },
16     "destination_location": {
17       "country_id": "country_id",
18       "country_name": "country_name",
19       "location_code": "location_code",
20       "location_name": "location_name",
21       "location_type_code": "location_type_code",
22       "postal_code": "postal_code"
23     },
24     "hash": "hash",
25     "latest_acceptance_date": "latest_acceptance_date",
26     "load": {
27       "packages": [
28         {}
29       ],
30       "total_quantity": "total_quantity"
31     },
32     "origin_location": {
33       "country_id": "country_id",
34       "country_name": "country_name",
35       "location_code": "location_code",
36       "location_name": "location_name",
37       "location_type_code": "location_type_code",
38       "postal_code": "postal_code"
39     },
40     "price_indicator": {
41       "rate_currency": "rate_currency",
42       "rate_type": "rate_type",
43       "total_charge": "total_charge",
44       "unit_of_measure": "unit_of_measure",
45       "unit_rate": "unit_rate",
46       "valid_from": "valid_from",
47       "valid_to": "valid_to"
48     },
49     "product": {
50       "product_code": "product_code",
51       "product_description": "product_description"
52     },
53     "reference_id": "reference_id",
54     "shipment_priority_code": "shipment_priority_code",
55     "special_handling_codes": [
56       "special_handling_codes"
57     ],
58     "time_of_availability": "time_of_availability",
59     "transport_mode": "transport_mode"
60   },
61   "business_info": {
62     "method_reason": "method_reason",
63     "parties": [
64       {}
65     ],
66     "service_method": "service_method"
67   },
68   "document_identifiers": [
69     {
70       "document_id": "document_id",
71       "document_type": "document_type",
72       "external_booking_reference_number": "external_booking_reference_number"
73     }
74   ],
75   "message_header": {
76     "message_id": "message_id",
77     "request_id": "request_id"
78   },
79   "org_id": "org_id",
80   "schema_version": 1,
81   "synced_at": "2024-01-15T09:30:00Z",
82   "task_group_id": "task_group_id",
83   "response_status": {
84     "statuses": [
85       {}
86     ]
87   },
88   "shipment": {
89     "latest_acceptance_date": "latest_acceptance_date",
90     "time_of_availability": "time_of_availability",
91     "transport_mode": "transport_mode"
92   }
93 }

Retrieves the stored WebCargo booking record for a task group. Returns 404 if the booking has never been synced. | () -> (WebcargoBookingRecord1)

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Response

Successful Response

_idstring

awb_numberstring

booking_rateobject

business_infoobject

document_identifierslist of objects

message_headerobject

org_idstring

Must be a string starting with org_

schema_versioninteger

synced_atdatetime

task_group_idstring

response_statusobjectOptional

shipmentobjectOptional

Errors

422

Webcargo Bookings Retrieve V1request Unprocessable Entity Error