资源描述
CONFIDENTIAL MATERIAL / RESTRICTED ACCESS
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
美团
回调API使用式样书
第0.4版
2015年9月18日
作 成 者
2015/09/09
Zhangqw
修正履歴
版数
修正年月日
修正箇所
修正概要
修正者
0.1
2015/9/9
全般
初版
Zhangqw
0.2
2015/9/16
3.确认订单已经下载
修改参数名称
Zhangqw
0.3
2015/9/17
增加4.用户或者客服取消订单API
Zhangqw
0.4
2015/9/23
增加5. 美团用户或客服进行退款流程操作api6. 商家获取申请退款信息api
Zhangqw
案例
A:美团外卖
1,推送订单API,
2,美团用户或客服取消API,
3,美团用户或客服退款流程操作API.
B:门店
1,获取门店订单详情API,
2,确认订单已经下载API,
3,获取申请退款信息API.
目录
一、 接口说明 3
1.推送订单API 3
2. 获取门店订单详情 5
3. 确认订单已经下载 7
4. 用户或客服取消订单API 7
5.美团用户或客服进行退款流程操作 8
6. 商家获取申请退款信息 8
一、 接口说明
1.推送订单API
REST地址
请求方法
POST
说明
确认订单后供美团回调(参照:推送订单API(必接).)
请求参数
名称
说明
order_id
订单ID
wm_order_id_view
订单展示ID
app_poi_code
APP方商家ID
wm_poi_name
美团商家名
wm_poi_address
美团商家地址
wm_poi_phone
美团商家电话
recipient_address
收件人地址
recipient_phone
收件人电话
recipient_name
收件人姓名
shipping_fee
门店配送费
total
总价
original_price)
原价
caution
忌口或备注
shipper_phone
送餐员电话
status
订单状态
city_id
城市ID(目前暂时用不到此信息)
has_invoiced
是否开发票
invoice_title
发票抬头
ctime
创建时间
utime
更新时间
delivery_time
用户预计送达时间,“立即送达”时为0
is_third_shipping
是否为美团商家、APP方配送(0:否;1:是)
pay_type
支付类型(1:货到付款;2:在线支付)
latitude
实际送餐地址纬度
longitude
实际送餐地址经度
detail
此字段为Json串,具体格式如下:
"detail": [{
"app_food_code": 1,
"food_name": "狗不理",
"sku_id": "1",
"quantity": 6,
"price": 100,
"box_num":2,
"box_price":1,
"unit": "份",
"food_discount": 0.8 (菜品折扣,只是美团商家、APP方配送的门店才会设置,默认为1。折扣值不参与总价计算。开放平台1.0.3 新增)},
{"..."}]
extras
此字段为Json串,具体格式如下:
"extras": [{
"act_detail_id":10,(活动id)
"reduce_fee": 2.5, (活动优惠金额,是美团承担活动费用和商户承担活动费用的总和)
"remark": "满10元减2.5元",(优惠说明)
“type":1,(活动类型)
“avg_send_time”:5.5(餐厅平均送餐时间,单位为分钟)},
{"reduce_fee": 5,
(优惠金额,是美团承担活动费用和商户承担活动费用的总和)
"remark": "新用户立减5元",(优惠说明)
“type":1,(活动类型)
“avg_send_time”:1.0(餐厅平均送餐时间,单位为分钟)},
{…}]
返回值
调用成功返回值:{"data" : "ok"},其余情况请参考 "快速开始-返回参数格式说明"
※①post的Content-Type字段为text,所有参数均为普通post参数,不是json ②美团推送的参数未排序,请将参数排序后再计算sig
2. 获取门店订单详情
REST地址
请求方法
GET
说明
获取门店未确认的订单
请求参数
名称
是否为空
说明
app_id
否
appid
app_poi_code
否
门店id
timestamp
否
sig
否
返回值
名称
说明
order_id
订单ID
wm_order_id_view
订单展示ID
app_poi_code
APP方商家ID
wm_poi_name
美团商家名
wm_poi_address
美团商家地址
wm_poi_phone
美团商家电话
recipient_address
收件人地址
recipient_phone
收件人电话
recipient_name
收件人姓名
shipping_fee
门店配送费
total
总价
original_price)
原价
caution
忌口或备注
shipper_phone
送餐员电话
status
订单状态
city_id
城市ID(目前暂时用不到此信息)
has_invoiced
是否开发票
invoice_title
发票抬头
ctime
创建时间
utime
更新时间
delivery_time
用户预计送达时间,“立即送达”时为0
is_third_shipping
是否为美团商家、APP方配送(0:否;1:是)
pay_type
支付类型(1:货到付款;2:在线支付)
latitude
实际送餐地址纬度
longitude
实际送餐地址经度
detail
此字段为Json串,具体格式如下:
"detail": [{
"app_food_code": 1,
"food_name": "狗不理",
"sku_id": "1",
"quantity": 6,
"price": 100,
"box_num":2,
"box_price":1,
"unit": "份",
"food_discount": 0.8 (菜品折扣,只是美团商家、APP方配送的门店才会设置,默认为1。折扣值不参与总价计算。开放平台1.0.3 新增)},
{"..."}]
extras
此字段为Json串,具体格式如下:
"extras": [{
"act_detail_id":10,(活动id)
"reduce_fee": 2.5, (活动优惠金额,是美团承担活动费用和商户承担活动费用的总和)
"remark": "满10元减2.5元",(优惠说明)
“type":1,(活动类型)
“avg_send_time”:5.5(餐厅平均送餐时间,单位为分钟)},
{"reduce_fee": 5,
(优惠金额,是美团承担活动费用和商户承担活动费用的总和)
"remark": "新用户立减5元",(优惠说明)
“type":1,(活动类型)
“avg_send_time”:1.0(餐厅平均送餐时间,单位为分钟)},
{…}]
3. 确认订单已经下载
REST地址
请求方法
POST
说明
订单下载成功后,调用此接口修改订单下载状态
请求参数
名称
说明
app_id
order_id_list
订单ids, order_id数组:[id1,id2,id3...,idN]
timestamp
sig
返回值
调用成功返回值:{"data" : "ok"},其余情况请参考 "快速开始-返回参数格式说明"
4. 用户或客服取消订单API
REST地址
请求方法
GET
说明
美团外卖会取消订单回调接口(参照用户或客服取消订单API(必接))
请求参数
名称
说明
app_id
timestamp
sig
order_id
订单ID
reason_code
规范化的订单取消code,详情请参考(取消订单原因列表)
reason
取消原因
返回值
调用成功返回值:{"data" : "ok"},其余情况请参考 "快速开始-返回参数格式说明"
5.美团用户或客服进行退款流程操作
REST地址
请求方法
GET
说明
美团用户或客服进行退款流程操作(参照美团用户或客服进行退款流程操作)
请求参数
名称
说明
app_id
timestamp
sig
order_id
订单ID
notify_type
通知类型,apply:发起退款
agree:确认退款
reject:驳回退款
cancelRefund:用户取消退款申请
cancelRefundComplaint :取消退款申诉
reason
原因
返回值
调用成功返回值:{"data" : "ok"},其余情况请参考 "快速开始-返回参数格式说明"
6. 商家获取申请退款信息
REST地址
请求方法
GET
说明
商家获取申请退款信息
请求参数
名称
说明
app_id
timestamp
sig
notify_type
通知类型,apply:发起退款
agree:确认退款
reject:驳回退款
cancelRefund:用户取消退款申请
cancelRefundComplaint :取消退款申诉
返回值
调用成功返回值:{"data":[{"notify_type":" apply ","order_id":6124982,"reason":"不想退了"},{"notify_type":" apply ","order_id":6124985,"reason":"我也不想退了"},{"notify_type":" apply ","order_id":6124987,"reason":""},{…}]}
order_id
订单ID
notify_type
通知类型,apply:发起退款
agree:确认退款
reject:驳回退款
cancelRefund:用户取消退款申请
cancelRefundComplaint :取消退款申诉
reason
原因
其余情况请参考 "快速开始-返回参数格式说明"
注:计算签名方式同美团计算签名
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
9
All Rights Reserved, Copyright zhangqw(QQ:1243689751)
展开阅读全文