Submit air waybill to CHAMP

POST

/integrations/air_waybills/submit/v1/:task_group_id

POST

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

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

Submits a draft CHAMP air waybill to Traxon cargoHUB. Requires shipper, consignee, and charge_declarations to be filled in. Returns 422 if the AWB is not in draft status or required fields are missing. | () -> (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

orgIdstring

Must be a string starting with org_

taskGroupIdstring

webcargoBookingRecordIdstring

airWaybillNumberstring

originstring

destinationstring

totalConsignmentNumberOfPiecesinteger

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>

routelist of objects

chargeItemslist of objects

createdAtdatetime

updatedAtdatetime

schemaVersionintegerDefaults to 1

statusenum

Allowed values:

volumeobject

[WEBCARGO] Volume from <NetVolumeMeasure>.

flightslist of objects

isoCurrencyCodestring

agentobject

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

shipperobject

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

consigneeobject

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

chargeDeclarationsobject

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

densityGroupinteger

specialHandlingCodeslist of enums

additionalSpecialHandlingCodeslist of strings

specialServiceRequeststring

alsoNotifyobject

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

prepaidChargeSummaryobject

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

collectChargeSummaryobject

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

accountinglist of objects

otherChargeslist of objects

shippersCertificationstring

otherServiceInformationstring

chargesCollectInDestCurrencyobject

[CUSTOMER] Charges Collect expressed in destination currency.

customsOriginCodestring

commissionInfoobject

[CUSTOMER] Commission information concerning CASS settlement.

salesIncentiveobject

[CUSTOMER] Sales incentive information.

nominatedHandlingPartyobject

[CUSTOMER] Nominated handling party for the shipment.

shipmentReferenceInformationobject

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

otherParticipantlist of objects

ocilist of objects

submittedAtdatetime

Errors

422

Air Waybills Submit V1request Unprocessable Entity Error