Description
| The carrier is used to upload flight information to the package. |
Path
| HTTP Verb | URL |
|---|---|
| Post | /services/carrier/lineHaul |
Request Elements
| 1 | Field (API) | Data Type | Length | Mandatory | Details | ||||||||
| 2 | bizType | Number | M | Type of transportation, when select the following serial numbers: 1: Air Transport; 2: Land Transportation; 3: Ocean Transport; 4: Railway Transport | |||||||||
| 3 | mawb | String | 40 | M | Master Air WayBill | ||||||||
| 4 | flightNo | String | 80 | M | Flight number | ||||||||
| 5 | etd | String | 19 | M | Estimated time of departure Format: yyyy-MM-dd HH:mm:ss,
| ||||||||
| 6 | eta | String | 19 | M | Estimated time of arrival Format: yyyy-MM-dd HH:mm:ss,
| ||||||||
| 7 | origin | String | 80 | M | Departure airport code | ||||||||
| 8 | destination | String | 80 | M | Destination airport code | ||||||||
| 9 | totalParcels | String | 80 | M | Total number of parcels | ||||||||
| 10 | dataType | Number | M | Type，choose one 1. Parcel (Tracking No.) 2. Bag (Bag No. | |||||||||
| 11 | dataNos | List | 200 | M | When datatype choose “1”, input Tracking No.， When datatype choose “2”, input Bag No | ||||||||
| 12 | atd | String | 19 | O | Actual time of departure Format: yyyy-MM-dd HH:mm:ss,
| ||||||||
| 13 | ata | String | 19 | O | Actual time of arrival Format: yyyy-MM-dd HH:mm:ss,
| ||||||||
| 14 | airlineCheckIn | String | 19 | O | Airline Check-In Time Format: yyyy-MM-dd HH:mm:ss,
| ||||||||
| 15 | recovery | String | 19 | O | Fields for other purposes Format: yyyy-MM-dd HH:mm:ss,
| ||||||||
| 16 | handoverTime | String | 19 | O | Delivery time Format: yyyy-MM-dd HH:mm:ss,
| ||||||||
| 17 | rcsTime | String | 19 | O | Fields for other purposes Format: yyyy-MM-dd HH:mm:ss,
| ||||||||
| 18 | via1 | String | 3 | O | First stopover | ||||||||
| 19 | via2 | String | 3 | O | Second stopover | ||||||||
| 20 | hawb | String | 32 | O | House Air Waybill | ||||||||
| 21 | grossWeight | Double | O | Gross Weight (Unit: Kg) | |||||||||
| 22 | volumetricWeight | Double | O | Volumetric Weight (Unit: Kg) | |||||||||
| 23 | chargeableWeight | Double | O | Chargeable Weight (Unit: Kg) | |||||||||
| 24 | comments | String | O | Comments | |||||||||
| 25 | remark | String | 255 | O | Remark | ||||||||
| 26 | lineHaulAttachments | List | O | Attachment information If this field is included, the following fields are required. | |||||||||
| 27 | attachment | String | M | The Base64 format of the attachment | |||||||||
| 28 | attachmentFileName | String | 90 | M | The file name of the attachment, should include the file type.
| ||||||||
| 29 | attachmentFileType | String | 1 | M | The file type of the attachment varies depending on the bizType. Please fill in the corresponding number. Air Transport (bizType=1)
Land Transportation (bizType=2)
Ocean Transport (bizType=3)
Railway Transport (bizType=4)
| ||||||||
Response Elements
| 1 | Field | Type | Mandatory/Optional | Description |
| 2 | status | String | M | Succeeded/Failure |
| 3 | code | Number | O | Return code, please refer to the following code and message relationship table. |
| 4 | message | String | O | Response message, please refer to the following code and message relationship table. |
| 5 | uuid | String | M | The unique identifier for this LineHaul record. |
Error Code & Message
code | message |
999400 | MAWB is required |
1100047 | dataNos is invalid. |
300051 | The bag no is error. |
140007 | XXX Barcode already exists. |
2000000 | XXX is required. |
1002000 | Time is invalid |
1003000 | Data is empty. |
| 2200018 | The port is not configured, please contact the system administrator. |
| 2200004 | The airline is not configured, please contact the system administrator. |
| 2200005 | MAWB is invalid. |
| 1003004 | Attachment file base64 or fileName or fileType is empty |
| 1003005 | Attachment fileType is invalid |
Request message
{
"bizType": "1",
"mawb": "78467878565",
"flightNo": "CZ455",
"etd": "2022-04-12 08:01:02",
"eta": "2022-04-13 08:01:02",
"origin": "CAN",
"destination": "AMS",
"atd": "2022-05-31 14:20:05",
"ata": "2022-05-31 17:30:05",
"totalParcels": "2",
"dataType": 1,
"dataNos": [
"JB000013817",
"000013802"
],
"lineHaulAttachments": [
{
"attachmentFileType": "0",
"attachment": "Base64 format",
"attachmentFileName": "test1.pdf"
},
{
"attachmentFileType": "6",
"attachment": "Base64 format",
"attachmentFileName": "test2.pdf"
}
]
}
Response message
{
"status":"Succeeded",
"code":0,
"message":null,
"uuid": "Qu57HhAhW6TTTQGm1Dvn_a"
}
{
"status": "Failed",
"code": 2200005,
"message": "MAWB is invalid",
"uuid": null
}
Exception Response (Only when the error code is 100004, the following error will be returned. It may occur occasionally when the system is released.)
{
"status": "Failure",
"errors": [
{
"code": 100004,
"message": "System internal error",
"messageCn": null
}
],
"data": null,
"warnings": null
}