Retrieve air waybill

GET

/integrations/air_waybills/retrieve/v1/:task_group_id

GET

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

1 {
2   "_id": "_id",
3   "airWaybillNumber": "airWaybillNumber",
4   "chargeItems": [
5     {
6       "charges": [
7         {}
8       ],
9       "commodityItemNumber": [
10         "commodityItemNumber"
11       ],
12       "consolidation": true,
13       "goodsDescription": "goodsDescription",
14       "grossWeight": {
15         "amount": 1.1
16       },
17       "harmonisedCommodityCode": [
18         "harmonisedCommodityCode"
19       ],
20       "isoCountryCodeOfOriginOfGoods": "isoCountryCodeOfOriginOfGoods",
21       "numberOfPieces": 1,
22       "packaging": [
23         {}
24       ],
25       "rateCombinationPointCityCode": "rateCombinationPointCityCode",
26       "serviceCode": "AIRPORT_TO_AIRPORT"
27     }
28   ],
29   "createdAt": "2024-01-15T09:30:00Z",
30   "destination": "destination",
31   "orgId": "orgId",
32   "origin": "origin",
33   "route": [
34     {
35       "carrierCode": "carrierCode",
36       "destination": "destination"
37     }
38   ],
39   "taskGroupId": "taskGroupId",
40   "totalConsignmentNumberOfPieces": 1,
41   "updatedAt": "2024-01-15T09:30:00Z",
42   "webcargoBookingRecordId": "webcargoBookingRecordId",
43   "weight": {
44     "amount": 1.1,
45     "unit": "KILOGRAM"
46   },
47   "accounting": [
48     {
49       "accountingInformation": "accountingInformation",
50       "identifier": "CreditCardNumber"
51     }
52   ],
53   "additionalSpecialHandlingCodes": [
54     "additionalSpecialHandlingCodes"
55   ],
56   "agent": {
57     "name": "name",
58     "place": "place",
59     "accountNumber": "accountNumber",
60     "iataCargoAgentCASSAddress": "iataCargoAgentCASSAddress",
61     "iataCargoAgentNumericCode": "iataCargoAgentNumericCode",
62     "participantIdentifier": {
63       "airportCityCode": "airportCityCode",
64       "code": "code",
65       "identifier": "AIR"
66     }
67   },
68   "alsoNotify": {
69     "address": {
70       "country": "country",
71       "name1": "name1",
72       "place": "place",
73       "postCode": "postCode",
74       "streetAddress1": "streetAddress1",
75       "name2": "name2",
76       "stateProvince": "stateProvince",
77       "streetAddress2": "streetAddress2"
78     },
79     "accountNumber": "accountNumber",
80     "contactDetails": [
81       {
82         "contactIdentifier": "contactIdentifier",
83         "contactNumber": "contactNumber"
84       }
85     ]
86   },
87   "chargeDeclarations": {
88     "isoCurrencyCode": "isoCurrencyCode",
89     "chargeCode": "ALL_CHARGES_COLLECT",
90     "declaredValueForCarriage": 1.1,
91     "declaredValueForCustoms": 1.1,
92     "declaredValueForInsurance": 1.1,
93     "payment_OtherCharges": "Collect",
94     "payment_WeightValuation": "Collect"
95   },
96   "chargesCollectInDestCurrency": {
97     "chargesAtDestination": 1.1,
98     "chargesInDestinationCurrency": 1.1,
99     "currencyConversionRateOfExchange": 1.1,
100     "isoCurrencyCode": "isoCurrencyCode",
101     "totalCollectCharges": 1.1
102   },
103   "collectChargeSummary": {
104     "chargeSummaryTotal": 1.1,
105     "taxes": 1.1,
106     "totalOtherChargesDueAgent": 1.1,
107     "totalOtherChargesDueCarrier": 1.1,
108     "totalWeightCharge": 1.1,
109     "valuationCharge": 1.1
110   },
111   "commissionInfo": {
112     "amountCASSSettlementFactor": 1.1,
113     "percentageCASSSettlementFactor": 1.1
114   },
115   "consignee": {
116     "address": {
117       "country": "country",
118       "name1": "name1",
119       "place": "place",
120       "postCode": "postCode",
121       "streetAddress1": "streetAddress1",
122       "name2": "name2",
123       "stateProvince": "stateProvince",
124       "streetAddress2": "streetAddress2"
125     },
126     "accountNumber": "accountNumber",
127     "contactDetails": [
128       {
129         "contactIdentifier": "contactIdentifier",
130         "contactNumber": "contactNumber"
131       }
132     ]
133   },
134   "customsOriginCode": "customsOriginCode",
135   "densityGroup": 1,
136   "flights": [
137     {
138       "flight": "flight",
139       "scheduledDate": "scheduledDate",
140       "scheduledTime": "scheduledTime"
141     }
142   ],
143   "isoCurrencyCode": "isoCurrencyCode",
144   "nominatedHandlingParty": {
145     "name": "name",
146     "place": "place"
147   },
148   "oci": [
149     {
150       "additionalControlInformation": "additionalControlInformation",
151       "controlInformation": "controlInformation",
152       "informationIdentifier": "informationIdentifier",
153       "isoCountryCode": "isoCountryCode",
154       "supplementaryControlInformation": "supplementaryControlInformation"
155     }
156   ],
157   "otherCharges": [
158     {
159       "chargeAmount": 1.1,
160       "entitlementCode": "Agent",
161       "otherChargeCode": "UC",
162       "paymentCondition": "Collect"
163     }
164   ],
165   "otherParticipant": [
166     {
167       "name": "name",
168       "fileReference": "fileReference",
169       "officeMessageAddress": {
170         "airportCityCode": "airportCityCode",
171         "companyDesignator": "companyDesignator",
172         "officeFunctionDesignator": "officeFunctionDesignator"
173       },
174       "participantIdentification": {
175         "airportCityCode": "airportCityCode",
176         "code": "code",
177         "identifier": "AIR"
178       }
179     }
180   ],
181   "otherServiceInformation": "otherServiceInformation",
182   "prepaidChargeSummary": {
183     "chargeSummaryTotal": 1.1,
184     "taxes": 1.1,
185     "totalOtherChargesDueAgent": 1.1,
186     "totalOtherChargesDueCarrier": 1.1,
187     "totalWeightCharge": 1.1,
188     "valuationCharge": 1.1
189   },
190   "salesIncentive": {
191     "chargeAmount": 1.1,
192     "cassIndicator": "AWB_AS_INVOICE"
193   },
194   "schemaVersion": 1,
195   "shipmentReferenceInformation": {
196     "info": "info",
197     "referenceNumber": "referenceNumber"
198   },
199   "shipper": {
200     "address": {
201       "country": "country",
202       "name1": "name1",
203       "place": "place",
204       "postCode": "postCode",
205       "streetAddress1": "streetAddress1",
206       "name2": "name2",
207       "stateProvince": "stateProvince",
208       "streetAddress2": "streetAddress2"
209     },
210     "accountNumber": "accountNumber",
211     "contactDetails": [
212       {
213         "contactIdentifier": "contactIdentifier",
214         "contactNumber": "contactNumber"
215       }
216     ]
217   },
218   "shippersCertification": "shippersCertification",
219   "specialHandlingCodes": [
220     "ACT"
221   ],
222   "specialServiceRequest": "specialServiceRequest",
223   "status": "draft",
224   "submittedAt": "2024-01-15T09:30:00Z",
225   "volume": {
226     "amount": 1.1,
227     "unit": "CUBIC_CENTIMETRE"
228   }
229 }

