查询订单
该接口用于查询订单详情,包括订单状态、金额、收货地址等。
GET /openapi/v2/order/detail{?orderId,sign,appId,timeStamp}
参数 :
name |
类型 |
意义 |
取值 |
orderId |
String |
代理商订单id |
js8asa8su |
sign |
String |
签名 |
483DFD2E8BE0AF2D486F04C7320C7C5E |
appId |
int |
代理商的唯一id |
1 |
timeStamp |
long |
时间戳 有效期10分钟 |
1482995969920 |
请求示例(测试环境):
curl 'http://openapibeta.piaoniu.com/openapi/v2/order/detail?orderId=js8asa8su&appId=10000&timeStamp=1489756931881&sign=1B36ED676EFB0133EC42E8303E8C6DEF'
返回值 :
name |
类型 |
是否必填 |
意义 |
取值 |
status |
int |
是 |
订单状态,见订单状态表 |
3 订单待出票 |
totalAmount |
Bigdecimal |
是 |
总金额 |
100 |
orderId |
String |
是 |
分销商点单号 |
2 |
ticketGroupId |
int |
是 |
商品id |
121 |
count |
int |
是 |
数量 |
2 |
deliverType |
int |
是 |
配送方式 |
1快递,2自取,3现场自取,4电子票 |
receiverName |
String |
是 |
收货姓名 |
老王 |
phone |
String |
是 |
收货人手机号码 |
1370000000 |
address |
String |
否 |
收货地址 |
上海市静安区余姚路339号(百乐门商务楼)2楼东区 |
pnPickupCode |
String |
否 |
自取取票码, 仅在订单为现场自取且已支付时返回, 注意下单后取票码需要时间生成, 没返回该字段可用订单号:xxx替换取票码:xxx |
1-101 |
pnPickupLink |
String |
否 |
自取二维码内容,仅在订单为现场自取且已支付时返回, 需要使用该字符串生成二维码, 商家可使用票牛商家版app扫码核销订单 |
pnmc://merchant_todo_detail?orderId=2 |
onSiteGetInfo |
JSON |
否 |
尾票取票信息,仅在现场自取的订单时出现 |
{"phones":["13700000000","13700000001"],"address":"星巴克(体育馆店)-上海市徐汇区漕溪路1111号上海体育馆1楼1号扶梯","contactPersons":["项先生"]} |
expressInfo |
JSON |
是 |
订单流程信息,其中company和expressNo仅在deliverType为1并且已发货时出现 |
{"company":"顺丰快递","expressEvents":[{"description":"订单已提交,等待支付","time":1572537720000},{"description":"订单支付成功","time":1572537720000},{"description":"商家已备票完成,等待发货","time":1572581212000},{"description":"系统已发货,顺丰快递:288214419156","time":1572581=456000}],"expressNo":"288214419156"} |
ticketReceipts |
Object |
否 |
电子票详情,仅在deliverType为4,5并且已生成电子票时出现, type为1时为电子码, 需要生成内容单纯为码的二维码, 为2时是图片链接, 为3时为纯文本信息, 需要直接展示 |
[{"serialNumber":"17326505405","status":1, "type": 1}] |
orderAdditions |
List < OrderAdditionDTO> |
否 |
订单附加信息, 商家发货时的自定义短信内容会写入该字段中, 循环该数组展示value即可 |
[{"id":11045551,"label":"凭证","value":"测试"}] |
OrderAdditionDTO定义
字段 |
类型 |
含义 |
id |
int |
订单id |
lable |
String |
类型, 一般为"凭证" |
value |
String |
内容, 需要展示该字段 |
注:自取为用户上票牛门店取票,不会在订单详情返回信息
订单状态 |
含义 |
1 |
订单创建成功 |
2 |
订单待支付 |
3 |
订单待出票 |
4 |
订单待确认收票 |
5 |
订单已完成 |
6 |
订单已关闭 |
7 |
订单已退款 |
{
"address": "null null",
"count": 1,
"deliverType": 3,
"expressInfo": {
"company": "",
"expressEvents": [
{
"description": "订单已提交,等待支付",
"time": 1572166932000
},
{
"description": "订单支付成功",
"time": 1572166943000
},
{
"description": "配送成功: 现场派票",
"time": 1572171288000
},
{
"description": "商家已备票完成,等待发货",
"time": 1572171288000
},
{
"description": "系统已发货",
"time": 1572171288000
}
],
"expressNo": ""
},
"onSiteGetInfo": {
"address": "广州天河体育场:广州天河路289号『以当天现场派票人员短信取票电话和地址为准』",
"contactPersons": [
{
"name": "森狼票务",
"phones": [
"18666001333"
]
}
]
},
"orderId": "76252578",
"phone": "13802418222",
"pnOrderId": 124015853,
"receiverName": "王先生",
"status": 5,
"ticketGroupId": 96324195,
"totalAmount": 454
}
{
"address": "湖北省 武汉市 洪山区 珞南街道448号狮城名居21栋9单元508",
"count": 2,
"deliverType": 1,
"expressInfo": {
"company": "顺丰快递",
"expressEvents": [
{
"description": "订单已提交,等待支付",
"time": 1572537720000
},
{
"description": "订单支付成功",
"time": 1572537720000
},
{
"description": "商家已备票完成,等待发货",
"time": 1572581212000
},
{
"description": "系统已发货, 顺丰快递:288202419156",
"time": 1572581456000
}
],
"expressNo": "288202419156"
},
"orderId": "sssssasasas",
"phone": "13517271212",
"pnOrderId": 1243969257,
"receiverName": "刘立",
"status": 4,
"ticketGroupId": 888013,
"totalAmount": 3348
}
{
"address": "null null",
"count": 1,
"deliverType": 4,
"expressInfo": {
"company": "",
"expressEvents": [
{
"description": "订单已提交,等待支付",
"time": 1572590928000
},
{
"description": "订单支付成功",
"time": 1572590938000
},
{
"description": "系统出票成功",
"time": 1572590965000
},
{
"description": "商家已备票完成,等待发货",
"time": 1572590965000
},
{
"description": "已确认到货",
"time": 1572590975000
},
{
"description": "自动发货",
"time": 1572590975000
}
],
"expressNo": ""
},
"orderId": "322612331651732",
"phone": "15026471566",
"pnOrderId": 12376817,
"receiverName": "张名捷",
"status": 5,
"ticketGroupId": 88445122,
"ticketReceipts": [
{
"serialNumber": "173265025405",
"status": 1,
"type": 1
}
],
"totalAmount": 1381
}