Table of Contents
| Table of Contents |
|---|
接口说明
以大包方式将包裹数据传送给操作站。 此接口有三种模式: 1) 同时创建大包与新订单,系统会接受订单信息并且创建客户指定的大包号的大包,新订单自动关联上该大包。 2) 创建大包,并将大包与系统中已有订单进行关联。 3) 创建大包的同时创建新订单,并与系统已有订单进行关联。创建大包成功后,新大包中部分订单为新创建订单,另一部分为系统已有订单。 接口校验:
|
路径
| HTTP Verb | URL |
|---|---|
| Post | /services/shipper/handover |
请求参数
字段 | 必填/可选 | 长度 | 描述 | |
batchNo | O | 80 | 批次号 | |
handoverTime | O | 交接时间(YYYY-MM-DD'T'HH:MM:SSZ) | ||
consignor | O | 80 | 发货人 | |
consignee | O | 80 | 收货人 | |
driver | O | 80 | 司机 | |
plateNbr | O | 80 | 车牌号 | |
remark | O | Double | 备注 | |
bags | ||||
bagNo | M | 大包 | ||
serviceCode | M | 服务代码 | ||
facility | O | |||
destCountry | M | 大袋目的国家 | ||
sortCode | O | 大袋分拣码 | ||
battery | O | 大袋带电 | ||
totalWeight | M | 大袋总重 | ||
| GrossWeight | O | 大袋毛重 | ||
parcels | ||||
trackingNo | M | 订单跟踪号 |
响应内容
服务端返回与请求相对应的大包号,包括
1)是否创建成功(status);
2)出错代码(errors);
3)参考号(referenceNo);
4)跟踪号(trackingNo);
5)大包号(bagNo);
报错信息
| code | message |
|---|---|
| 950002 | Parameter is null.(参数为空) |
| 951002 | The parameter bags is required. (bags字段是必填的) |
| 951003 | The parameter bags exceeds max limit 300. (大包数量超出最大限制300) |
| 951003 | Create Message error. (创建错误) |
| 951007 | Bag {bagNo} parameter serviceCode is missing.(大包的serviceCode字段缺少/错误) |
| 951000 | The parameter bagNo is missing. (bagNo字段缺少) |
| 951006 | The parameter bagNo {bagNo} exceeds max length 80 characters. (大包号超过最大字符数80) |
| 951020 | The parameter bagNo {bagNo} already existed. (大包号已经存在) |
| 951023 | The parameter bagNo {bagNo} repeat. (大包号重复) |
| 951009 | Bag {bagNo} parameter destCountry is missing. (大包字段destCountry缺少/错误) |
| 951013 | Bag {bagNo} parameter parcels is required. (大包字段parcels是必填的) |
| 950003 | Exceeds the limit of 2000 orders.(小包数量不能超过2000) |
| 100062 | Bag {bagNo} parcel {parcelId} is no permission. (大包下小包无权限) |
| 951024 | Bag {bagNo} parcel {parcelId} already bagged. (大包下小包已经装袋) |
| 951021 | Bag {bagNo} parcel {parcelId} referenceNo {referenceNo} is repeat. (大包下小包的referenceNo字段重复) |
| 951025 | Bag {bagNo} parcel {parcelId} serviceCode {serviceCode} is different from bag serviceCode {bagServiceCode}. (大包下小包的serviceCode字段与大包不一致) |
| 951026 | Bag {bagNo} parcel {parcelId} serviceOption {serviceOption} is different from bag serviceOption {bagServiceOption}. (大包下小包的serviceOption字段与大包不一致) |
请求内容
1. 同时创建大包与新订单
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. 大包与已有订单关联
Request
{
"bags": [
{
"bagNo": "20201102001-001",
"battery": false,
"sortCode": "",
"destCountry": "AU",
"facility": "CAN",
"parcels": [
{
"trackingNo": "JDQ002447301000931502"
}
],
"serviceCode": "UBI.ASP.CN2AU.AUPOST",
"totalWeight": 0.064
}
],
"batchNo": "ZXYD1016617",
"handoverTime": "2020-08-10T11:45:22+08:00"
}
3. 大包与新订单及已有订单进行关联
Request
{
"batchNo": "20200810001",
"handoverTime": "2020-08-11T22:08:08+08:00",
"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
{
"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
}
]
}
]
}