Retrieves the stored CHAMP air waybill for a task group. | () -> (ChampAirWaybill1)

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

chargeItemslist of objects

createdAtdatetime

destinationstring

orgIdstring

Must be a string starting with org_

originstring

routelist of objects

taskGroupIdstring

totalConsignmentNumberOfPiecesinteger

updatedAtdatetime

webcargoBookingRecordIdstring

weightobject

Reusable weight amount + unit pair.

Used for:

AirWayBill.weight -> [WEBCARGO] <NetWeight> (gross weight)
Charge.chargeable_weight -> [WEBCARGO] <TotalChargeableWeight> (billing weight)
ChargeItem.gross_weight -> [WEBCARGO] <NetWeight>

accountinglist of objectsOptional

additionalSpecialHandlingCodeslist of stringsOptional

agentobjectOptional

[WEBCARGO/CONFIG] Forwarder’s IATA agent identification. Same identity as iata in WebcargoEmbedViewParams and OY party in bookingRecord XML.

alsoNotifyobjectOptional

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

chargeDeclarationsobjectOptional

[CUSTOMER/WEBCARGO] Currency from WebCargo <PriceIndicator>, payment conditions from customer’s commercial terms.

chargesCollectInDestCurrencyobjectOptional

[CUSTOMER] Charges Collect expressed in destination currency.

collectChargeSummaryobjectOptional

[CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.

commissionInfoobjectOptional

[CUSTOMER] Commission information concerning CASS settlement.

consigneeobjectOptional

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

customsOriginCodestringOptional

densityGroupintegerOptional

flightslist of objectsOptional

isoCurrencyCodestringOptional

nominatedHandlingPartyobjectOptional

[CUSTOMER] Nominated handling party for the shipment.

ocilist of objectsOptional

otherChargeslist of objectsOptional

otherParticipantlist of objectsOptional

otherServiceInformationstringOptional

prepaidChargeSummaryobjectOptional

[CUSTOMER] Prepaid or collect charge totals. One of prepaid or collect charge summary must be given.

salesIncentiveobjectOptional

[CUSTOMER] Sales incentive information.

schemaVersionintegerOptionalDefaults to 1

shipmentReferenceInformationobjectOptional

[CUSTOMER] Shipment reference info (supplementary reference for the AWB).

shipperobjectOptional

[CUSTOMER] Shipper or consignee with address and optional contact info. account_number is the IATA participant code (optional).

shippersCertificationstringOptional

specialHandlingCodeslist of enumsOptional

specialServiceRequeststringOptional

statusenumOptional

submittedAtdatetimeOptional

volumeobjectOptional

[WEBCARGO] Volume from <NetVolumeMeasure>.

Errors

422

Air Waybills Retrieve V1request Unprocessable Entity Error