API名称 | 获取订单信息 |
描述 | 可通过订单号等获取小包订单详细信息 |
URL | http://www.mgoship.com/api.php?op=storage&mod=tms_orders&action=get_tms_order_detail |
接口测试 | http://test.mgoship.com/api.php?op=storage&mod=tms_orders&action=get_tms_order_detail |
数据格式 | JSON |
方法 | HTTP POST |
请求参数
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
params | Array | 是 | |
-| customerno | String | 否 | 客户单号(如果此参数存在多条记录,将返回最新一个订单信息) |
-| orderNo | int | 否 | 订单号 |
-| trackno | String | 否 | 服务商单号(跟踪号) |
请求示例
{
"appid": "M10001",
"sign": "88C65DCC1A5978B5D326F93ABD78FB6FF64730C8",
"version": "1.0",
"params": {
"customerno": "",
"orderNo": "122022930777",
"trackno": ""
}
}
返回结果
名称 | 说明 | |
---|---|---|
status 状态参数 | ||
code | API访问状态编码,如果成功返回"OK",并返回结果字段,如果失败返回错误编码"ERROR",并返回错误说明 | |
msg | 返回状态说明 | |
data 数据参数 | ||
-| order | 基本信息 | |
--| orderNo | 订单号 | |
--| customerno | 客户单号(客户自定义单号) | |
--| trackno | 服务商单号 | |
--| shipway | 运输方式:PTT,YK | |
--| status | 订单状态:1.草稿 2.已预报 3.已入库 4.库内作业中 5.已出库 6.已派送 7.已完成 | |
--| unusual | 订单异常,0:否,1:是 (如订单异常,route=>remark中显示异常原因) | |
--| hasbattery | 是否带电池,Y:是,N:否 | |
--| shipmenttype | 货物类型, 1:礼品,2:文件,3:商品货样,4:其他 | |
--| weight | 重量(kg) | |
--| length | 长(cm) 仅泡货时此值不等于0 | |
--| width | 宽(cm)仅泡货时此值不等于0 | |
--| height | 高(cm)仅泡货时此值不等于0 | |
--| insurance | 如购买保险,NO:不购买,5Y:5元每票,6P:0.6%保费 | |
--| insvalue | 保价金额(元) | |
--| addtime | 预报时间,Unix时间戳(Unix timestamp) | |
--| handtime | 入库时间,Unix时间戳 | |
--| shiptime | 出库时间,Unix时间戳 | |
--| delivertime | 派送时间,Unix时间戳 | |
-| consignee | 收件人信息 | |
--| address | 详细地址 | |
--| buyerid | 买家ID | |
--| company | 公司名称 | |
邮箱 | ||
--| mobile | 手机号 | |
--| name | 收件人姓名 | |
--| phone | 联系电话 | |
--| postcode | 邮政编码 | |
--| region | 收货地区 | |
-| declare | 海关申报品 | |
--| cnname | 中文品名 | |
--| enname | 英文品名 | |
--| hscode | HS CODE 海关编码 | |
--| note | 配货备注 | |
--| pickupname | 配货信息 | |
--| qty | 数量 | |
--| unitprice | 单价(USD) | |
--| material | 产品材质 | |
-| route | 订单路由 | |
--| addtime | 发生时间Unix时间戳 | |
--| remark | 路由信息 | |
-| fee | 订单费用明细(元) | |
--| statusCN | 国内部分支付状态,0:未付,1:已付 | |
--| sumCN | 国内部分合计 | |
--| shipFee | 运费 | |
--| insuranceFee | 保险费 | |
--| statusEnd | 尾段支付状态,0:未付,1:已付 | |
--| sumEnd | 尾段合计 | |
--| taxFee | 税费 | |
--| otherFee | 其他费用 | |
--| feeNote | 其他费用说明 |
结果示例
{
"status": {
"code": "OK",
"msg": ["获取订单信息成功"]
},
"data": {
"order": {
"orderNo": "122022930777",
"customerno": "A000091906080D9A",
"trackno": "569440926682",
"status": "2",
"shipway": "GH",
"hasbattery": "N",
"shipmenttype": "4",
"weight": "0.351",
"length": "0.0",
"width": "0.0",
"height": "0.0",
"insurance": "NO",
"insvalue": "0.00",
"unusual": "0",
"addtime": "1582166422",
"handtime": "0",
"shiptime": "0",
"delivertime": "0"
},
"consignee": {
"address": "秋田市八橋本町3-14-14",
"buyerid": "",
"company": "歯科医院",
"email": "",
"mobile": "",
"name": "田中 裕美",
"phone": "0188646322",
"postcode": "103-4520",
"region": "秋田県"
},
"declare": [{
"cnname": "耳机",
"enname": "IN EARPHONE",
"hscode": "890238908",
"note": "",
"pickupname": "",
"qty": "1",
"unitprice": "5.00",
"material": "Metal,Plastic"
}, {
"cnname": "WiFi放大器",
"enname": "WiFi Amplifier",
"hscode": "9620009900",
"note": "",
"pickupname": "",
"qty": "2",
"unitprice": "2.00",
"material": "Metal,Plastic"
}],
"route": [{
"addtime": "1582166422",
"remark": "接口推送订单"
}],
"fee": {
"statusCN": 0,
"sumCN": 0,
"shipFee": 0,
"insuranceFee": 0,
"statusEnd": 0,
"sumEnd": 0,
"taxFee": 0,
"otherFee": 0,
"feeNote": ""
}
}
}