GetOrderStatus获取订单状态
接口说明 参数说明参数 | 类型 | 长度 | 可空 | 描述 |
---|---|---|---|---|
apiKey | string | 32 | 否 | 由官方平台提供的apiKey |
number | string | 20 | 否 |
我方或对接方订单号
全匹配,忽略大小写,不支持模糊查询 |
needConsumeList | bool | 20 | 是 |
提供:true、false
是否同时获取订单核销明细、退款手续费、可退款份数、可退款金额等信息,需要提供时接口查询效率将降低,建议在用户退款前的确认场景获取。 (退款前确认效果图) |
sign | string | 32 | 否 |
由apiSecret,与参数number生成的待签名字符串,通过MD5签名运算后的值。 签名规则 |
Json格式的Result对象
{
"ErrorCode": 0,
"Success": true,
"Message": null,
"HasException": false,
"Value":
{
"Status":7, //订单状态
"Number":"1111111111222222222", //我方订单号
"Barcode":"1234567", //直营消费凭证(直营景区入园/直通车乘车)
"ProductName":"(全)大理古城-崇圣寺三塔(往返直通车+门票)", //产品名称
"CreateDate":"2021-08-01 08:01:01", //订单创建时间
"SupplierBarcodes": //所含三方票,非三方票为空数组
[
{
"ProductName":"崇圣寺三塔", //三方票名称
"Barcode":"12345678", //三方入园码
"Status":"已付款" //三方状态枚举:等待付款,已付款,已消费,已退款,已取消,部分消费,未知状态
},
{
"ProductName":"景区电瓶车",
"Barcode":"12345678",
"Status":"已付款"
},
......
],
//如含有三方票,这里为三方返回的订单详情(可能为富文本HTML)非三方票无此字段
"Mark":"供应商订单状态:已消费/ 集团系统单号:123123123123123",
//核销明细,须指定查询才返回
"ConsumeList":[
{
"Id":111222, //订单内项目ID
"Name":"(全)大理火车站→大理古城南门垒翠园/直通车+蒋公祠|班次08-02/11:15", //项目概要
"PriceIndex":1, //价格类型,直通车中1=全票,2=半票,3=特惠票,跟团游中见PriceIndexName返回内容
"PriceIndexName":null, //价格类型名称(仅订单类型为跟团游时返回)
"Depart":{ //出发站点(仅直通车会返回)
"Id":3,
"Name":"大理火车站"
},
"Arrive":{ //到达站点(仅直通车会返回)
"Id":1,
"Name":"大理古城南门垒翠园"
},
"Code":"12345678", //消费凭证数字码(直营景区入园/直通车乘车)*通常情况下与订单Barcode相同
"ShuttleBusSchedule":"2021-08-04 12:30", //直通车班次,非直通车返回null
"Tickets":[
{
"ProductId":12, //项目内产品Id
"ProductName":"直通车券(大理火车站→大理古城南门垒翠园)", //项目内产品名称
"ProductType":4, //项目内产品类型(可参考产品列表接口中的枚举说明)
"AgentPrice":4, //下单结算单价(为0时表示赠送产品)
"CheckDate":"0001-01-01 00:00:00", //检票时间
"CheckedCopies":0, //检票数量
"Copies":2, //订购数量
"RefundCopies":0, //已退款数量
"RefundableCopies":2, //可退款数量
"RefundFactorage":{
"Item1":0, //退款规则,0:随时退、1:不可退、2:有条件退
"Item2":null, //有条件退时的退款规则(一般不用解析,如需了解规则详情请联系对接技术)
"Item3":0,
"Item4":0 //退款手续费金额(每份)*建议向游客展示
},
"RefundRemark":"08-09 11:15", //退款时温馨提示HTML格式
"Remark":null,
"ExpendCustomAfterMinutes":0 //延迟消费(分钟)
},
{
"ProductId":13,
"ProductName":"蒋公祠门票电子票(非物质文化遗产博物馆)",
"ProductType":1,
"AgentPrice":0,
"CheckDate":"0001-01-01 00:00:00",
"CheckedCopies":0,
"Copies":2,
"RefundCopies":0,
"RefundableCopies":2,
"RefundFactorage":{
"Item1":0,
"Item2":null,
"Item3":0,
"Item4":0
},
"RefundRemark":"",
"Remark":null,
"ExpendCustomAfterMinutes":0
}
]
}
],
//接驳服务订单才会返回
"Tranship":{
"UniqueId":12345, //接驳订单ID
"DriverName":"张三", //司机姓名
"DriverTel":"11111111111", //司机电话
"CarName":"别克GL8", //车辆名称
"CarNo":"云L21212", //车牌号
"CarColor":"黑色", //车辆外观颜色
"CarModel":"商务车", //车型
"Status":"3", //接驳状态:等待派车 = 1,已指派司机 = 2,司机已确认出发=3,司机已接到客人=4,已完成 = 5,已取消 = 6
"GetOrderTime":"2021-08-01 08:30:00", //指派司机时间
"GoTime":"2021-08-01 08:40:00", /司机出发时间
"GetTouristTime":"2021-08-01 08:30:00", //接到客人时间
"ArriveTime":"2021-08-01 08:30:00", //到达目的地时间
"WishTime":"2021-08-01 08:30:00", //游客期望上门接驳的时间
"DriverLocation":{ //当前司机位置(经度、纬度)
"Lng":100.10011,
"Lat":25.22221
}
}
}
"Tag": null
}
以“大理古城↔崇圣寺三塔(往返直通车+成人票+随车讲解)”直通车套票为例

返回值 | 描述 |
---|---|
Success | 本次调用是否成功 |
ErrorCode | 错误代码 |
Message | 失败时为异常信息,成功时为null |
Value |
Status - 订单状态 Number - 我方订单号 ProductName - 产品名称 SupplierBarcodes - 所含电子票(0到多个),对接方可根据电子票的入园码生成二维码提供给客人,客人凭此码可扫码入园。 注:如果订单既包含电子票又包含实体票,实体票仍需要到我方门店换取 常用订单状态值说明: 3 : 退款处理中 4 : 退款成功 5 : 退款否决 7 : 已付款 8 : 已完成 //订单消费完成 11 : 占座失败已退款 //直通车占座位失败 |
Tag | 如无特别说明,在返回数据带分页的情况下,Tag一般指查询记录的总条数,其它情况为null |