通用场景
履约推进过程中,更新履约变更状态
公共请求参数
业务请求参数
以下参数 二选一 传入必选
order_id|订单idstring[0,128]
【描述】交易组件订单号;order_id和out_order_id二选一
【示例值】2015042321001004720200028594
out_order_id|商户订单号string[0,64]
【描述】商户订单号,创建订单请求由商户传入;order_id和out_order_id二选一
【示例值】6823789339978248
以下参数 二选一 传入
user_id|买家支付宝用户idstring[0,64]
【描述】买家支付宝用户id,小程序场景下获取用户id请参考:用户授权; 其它场景下获取用户id请参考:网页授权获取用户信息。
新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请。
【示例值】2088***
open_id|用户openidstring[0,128]
【描述】买家open_id;open_id和user_id二选一 详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
status|履约推进状态可选string[0,64]
【描述】订单的履约状态
【枚举值】
已确认: confirmed
预约失败: cancelled
待入住: to_be_check_in
【示例值】confirmed
contact_info|联系人信息可选contactinfodto
【描述】联系人信息
phone_number|手机号可选string[1,64]
【描述】联系人手机号
【示例值】132********
contact_name|联系人姓名可选string[1,64]
【描述】联系人姓名
【示例值】张三
booking_info|酒店预订信息可选bookinginfodto
【描述】酒店预订信息
confirm_booking_time|确认预约时间条件必选string[0,64]
【描述】商户确认买家的预约
【必选条件】商户确认买家的预约, 已确认 状态下必选;
【示例值】2023-01-11 11:00:00
check_in_date|入住日期条件必选string[0,64]
【描述】入住日期
【必选条件】已入住、已续住、待退房、已退房 状态下必选
【示例值】2023-01-11
check_in_time|入住时间条件必选string[0,64]
【描述】入住时间
【必选条件】已入住、已续住、待退房、已退房 状态下必选
【示例值】2013-12-24 11:43:23
check_out_date|离店日期条件必选string[0,64]
【描述】离店日期
【必选条件】已入住、已续住、待退房、已退房 状态下必选
【示例值】2013-12-24 11:43:23
check_out_time|离店时间条件必选string[0,64]
【描述】离店时间
【必选条件】已入住、已续住、待退房、已退房状态下必选
【示例值】2013-12-24 11:43:23
booking_time|预约入住时间条件必选string[0,64]
【描述】预约入住时间
【必选条件】订单创建、已确认、待入住 状态下必传
【示例值】2013-12-24 11:43:23
have_stay_time|续住时间条件必选string[0,64]
【描述】商户为买家办理续住的时间,格式为:yyyy-mm-dd hh:mm:ss
【必选条件】已续住 状态下必选
【示例值】2013-12-24 11:43:23
room_num|房间号条件必选string[0,64]
【描述】入住酒店房间号
【必选条件】酒店日历房商品 已入住、待退房、已续住、已退房状态下必选
【示例值】204
deadline|最晚到店时间可选string[0,64]
【描述】最晚到店时间
【示例值】2013-12-24 11:43:23
customer_service_mobile|客服电话可选string[0,64]
【描述】客服电话,包含区号 电话号码的座机号码格式,以及手机号码格式。
【示例值】0571-88888888
refund_rule|退改规则可选string[0,2048]
【描述】退改规则
【示例值】阶梯退:入住前x天的x点,收取手续费:0%、30%、10%、100%
ticket_infos|票务信息列表可选array [1,50]
【描述】需要修改的票务信息列表
ticket_id|票编码id必选string[1,32]
【描述】票编码id,票的唯一标识
【示例值】20240222123058189321
event_id|场次id必选string[1,32]
【描述】场次id,场次唯一标识
【示例值】202402221230581892322
ticket_status|票状态可选string[1,16]
【描述】需要更新的票状态
【枚举值】
出票失败: un_ticket
待使用: to_use
已使用: used
【示例值】un_ticket
ticket_link|票据链接可选string[1,512]
【描述】需要更新的票据链接,跳转到票核销链接的地址
【示例值】alipays://platformapi/startapp?appid=xxx&page=xxx
event_status|场次状态可选string[1,16]
【描述】需要更新的演出场次状态
【枚举值】
演出延期: delay
演出取消: cancel
正常: normal
【示例值】normal
event_start_time|场次开始时间可选date
【描述】需要更新的场次开始时间
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2021-11-23 20:30:00
event_end_time|场次结束时间可选date
【描述】需要更新的场次结束时间
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2021-11-23 22:30:00
performance_seats|演出座位号可选string[1,32]
【描述】需要更新的演出座位号
【示例值】a区3排5座
activity_infos|活动信息列表可选array [1,20]
【描述】需要修改的活动信息列表
activity_id|活动id必选string[1,32]
【描述】活动编码id,活动的唯一标识
【示例值】20240222123058114335
activity_name|活动名称可选string[1,64]
【描述】需要更新的活动名称
【示例值】团建轰趴套餐
status|活动状态可选string[1,32]
【描述】需要更新的活动状态
【枚举值】
待使用: to_use
已结束: ended
已取消: cancelled
【示例值】to_use
start_time|开始时间可选date
【描述】需要更新的活动开始时间
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2021-11-23 20:30:00
end_time|结束时间可选date
【描述】需要更新的活动结束时间
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2021-11-23 22:30:00
link|活动票链接可选string[1,512]
【描述】需要更新的活动票据链接
【示例值】alipays://platformapi/startapp?appid=xxx&page=xxx
tour_info|出游信息可选tourinfodto
【描述】出游信息
from_location|始发地必选string[1,100]
【描述】始发地
【示例值】"杭州"
to_location|目的地必选string[1,64]
【描述】目的地
【示例值】"北京"
package_info|出游套餐信息可选tourpackageinfodto
【描述】出游套餐信息
departure_time|出发时间必选date
【描述】出发时间
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2024-03-15 13:00:00
return_time|回程时间必选date
【描述】回程时间
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2024-01-01 12:00:00
population|人数信息必选string[1,100]
【描述】人数信息
【示例值】2位成人,1位小孩
name|出行人姓名可选string[0,20]
【描述】出行人姓名
【示例值】李明
mobile|出行人电话可选string[0,20]
【描述】出行人电话
【示例值】15211111111
identity_card|出行人身份证信息可选string[0,20]
【描述】出行人身份证信息
【示例值】324752199401010011
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.mini.order.delivery.modify&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"order_id":"2015042321001004720200028594",
"out_order_id":"6823789339978248",
"open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
"user_id":"2088***",
"status":"confirmed",
"contact_info":{
"contact_name":"张三",
"phone_number":"132********"
},
"booking_info":{
"customer_service_mobile":"0571-88888888",
"room_num":"204",
"refund_rule":"阶梯退:入住前x天的x点,收取手续费:0%、30%、10%、100%",
"check_out_date":"2013-12-24 11:43:23",
"check_in_time":"2013-12-24 11:43:23",
"confirm_booking_time":"2023-01-11 11:00:00",
"have_stay_time":"2013-12-24 11:43:23",
"check_out_time":"2013-12-24 11:43:23",
"booking_time":"2013-12-24 11:43:23",
"deadline":"2013-12-24 11:43:23",
"check_in_date":"2023-01-11"
},
"ticket_infos":[
{
"ticket_status":"un_ticket",
"event_end_time":"2021-11-23 22:30:00",
"event_id":"202402221230581892322",
"ticket_link":"alipays://platformapi/startapp?appid=xxx&page=xxx",
"event_start_time":"2021-11-23 20:30:00",
"ticket_id":"20240222123058189321",
"performance_seats":"a区3排5座",
"event_status":"normal"
}
],
"activity_infos":[
{
"activity_name":"团建轰趴套餐",
"start_time":"2021-11-23 20:30:00",
"activity_id":"20240222123058114335",
"end_time":"2021-11-23 22:30:00",
"link":"alipays://platformapi/startapp?appid=xxx&page=xxx",
"status":"to_use"
}
],
"tour_info":{
"to_location":"\"北京\"",
"from_location":"\"杭州\"",
"package_info":{
"return_time":"2024-01-01 12:00:00",
"name":"李明",
"mobile":"15211111111",
"departure_time":"2024-03-15 13:00:00",
"identity_card":"324752199401010011",
"population":"2位成人,1位小孩"
}
}
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
无业务响应参数
响应示例
正常示例
异常示例
{
"alipay_open_mini_order_delivery_modify_response": {
"code": "10000",
"msg": "success"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
booking_status_is_finish | 日历房订单已经完结,不允许操作 | 日历房订单已经完结,不允许操作 |
booking_status_is_not_paid | 日历房未支付下单,不允许操作 | 支付完成,才允许操作 |
item_not_exist | 商品不存在 | 请传入正确的商品id |
mrch_order_error | 订单处理错误状态异常 | 请填写正确的订单 |
order_id_not_exist | 订单号不存在 | 请填写正确的订单id |
order_not_paid | 订单未支付 | 订单未支付,请在订单完成支付后发起调用 |