订单相关接口
目录
1.获取运单号接口(版本1.0)
- 请求路径:/open-web/rs/order/v1/getWaybill
- 请求方式:GET
- 接口版本:v1
- 输入参数:无参数
- 输出参数:ResBaseVo实体
输出参数(ResBaseVo实体)
字段 |
类型 |
长度 |
是否必填 |
参数说明 |
备注 |
errcode |
String |
20 |
是 |
错误编码 |
|
errmsg |
String |
200 |
否 |
错误消息 |
|
result |
String |
|
否 |
请求运单号 |
|
2.新增订单接口(版本1.0)
- 请求路径:/open-web/rs/order/v1/add
- 请求方式:POST
- 接口版本:v1
- 输入参数:OrderModel实体
- 输出参数:ResBaseVo实体
输入参数(OrderVo实体)
字段 |
类型 |
长度 |
是否必填 |
参数说明 |
备注 |
orderNo |
String |
32 |
否 |
华宇订单号 |
|
transNo |
String |
32 |
否 |
华宇运单号 |
|
smsNotifyPrice |
Double |
2位小数 |
否 |
短信通知费用 |
|
fuelSurcharge |
String |
10 |
否 |
是否需要燃油附加 |
是:YES否:NO |
fuelSurchargePrice |
Double |
2位小数 |
否 |
燃油附件费 |
|
backSignBillPrice |
Double |
2位小数 |
否 |
签收回单费用 |
|
transportPrice |
Double |
2位小数 |
否 |
运输费用 |
|
insurancePrice |
Double |
2位小数 |
否 |
保价费 |
|
vistReceivePrice |
Double |
2位小数 |
否 |
上门接货费用 |
|
codPrice |
Double |
2位小数 |
否 |
代收货款费 |
|
deliveryPrice |
Double |
2位小数 |
否 |
送货费用 |
|
waitNotifySendPrice |
Double |
2位小数 |
否 |
等通知发货费用 |
|
packageServicePrice |
Double |
2位小数 |
否 |
包装服务费 |
|
materialCostPrice |
Double |
2位小数 |
否 |
工本费用 |
|
otherprice |
Double |
2位小数 |
否 |
其他费用 |
|
materialCost |
String |
10 |
否 |
是否需要工本费 |
是:YES否:NO |
companyCode |
String |
64 |
是 |
公司编号 |
|
customerOrderNo |
String |
50 |
是 |
客户订单号 |
|
companyName |
String |
50 |
否 |
公司名称 |
|
customEbcuId |
String |
16 |
否 |
用户唯一ID号 |
|
memberType |
String |
50 |
否 |
会员类型 |
|
businessNetworkNo |
String |
20 |
否 |
营业网点编号 |
|
senderCompanyname |
String |
200 |
否 |
发货人公司 |
|
senderName |
String |
200 |
是 |
发货人名称 |
|
senderPostcode |
String |
32 |
否 |
发货人邮编 |
|
senderPhone |
String |
50 |
否 |
发货人电话 |
|
senderMobile |
String |
50 |
否 |
发货人手机 |
手机和电话必选一项必填; |
senderProvince |
String |
40 |
是 |
发货人省份 |
|
senderCity |
String |
50 |
是 |
发货人城市 |
|
senderCounty |
String |
50 |
是 |
发货人区县 |
|
senderAddress |
String |
512 |
是 |
发货人详细地址 |
|
receiverCompanyname |
String |
200 |
否 |
收货人公司 |
|
receiverName |
String |
200 |
是 |
收货人名称 |
|
receiverPostcode |
String |
32 |
否 |
收货人邮编 |
|
receiverPhone |
String |
50 |
否 |
收货人电话 |
|
receiverMobile |
String |
50 |
否 |
收货人手机 |
手机和电话必选一项必填; |
receiverProvince |
String |
40 |
是 |
收货人省份 |
|
receiverCity |
String |
50 |
是 |
收货人城市 |
|
receiverCounty |
String |
50 |
是 |
收货人县/区 |
|
receiverAddress |
String |
512 |
是 |
收货详细地址 |
|
gmtcommit |
Date |
精确到秒 |
否 |
提交时间 |
|
cargoname |
String |
256 |
是 |
货物名称 |
|
totalWeight |
Double |
2位小数 |
否 |
总重量(单位:kg) |
|
totalVolume |
Double |
2位小数 |
否 |
总体积(单位m3) |
|
totalPrice |
Double |
2位小数 |
否 |
总价格 |
|
totalNumber |
Integer |
4 |
否 |
总件数 |
|
payType |
String |
20 |
否 |
支付方式 |
现付:CASH到付:ARRIVE_PAYMENT月结:Monthly_Statement |
transportType |
String |
20 |
是 |
运输方式 |
定日达:DRD普通零担:PTLD偏线:PX整车:ZC易入户:YRH易安装:YAZ易包裹:YBG |
insuranceValue |
Double |
2位小数 |
否 |
保价金额 |
|
vistReceive |
String |
20 |
是 |
是否需要上门接货 |
需要:YES不需要:NO |
deliveryType |
String |
20 |
是 |
送货方式 |
送货上门:DOORSTEP客户自提:SELF_TAKE送货上楼:UPSTAIR |
codType |
String |
20 |
否 |
代收货款类型 |
三天返回货款:THREEDAY |
tmallOrderNo |
String |
20 |
否 |
天猫订单号 |
|
codValue |
Double |
2位小数 |
否 |
代收货款 |
|
backSignBill |
String |
512 |
否 |
签单返回 |
客户出库单传真返回:CUSTCOPY客户出库单原件返回:CUSTORIGINAL无需返单:NOBACK到货签收单传真返回:SIGNCOPY到货签收单原件返回:SIGNORIGINAL |
packageService |
String |
30 |
否 |
包装(直接用中文) |
|
waitNotifySend |
String |
10 |
否 |
等通知发货 |
是:YES否:NO |
smsNotify |
String |
10 |
否 |
短信通知 |
是:YES否:NO |
remark |
String |
1024 |
否 |
注意事项(备注) |
|
bizType |
String |
50 |
否 |
业务类型 |
根据客户需要提供 |
输入参数示例:
{
"companyCode": "hoau",
"customerOrderNo": "NO123456",
"senderName": "张三",
"senderMobile": "13333333333",
"senderProvince": "上海市",
"senderCity": "上海市",
"senderCounty": "闵行区",
"senderAddress": "华翔路2239号",
"receiverName": "李四",
"receiverMobile": "13888888888",
"receiverProvince": "广东省",
"receiverCity": "深圳市",
"receiverCounty": "福田区",
"receiverAddress": "深南大道2012号",
"cargoname": "衣服",
"transportType": "DRD",
"vistReceive": "YES",
"deliveryType": "YES"
}
输出参数(ResBaseVo实体)
字段 |
类型 |
长度 |
是否必填 |
参数说明 |
备注 |
errcode |
String |
20 |
是 |
错误编码 |
|
errmsg |
String |
200 |
否 |
错误消息 |
|
result |
void |
|
否 |
请求结果 |
|
输出参数示例:
{
"result": null,
"errcode": "1000",
"errmsg": null
}
3.获取标签信息接口(版本1.0)
- 请求路径:/open-web/rs/order/v1/getLabelInfo/{waybill}
- 请求方式:GET
- 接口版本:v1
- 输入参数:url参数
- 输出参数:ResBaseVo实体
- 输出参数:LabelInfoModel实体
输出参数(ResBaseVo实体)
字段 |
类型 |
长度 |
是否必填 |
参数说明 |
备注 |
errcode |
String |
20 |
是 |
错误编码 |
|
errmsg |
String |
200 |
否 |
错误消息 |
|
result |
List<LabelInfoModel> |
|
否 |
请求标签信息 |
|
输出参数(LabelInfoModel实体)
字段 |
类型 |
长度 |
是否必填 |
参数说明 |
备注 |
company |
String |
10 |
是 |
天地华宇 |
天地华宇 |
printTime |
String |
|
是 |
打印时间 |
2016-05-19 15:55:41 |
transportType |
String |
|
是 |
运输类型 |
|
transportChar |
String |
|
是 |
运输类型字符 |
|
waybill |
String |
|
是 |
运单号 |
|
pieces |
String |
|
是 |
总件数 |
|
indexPiece |
String |
|
是 |
第几件 |
|
startDept |
String |
|
是 |
起运地 |
|
endDept |
String |
|
是 |
目的地 |
|
barcode |
String |
|
是 |
条码 |
|
barcodeText |
String |
|
是 |
条码文字 |
|
telephoneNo |
String |
|
是 |
公司电话 |
400-808-6666 |
webSite |
String |
|
是 |
网址 |
www.hoau.net |
打印参考:http://open.hoau.net:8380/resources/js/hoau_lodop_print.js (使用lodop插件)
在页面中加入<script type="text/javascript" src="http://open.hoau.net:8380/resources/js/hoau_lodop_print.js"></script>
即可使用,打印方法 hoau.print(arrList);
4.根据客户订单号查询信息接口(版本1.0)
- 请求路径:/open-web/rs/order/v1/query/{orderNo}
- 请求方式:GET
- 接口版本:v1
- 输入参数:url参数
- 输出参数:ResBaseVo实体
- 输出参数:OrderVo实体
输出参数(ResBaseVo实体)
字段 |
类型 |
长度 |
是否必填 |
参数说明 |
备注 |
errcode |
String |
20 |
|
错误编码 |
|
errmsg |
String |
200 |
|
错误消息 |
|
result |
OrderVo |
|
|
订单信息 |
主要运单号 |
输出参数(OrderVo实体)
字段 |
类型 |
长度 |
是否必填 |
参数说明 |
备注 |
orderNo |
String |
32 |
|
华宇订单号 |
有值 |
transNo |
String |
32 |
|
华宇运单号 |
开单后有值(若下单时无运单号传入) |
smsNotifyPrice |
Double |
2位小数 |
|
短信通知费用 |
|
fuelSurcharge |
String |
10 |
|
是否需要燃油附加 |
是:YES否:NO |
fuelSurchargePrice |
Double |
2位小数 |
|
燃油附件费 |
|
backSignBillPrice |
Double |
2位小数 |
|
签收回单费用 |
|
transportPrice |
Double |
2位小数 |
|
运输费用 |
|
insurancePrice |
Double |
2位小数 |
|
保价费 |
|
vistReceivePrice |
Double |
2位小数 |
|
上门接货费用 |
|
codPrice |
Double |
2位小数 |
|
代收货款费 |
|
deliveryPrice |
Double |
2位小数 |
|
送货费用 |
|
waitNotifySendPrice |
Double |
2位小数 |
|
等通知发货费用 |
|
packageServicePrice |
Double |
2位小数 |
|
包装服务费 |
|
materialCostPrice |
Double |
2位小数 |
|
工本费用 |
|
otherprice |
Double |
2位小数 |
|
其他费用 |
|
materialCost |
String |
10 |
|
是否需要工本费 |
是:YES否:NO |
companyCode |
String |
64 |
|
公司编号 |
|
customerOrderNo |
String |
50 |
|
客户订单号 |
|
companyName |
String |
50 |
|
公司名称 |
|
customEbcuId |
String |
16 |
|
用户唯一ID号 |
|
memberType |
String |
50 |
|
会员类型 |
|
businessNetworkNo |
String |
20 |
|
营业网点编号 |
|
senderCompanyname |
String |
200 |
|
发货人公司 |
|
senderName |
String |
200 |
|
发货人名称 |
|
senderPostcode |
String |
32 |
|
发货人邮编 |
|
senderPhone |
String |
50 |
|
发货人电话 |
|
senderMobile |
String |
50 |
|
发货人手机 |
|
senderProvince |
String |
40 |
|
发货人省份 |
|
senderCity |
String |
50 |
|
发货人城市 |
|
senderCounty |
String |
50 |
|
发货人区县 |
|
senderAddress |
String |
512 |
|
发货人详细地址 |
|
receiverCompanyname |
String |
200 |
|
收货人公司 |
|
receiverName |
String |
200 |
|
收货人名称 |
|
receiverPostcode |
String |
32 |
|
收货人邮编 |
|
receiverPhone |
String |
50 |
|
收货人电话 |
|
receiverMobile |
String |
50 |
|
收货人手机 |
|
receiverProvince |
String |
40 |
|
收货人省份 |
|
receiverCity |
String |
50 |
|
收货人城市 |
|
receiverCounty |
String |
50 |
|
收货人县/区 |
|
receiverAddress |
String |
512 |
|
收货详细地址 |
|
gmtcommit |
Date |
精确到秒 |
|
提交时间 |
|
cargoname |
String |
256 |
|
货物名称 |
|
totalWeight |
Double |
2位小数 |
|
总重量(单位:kg) |
|
totalVolume |
Double |
2位小数 |
|
总体积(单位m3) |
|
totalPrice |
Double |
2位小数 |
|
总价格 |
|
totalNumber |
Integer |
4 |
|
总件数 |
|
payType |
String |
20 |
|
支付方式 |
现付:CASH到付:ARRIVE_PAYMENT月结:Monthly_Statement |
transportType |
String |
20 |
|
运输方式 |
定日达:DRD普通零担:PTLD偏线:PX整车:ZC |
insuranceValue |
Double |
2位小数 |
|
保价金额 |
|
vistReceive |
String |
20 |
|
是否需要上门接货 |
|
deliveryType |
String |
20 |
|
送货方式 |
送货上门:DOORSTEP客户自提:SELF_TAKE送货上楼:UPSTAIR |
codType |
String |
20 |
|
代收货款类型 |
三天返回货款:THREEDAY |
codValue |
Double |
2位小数 |
|
代收货款 |
|
backSignBill |
String |
512 |
|
签单返回 |
客户出库单传真返回:CUSTCOPY客户出库单原件返回:CUSTORIGINAL无需返单:NOBACK到货签收单传真返回:SIGNCOPY到货签收单原件返回:SIGNORIGINAL |
packageService |
String |
30 |
|
包装(直接用中文) |
|
waitNotifySend |
String |
10 |
|
等通知发货 |
是:YES否:NO |
smsNotify |
String |
10 |
|
短信通知 |
是:YES否:NO |
remark |
String |
1024 |
|
注意事项(备注) |
|
bizType |
String |
50 |
|
业务类型 |
根据客户需要提供 |
5.根据订单号撤销订单接口(版本1.0)
- 请求路径:/open-web/rs/order/v1/cancel{orderNo}
- 请求方式:GET
- 接口版本:v1
- 输入参数:url参数
- 输出参数:ResBaseVo实体
输出参数(ResBaseVo实体)
字段 |
类型 |
长度 |
是否必填 |
参数说明 |
备注 |
errcode |
String |
20 |
是 |
错误编码 |
|
errmsg |
String |
200 |
否 |
错误消息 |
|
result |
String |
|
否 |
|
|
返回结果状态:
Status |
备注 |
4001 |
订单已撤销,不能重复撤销 |
4002 |
订单已经揽收,不能撤销 |
1000 |
订单撤销成功 |
4004 |
订单不存在 |