Retrieve CHAMP flight status updates

GET

/integrations/air_waybills/flight_statuses/v1/:task_group_id

GET

/integrations/air_waybills/flight_statuses/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.airWaybills.flightStatusesV1("task_group_id");
8 }
9 main();

1 [
2   {
3     "_id": "63f9a1b2e4b0c123456789ab",
4     "airWaybillNumber": "123-45678901",
5     "champId": "CHAMP-987654321",
6     "messageHeader": {
7       "addressing": {
8         "finalRecipientAddresses": [
9           {
10             "address": "PIMA67890",
11             "type": "PIMA"
12           }
13         ],
14         "replyAnswerTo": [
15           {
16             "address": "PIMA54321",
17             "type": "PIMA"
18           }
19         ],
20         "routeAnswerVia": null,
21         "routeVia": null,
22         "senderAddresses": [
23           {
24             "address": "PIMA12345",
25             "type": "PIMA"
26           }
27         ]
28       },
29       "creationDate": "2024-01-15T09:30:00Z",
30       "edifactData": null
31     },
32     "receivedAt": "2024-01-15T09:30:00Z",
33     "type": "flight status",
34     "events": [
35       {
36         "type": "departure",
37         "dateOfScheduledDeparture": "2024-01-15",
38         "destination": "JFK",
39         "flight": "LH1234",
40         "numberOfPieces": 10,
41         "origin": "FRA",
42         "timeOfEvent": "2024-01-15T14:45:00Z",
43         "timeOfScheduledDeparture": "14:30",
44         "weight": {
45           "amount": 1500.5,
46           "unit": "KILOGRAM"
47         }
48       }
49     ],
50     "orgId": "org_1234567890",
51     "originAndDestination": {
52       "destination": "JFK",
53       "origin": "FRA"
54     },
55     "quantity": {
56       "numberOfPieces": 10,
57       "shipmentDescriptionCode": "ELEC",
58       "weight": {
59         "amount": 1500.5,
60         "unit": "KILOGRAM"
61       }
62     },
63     "schemaVersion": 1,
64     "taskGroupId": "taskgroup-20240115-001",
65     "totalNumberOfPieces": 10
66   }
67 ]

Retrieves all CHAMP flight status updates linked to the air waybill for a task group. | () -> (list[ChampFlightStatus1])

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Response

Successful Response

_idstring

airWaybillNumberstring

champIdstring

messageHeaderobject

[GENERATED/CONFIG] Message header with addressing and creation timestamp.

receivedAtdatetime

type"flight status"

eventslist of objectsOptional

orgIdstringOptional

Must be a string starting with org_

originAndDestinationobjectOptional

quantityobjectOptional

schemaVersionintegerOptionalDefaults to 1

taskGroupIdstringOptional

totalNumberOfPiecesintegerOptional

Errors

422

Air Waybills Flight Statuses V1request Unprocessable Entity Error