Description
Put orders into a bag and handover them to the first carrier.
|
Path
| HTTP Verb | URL |
|---|---|
| Post | /services/shipper/handover |
Request Elements
Field (API) | Mandatory | Length | Details |
batchNo | O | 80 | Batch number |
handoverTime | O | Time format: YYYY-MM-DD'T'HH:MM:SSZ | |
consignor | O | 80 | Sender information |
consignee | O | 80 | Recipient information |
driver | O | 80 | Driver information |
plateNbr | O | 80 | License plate number |
remark | O | Double | Remark information |
bags | M | Array | Bags information |
Response content
Response Elements
Return results including:
1)Status
2) Errors
3) Reference No.
4) Tracking No
5) Bag No.
Error Code & Message
| code | message |
|---|---|
| 950002 | Parameter is null. |
| 951002 | The parameter bags is required. |
| 951003 | The parameter bags exceeds max limit 300. |
| 951003 | Create Message error. |
| 951007 | Bag {bagNo} parameter serviceCode is missing. |
| 951000 | The parameter bagNo is missing. |
| 951006 | The parameter bagNo {bagNo} exceeds max length 80 characters. |
| 951020 | The parameter bagNo {bagNo} already existed. |
| 951023 | The parameter bagNo {bagNo} repeat. |
| 951009 | Bag {bagNo} parameter destCountry is missing. |
| 951013 | Bag {bagNo} parameter parcels is required. |
| 950003 | Exceeds the limit of 2000 orders. |
| 100062 | Bag {bagNo} parcel {parcelId} is no permission. |
| 951024 | Bag {bagNo} parcel {parcelId} already bagged. |
| 951021 | Bag {bagNo} parcel {parcelId} referenceNo {referenceNo} is repeat. |
| 951025 | Bag {bagNo} parcel {parcelId} serviceCode {serviceCode} is different from bag serviceCode {bagServiceCode}. |
| 951026 | Bag {bagNo} parcel {parcelId} serviceOption {serviceOption} is different from bag serviceOption {bagServiceOption}. |
Request parameters
1. Create large package and new order at the same time
Request
{
"batchNo": "20200810001",
"handoverTime": "2020-08-10T11:45:22+08:00",
"consignor": "test",
"consignee": "test",
"driver": "张三",
"plateNbr": "沪A8888",
"remark": "测试",
"bags": [{
"bagNo": "20201102001-001",
"serviceCode": "UBI.CN2AU.AUPOST",
"facility": "SZX",
"destCountry": "AU",
"sortCode": "",
"battery": false,
"parcels": [{
"referenceNo": "TESTBDAU15303483645716",
"serviceCode": "UBI.CN2AU.AUPOST",
"recipientName": "WUBIN",
"phone": "+49 3068838320",
"addressLine1": "Stellingdamm9",
"addressLine2": "",
"city": "Cudgewa",
"postcode": "3705",
"state": "VIC",
"country": "AU",
"weight": 0.646,
"invoiceCurrency": "USD",
"batteryType": "NoBattery",
"description": "Pants",
"nativeDescription": "货物中文描述",
"extendData": {
"vendorid": "64652016681",
"gstexemptioncode": "Paid"
},
"orderItems": [{
"itemNo": 1,
"sku": "159110805",
"description": "Pants",
"hsCode": "6104620050",
"originCountry": "CHINA",
"unitValue": "38.44",
"itemCount": 2
}],
"invoiceValue": "76.88"
}]
}]
}
2. Large package is associated with existing order
Request
{
"bags": [
{
"bagNo": "ZXHX1082270",
"battery": false,
"destCountry": "AU",
"facility": "CAN",
"parcels": [
{
"trackingNo": "JDQ002447301000931502"
}
],
"serviceCode": "UBI.ASP.CN2AU.AUPOST",
"totalWeight": 0.064
}
],
"batchNo": "ZXYD1016617",
"handoverTime": 1597039375903
}
3. Large packages are associated with new orders and existing orders
Request
{
"batchNo": "20200810001",
"handoverTime": "2020-08-11T22:08:08+0800",
"consignor": "test",
"consignee": "test",
"driver": "张三",
"plateNbr": "沪A8888",
"remark": "测试",
"bags": [{
"bagNo": "20201102001-001",
"serviceCode": "UBI.ASP.CN2AU.AUPOST",
"facility": "SZX",
"destCountry": "AU",
"sortCode": "YYZ",
"battery": false,
"totalWeight": 0.3,
"extendData": {
"sortCode": "M1A1"
},
"parcels": [{
"referenceNo": "TESTBDAU15303483645716"
}]
}, {
"bagNo": "20171102001-002",
"serviceCode": "UBI.ASP.CN2AU.AUPOST",
"facility": "SZX",
"destCountry": "AU",
"sortCode": "YYZ",
"battery": false,
"totalWeight": 0.3,
"parcels": [{
"referenceNo": "TESTBDAU15303483645717",
"serviceCode": "UBI.ASP.CN2AU.AUPOST",
"recipientName": "WUBIN",
"phone": "+49 3068838320",
"addressLine1": "Stellingdamm 9",
"addressLine2": "",
"city": "Cudgewa",
"postcode": "3705",
"state": "VIC",
"country": "AU",
"weight": 0.646,
"invoiceCurrency": "USD",
"batteryType": "No Battery",
"description": "Pants",
"nativeDescription": "货物中文描述",
"extendData": {
"vendorid": "6465201 6681",
"gstexemptioncode": "Paid"
},
"orderItems": [{
"itemNo": 1,
"sku": "159110805",
"description": "Pants",
"hsCode": "6104620050",
"originCountry": "CHINA",
"unitValue": "38.44",
"itemCount": 2
}],
"invoiceValue": "76.88"
}]
}]
}
Response message
Response
{
"status": "Success",
"errors": null,
"data": [
{
"status": "Success",
"errors": [],
"bagNo": "20171102001-001",
"orderResults": [
{
"status": "Success",
"errors": null,
"orderId": null,
"referenceNo": "TESTBDAU15303483645716",
"trackingNo": null,
"connoteId": null
}
]
},
{
"status": "Success",
"errors": [],
"bagNo": "20171102001-002",
"orderResults": [
{
"status": "Success",
"errors": null,
"orderId": null,
"referenceNo": "TESTBDAU15303483645717",
"trackingNo": null,
"connoteId": null
}
]
}
]
}