一. 开发须知

1. 申请开发者

申请成为开发者并获取app_id和app_secret，由系统自动分配，请联系我们客服电话

以下为测试所需的app_id与app_secret，下面为测试层通用

开发者ID：app_id （4370248095）

开发者密匙：app_secret（E4cEsLDUDeNtBs0UewF3VXenZcCWf2b7）

2. API调用规范

所有接口都采用HTTP协议

所有API接口都采用POST方式（包括查询接口），授权接口使用GET

请求和响应的数据都为JSON格式。注：请设置Header的Content-Type为application/json

采用UTF-8字符编码

所有的接口必须app_secret进行接口签名，规则见：接口签名规则

3. API请求参数说明

1）公共参数

名称	类型	必传	描述
app_id	int	是	开发者编号
timestamp	int	是	10位时间戳，1622944672
shop_id	int	是	云昊聚合送门店编号，授权后同步给第三方
open_id	string	是	每个第三方对应的门店有唯一值，每次重新授权，将会再次改变，授权后同步给第三方

2）业务参数

名称	类型	必传	描述	默认值
order_id	int	是	订单ID，所有销售渠道对应的订单
send_id	int	否	运单ID，不指定运单将处理订单下所有运单

3）加密参数

名称	类型	必传	描述	默认值
signature	string	是	由公共参数和业务参数通加规则生成的参数

4. API响应结果说明

1）返回参数

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，大于0表示失败
msg	string	是	结果返回文字说明：OK

2）错误说明

错误编号(code)	描述(msg)
1000	参数错误
1001	加密参数错误

5. API调用环境

测试商家账号：13129316388

测试商家密码：w123456

测试运营调用URI：http://test.wdd88.com/fanpu/yhsend

线上测试运营调用URI：http://send.wdd88.com

实际运营调用URI：https://www.yhsend.com

6. 接口签名规则

1）签名算法

签名生成的通用步骤如下：

第一步：将参与签名的参数按照键值(key)进行字典排序

第二步：将排序过后的参数，进行key和value字符串拼接

第三步：将拼接后的字符串首尾加上sign_key秘钥，合成签名字符串

第四步：对签名字符串进行MD5加密，生成32位的字符串

第五步：将签名生成的32位字符串转换为大写

2.）签名示例（使用本文档开头的开发者账号举例），推送原始数据：

公共参数：

{

"app_id":100001,

"shop_id":361，

"open_id":361，

"timestamp":1622944672

}

业务参数：

{

"shop_name":"马来一号(长福店)",

"address":"广东省广州市天河区长福路100",

"phone":"13504478482",

"map_address":"长兴智汇G座",

"map_lng":"113.348166",

"map_lat":"23.166294",

"map_lng":"113.348166"

}

第一步：将上述请求业务参数与公共参数按照键值(key)进行字典排序

{

"address":"广东省广州市天河区长福路100",

"app_id":100001,

"map_address":"长兴智汇G座",

"map_lat":"23.166294",

"map_lng":"113.348166",

"open_id":361,

"phone":"13504478482",

"shop_id":361, (*通过生成授权链接然后绑定店铺成功后返回)

}

第二步：将排序过后的参数，进行key和value字符串拼接

将参数中的key和value按照key的顺序进行字符串拼接。结果为：

address=广东省广州市天河区长福路100map_address=长兴智汇G座map_lat=23.166294map_lng=113.348166phone=13504478482plat_id=6218plat_shop_id=0plat_shop_name=马来一号(长福店)shop_id=361shop_name=马来一号(长福店)T

第三步：将拼接后的字符串首尾加上app_secret秘钥（TUddhgiur68kdfds）。结果为：

TUddhgiur68kdfdsaddress=广东省广州市天河区长福路100map_address=长兴智汇G座map_lat=23.166294map_lng=113.348166phone=13504478482plat_id=6218plat_shop_id=0plat_shop_name=马来一号(长福店)shop_id=361shop_name=马来一号(长福店)TUddhgiur68kdfds

第四步：对签名字符串进行MD5加密，生成32位的字符串

对生成签名字符串进行MD5加密。结果为：

579bdf6bb7cc21bb6bfd55d4368ec0ad

第五步：将签名生成的32位字符串转换为大写

将md5加密后的字符串转换为大写，生成最终的签名的字符串：579BDF6BB7CC21BB6BFD55D4368EC0AD作为请求参数的signature的值传入即可

{

"address":"广东省广州市天河区长福路100",

"app_id":100001,

"map_address":"长兴智汇G座",

"map_lat":"23.166294",

"map_lng":"113.348166",

"phone":"13504478482",

"shop_id":361,

"signature":"579BDF6BB7CC21BB6BFD55D4368EC0AD"

}

枚举数据

1）订单来源

来源编号(source)	描述
meituan	美团外卖
elem	饿了么
baidu	饿百零售
jddj	京东到家
douyin	抖音
youzan	有赞
weimob	微盟
fengshi	丰食
wmb	自营销售，包括自己小程序，公众号，自助下单等

2）配送通道

聚合配送	自运力配送	描述
	own	商家自配
yhdada	daown	达达
yhsf	sf	顺丰同城
yhuu	uu	UU跑腿
	mtpt	美团跑腿，目前仅支持内部系统使用
yhfn	fn,fnv	蜂鸟跑腿,蜂鸟品质达
yhmtps	mtps	美团企客
yhss	ss	闪送
	apt	爱跑腿
yhgxd	gxd	裹小递

3）订单状态

状态(sort)	描述
create	新订单
confirm	订单确认成功
cancel	订单取消成功
finish	订单完成
send	订单平台配送触发
reject	顾客申请取消或取消申请取消
remind	顾客催单
bind	平台授权绑定或解除授权

4）配送状态

状态(status)	描述
appoint	已派配送池
receive	已抢单待取货
station	已到店待出发
deliver	配送出发
arrived	配送完成
cancel	配送取消

二. 门店对接

门店授权

主要用作已在云昊聚合送开好店铺，需要接入其他系统，从其他系统派单时使用

1) 生成授权链接

请求方式GET

打开浏览器，访问如下地址（请将app_id，timestamp，third_shop_id等参数值替换为你自己的）

名称	类型	必传	描述
app_id	int	是	开发者编号
timestamp	int	是	10位时间戳，1622944672
third_shop_id	int	是	授权方的门店ID，同一第三方必须唯一
redirect_url	string	是	授权成功后回调地址
signature	string	是	由公共参数和业务参数通加规则生成的参数

API调用环境域名（url） + /open/token/auth?app_id=100008&third_shop_id=312313&signature=xxxxxxxxxxx&redirect_url=http%3A%2F%2Fsaas.abcd.com%2Flogistic%2Fauth%2F&signature=26C84625A55E97A2E620747BCD5F9B27

2) 登陆账号

授权的商家登录自己的账号和密码

3) 选择门店

登录完成后跳转到选择门店页面，授权成功后返回open_id和shop_id参数

4) 回调授权信息

第三方门店与云昊聚合送一一对应，如果换店授权，会取消原授权，回调后，记录云昊对应的唯一门店编号，并与第三方对应的门店编号做好关联性记录。回调链接由服务商提供，客服设置，暂不支持自助配置，redirect_uri例：

名称	类型	必传	描述
app_id	int	是	开发者编号
timestamp	int	是	10位时间戳，1622944672
third_shop_id	int	是	授权方的门店ID，同一第三方必须唯一
shop_id	int	是	云昊门店编号，授权时第三方保存
open_id	int	是	门店唯一识别码，授权时第三方保存
signature	string	是	由公共参数和业务参数通加规则生成的参数

http://saas.abcd.com/logistic/auth?app_id=100008&third_shop_id=312313&shop_id=312313&signature=xxxxxxxxxxx

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

修改门店

请求接口：open/shop/update

对授权后的门店信息进行修改

API请求参数说明

名称	类型	必传	描述	默认值
app_id	int	是	开发者ID
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	授权后或者品牌添加门店后编号
open_id	int	是	门店唯一识别码，授权时第三方保存
data[]	array	是	门店信息收集
└ city_name	string	是	所在城市：如广州，上海，北京
└ client_name	string	是	门店名称
└ client_code	string	否	门店编号
└ phone	string	否	门店客服电话
└ address	string	是	门店地址
└ map_address	string	否	门店定位地址，不填与地址相同
└ map_lng	string	是	门店经纬度，
└ map_lat	string	是	门店经纬度

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

门店解绑

请求方式GET

名称	类型	必传	描述	默认值
app_id	int	是	开发者编号
timestamp	int	是	10位时间戳，1622944672
third_shop_id	int	是	授权方的门店ID，同一第三方必须唯一
signature	string	是	由公共参数和业务参数通加规则生成的参数

API调用环境建议先使用测试运营的url/open/token/unauth?app_id=100008&third_shop_id=3123132&signature=xxxxxxxxxxx

三. 基础业务

门店接口

1.1 门店创建

请求接口：open/shop/create

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
mobile	string	否	门店管理账号，不传不创建管理号
third_shop_id	int	是	第三方系统对应的门店编号
data	array	是	门店参数收集
└ client_name	string	是	门店名称
└ client_code	string	否	门店编号
└ phone	string	是	门店客服电话，可与门店账号手机号不同
└ address	string	是	门店地址
└ map_lng	string	是	门店定位，经度
└ map_lat	string	是	门店定位，纬度

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK
shop_id	int	是	门店的编号
open_id	string	是	门店的请求唯一识别码

#创店前的加密参数对照：

我方提供的秘钥app_id=291606966data={"address":"对接方店铺地址","client_code":"001","client_name":"对接方店铺名","map_lat":"39.92800","map_lng":"116.40400","phone":"电话"}mobile=账户登录手机third_shop_id=1timestamp=1699329750我方提供的秘钥

1.2 门店自动登陆

请求接口：open/token/auto_login，请求方法：GET

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取/
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
mobile	string	是	门店管理账号

1.3 门店修改

请求接口：open/shop/update

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	云昊系统对应的门店编号
data	array	是	门店参数收集
└ client_name	string	是	门店名称
└ client_code	string	否	门店编号
└ phone	string	是	门店客服电话，可与门店账号手机号不同
└ address	string	是	门店地址
└ map_lng	string	是	门店定位，经度
└ map_lat	string	是	门店定位，纬度

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK
shop_id	int	是	门店的编号
open_id	string	是	门店的请求唯一识别码

#创店前的加密参数对照：

1.4 线上门店授权

请求接口：open/store/plats

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	云昊系统对应的门店编号

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK
plats[]	array	是	线上平台
└ id	int	是	平台ID
└ source	string	是	平台类型：meituan美团，elem饿了么
└ plat_name	string	是	平台名称
└ full_name	string	是	线上平台名字
└ is_auth	int	是	是否已经授权
└ plat_shopid	int	是	线上门店编号

1.5 第三方配送授权

请求接口：open/store/sends

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	云昊系统对应的门店编号

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK
sends[]	array	是	线上配送平台
└ id	int	是	平台ID
└ sort	string	是	平台类型：daown达达，sf顺丰，ss闪送，uu跑腿，mtps美团企客，mtpt美团跑腿，fn蜂鸟跑腿，fnv蜂鸟品质达
└ client_id	int	是	门店编号
└ is_open	int	是	是否有打开
└ is_auth	int	是	是否已经授权
└ third_user_id	string	是	第三方商家编号
└ third_shop_id	string	是	第三方门店编号

1.6 当天即时单状态

请求接口：open/store/status

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	云昊系统对应的门店编号

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

status	array	是	订单状态
└ unknown	string	是	待接单
└ prepare	string	是	准备中
└ package	string	是	已打包
└ receive	string	是	是否有打开已接单
└ station	string	是	已到店
└ deliver	string	是	已配送出发
└ arrived	string	是	已送达
└ error	string	是	已取消

1.7 门店打印机列表

请求接口：open/store/prints

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	云昊系统对应的门店编号

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK
prints[]	array	是	打印机列表
└ id	int	是	打印机ID
└ client_id	int	是	门店编号
└ device_sort	string	是	打印机品牌
└ device_sn	string	是	打印机编号
└ device_key	string	是	打印机密匙
└ ticket_sort	string	是	打印票类型
└ ticket_num	int	是	打印票联数
└ is_style	int	是	是否自定义样式
└ style_content	string	是	自定义样式详情

1.8 门店配送设置

请求接口：open/store/appoint

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	云昊系统对应的门店编号

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK
appoint	array	是	打印机列表
└ send_from	string	是	自动派单通道
└ auto_plats	string	是	自动派单渠道选择，空或-1全部派
└ price_minute	int	是	轮投时间
└ price_sends	string	是	轮投指定配送
└ price_setting	string	是	轮投其他数据
└ price_max	double	是	轮投最高限价
└ prepare_minute	int	是	即时单派单发起时间
└ appoint_minute	int	是	预约单往前推派单时间

1.9 溢出创店创单

请求接口：open/shop/order_create

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取/
third_shop_id	int	是	第三方系统对应的门店编号，唯一性
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则

data	array	是	门店参数收集
└ client_name	string	是	门店名称
└ client_code	string	否	门店编号
└ phone	string	是	门店客服电话，骑手电话
└ address	string	是	门店地址
└ map_lng	string	是	门店定位，经度
└ map_lat	string	是	门店定位，纬度

order	array	是	订单数据列表
└ plat_num	int	是	销售渠道顺序号：1、2、3....
└ order_no	string	是	订单编号，每个渠道唯一，如果订单号重复，即使用重复推送，也不记录
└ buyer_name	string	是	购买人名称
└ buyer_phone	string	是	购买人电话，外卖必填
└ buyer_address	string	是	购买人详细地址，外卖必填
└ buyer_lng	string	是	外卖单经度，外卖必填
└ buyer_lat	string	是	外卖单纬度，外卖必填
└ required	string	是	顾客备注，配送默认传送
└ good_time	int	是	建议送达时间戳：1540821500
└ created_at	int	是	下单时间戳：1540821500
└ send_amount	double	是	配送费，重要，以此价格判断选择的配送通道
└ order_amount	double	是	顾客实际支付金额
└ products[]	array	是	订单下的打印商品及其优惠信息，二维数组
└ buy_num	int	是	购买数量
└ buy_price	double	是	购买价格
└ origin_price	double	是	商品原价
└ is_product	int	是	计价商品1，非商品为0，
└ product_name	string	是	商品名称-规格名称：海南鸡饭-芒果汁或优惠信息名称：满50减10
└ extend_name	string	否	规格名称，如果product_name包含了规格名称，当前项就必填：芒果汁
└ spec	string	否	商品属性：温,辣；逗号(,)分隔

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
shop_id	int	是	云昊门店编号
open_id	string	是	云昊关联open_id，唯一性
order_id	int	是	当前订单ID
msg	string	是	结果返回文字说明：OK

2.0 门店IM设置

请求接口：open/store/im

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	云昊系统对应的门店编号
im	array	是	设置的IM参数，不传参数返回当前门店IM设置
└ is_im	int	是	0暂停IM，1开启IM
└ is_auto_reply	int	是	1自动回复，0不自动回复
└ is_status	int	是	1回复内容包含订单状态相关信息，0不包含
└ reply_content	string	是	回复的内容

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

订单对接

主要针对销售平台（小程序，自研系统订单）推送订单到云昊聚合送，后续由云昊聚合送完成所有配送工作，同时回调配送状态和相关信息到原系统

2.1 预估价格

请求接口：open/order/send_amount

API请求参数说明

名称	类型	必传	描述	默认值
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
is_merge	string	是	1
sort	string	是	传range默认返回价格范围
order[	List< Integer>	是	订单坐标
buyer_name			购买人名字
buyer_phone			购买人电话
buyer_address			购买人地址
map_lng			地址经度
map_lat			地址纬度
]

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
sort	int	是	配送渠道
amount	int	是	订单总价（元）
discount	int	是	优惠金额（元）
distance	int	是	订单距离（米）
msg	string	是	结果返回文字说明：OK

2.2 推送订单

请求接口：open/order/create

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取/
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
is_auto_send	int	否	是否自动派单,0不派，1派并限额判断系统会用send_amount来做限额判断，2派不限额派单。派单状态下必须有配送接入了
order	array	是	订单数据列表
└ status	string	是	unknown未接单；confirm已接单
└ send_status	string	是	unknown未接单；prepare已接单
└ pay_status	string	是	unknown未支付；success已支付
└ service_type	string	是	arrived外卖，live堂食，station自提
└ plat_num	int	是	销售渠道顺序号：1、2、3....
└ order_no	string	是	订单编号，每个渠道唯一，如果订单号重复，即使用重复推送，也不记录
└ desk_code	string	否	堂食桌号
└ buyer_name	string	是	购买人名称
└ buyer_phone	string	是	购买人电话，外卖必填
└ buyer_address	string	是	购买人详细地址，外卖必填
└ map_address	string	是	详细地址，外卖必填
└ buyer_lng	string	是	外卖单经度，外卖必填
└ buyer_lat	string	是	外卖单纬度，外卖必填
└ required	string	是	顾客备注
└ is_send_appoint	int	是	1表示预订单，指定good_time送达；0表示即时单
└ good_time	int	是	预订单送达时间戳：1540821500；非预定填写0
└ created_at	int	是	下单时间戳：1540821500
└ origin_amount	double	是	商品原价总额
└ product_amount	double	是	商品售价总额
└ product_num	double	是	商品数量
└ box_amount	double	是	餐盒费
└ send_amount	double	是	配送费
└ order_amount	double	是	顾客实际支付金额
└ income_amount	double	是	商家实际收取金额
└ discount_amount	double	是	商家优惠（代金券，门店新客等）
└ service_amount	double	是	服务费，比如渠道收取一点的佣金，微信支付收费的接口费等
└ is_invoice	int	是	1是，0否发票
└ invoice_name	string	是	发票信息
└ products[]	array	是	订单下的打印商品及其优惠信息，二维数组
└ buy_num	int	是	购买数量
└ buy_price	double	是	购买价格
└ origin_price	double	是	商品原价
└ is_product	int	是	计价商品1，非商品为0，
└ product_name	string	是	商品名称-规格名称：海南鸡饭-芒果汁或优惠信息名称：满50减10
└ extend_name	string	否	规格名称，如果product_name包含了规格名称，当前项就必填：芒果汁
└ spec	string	否	商品属性：温,辣；逗号(,)分隔

#推单加密前参数对照：

E4cEsLDUDeNtBs0UewF3VXenZcCWf2b7app_id=4370248095open_id=Z3gN3P0FkD4UTgK2YdsDLVEhMmItYsorder={"status":"confirm","send_status":"prepare","pay_status":"success","service_type":"arrived","plat_num":"1","order_no":"123445678","buyer_name":"刘彦杰","buyer_phone":"18768861942","buyer_address":"外卖地址","buyer_lng":"116.64858059153616","buyer_lat":"34.68742921098428","is_send_appoint":0,"good_time":0,"created_at":1681283002,"origin_amount":50,"product_amount":50,"box_amount":0,"send_amount":0,"order_amount":50,"income_amount":50,"discount_amount":0,"service_amount":0,"is_invoice":0,"required":"","products":[{"buy_num":1,"buy_price":50,"extend_name":"","is_product":1,"origin_price":50,"product_name":"测试商品"}]}shop_id=3661timestamp=1681283002E4cEsLDUDeNtBs0UewF3VXenZcCWf2b7

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
order_id	int	是	结果返回订单编号
msg	string	是	结果返回文字说明：OK

2.3 取消订单

请求接口：open/order/order_cancel

API请求参数说明

名称	类型	必传	描述	默认值
app_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
order_no	string	是	订单编号
cancel_reason	string	是	取消原因

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

2.4 审核申请取消

请求接口：open/order/refund_confirm

API请求参数说明

名称	类型	必传	描述	默认值
app_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
order_no	string	是	订单编号
is_reject	int	是	0同意取消，1拒绝取消

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

配送接口

3.1 配送派单

请求接口：open/send/appoint

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
order_no	string	是	推送订单的订单号
sort	string	是	group一单多投，price价格轮投，cheap底价兜底，其他的类型请联系系统方
deliver_amount	string	否	指定配送金额限价，不传表示不限价

API响应结果说明

3.2 配送员定位

请求接口：open/send/sender

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
send_id	string	是	配送单编号，从外卖邦派单成功后返回

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK
deliver	array	是
└ sender_name	string	是	配送员名称
└ sender_mobile	string	是	配送员电话
└ map_lng	string	否	经纬度
└ map_lat	string	否	经纬度

3.3 配送余额

请求接口：open/send/pay_amount

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
send_id	string	是	1.5 返回的配送授权的id

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK
data	array	是
└ amount	string	是	配送余额

3.4 自动派单

3.4.1 自动派单查询

请求接口：open/setting/appoint_auto

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
is_auto_appoint	string	是	0手动派单，1自动派单
data	array	是	自动派单设置，建议与电脑版选择器的值对齐
└ plat_ids[]	array	是	配送通道ID
└ send_from	string	是	配送通道，参考开发须知1.2
└ tips_amount	double	是	默认加小费
└ prepare_amount	double	是	即时单来单派单分钟数
└ is_advance	int	是	预约单三种自动方式：0预约时间前N分钟
└ advance_minute	double	是	预约单自动方式等于0时的分钟数

3.4.2 自动派单设置

请求接口：open/setting/appoint_auto

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
is_auto_appoint	string	是	0手动派单，1自动派单
data	array	是	自动派单设置，建议与电脑版选择器的值对齐
└ plat_ids[]	array	是	配送通道ID
└ send_from	string	是	配送通道，参考开发须知1.2
└ tips_amount	double	是	默认加小费
└ prepare_amount	double	是	即时单来单派单分钟数
└ is_advance	int	是	预约单三种自动方式：0预约时间前N分钟
└ advance_minute	double	是	预约单自动方式等于0时的分钟数

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

3.5 自动轮投

3.5.1 自动轮投查询

请求接口：open/setting/appoint_price

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
is_send_price	int	是	是否价格轮投
data	array	是	自动派单设置，建议与电脑版选择器的值对齐
└ price_sends[]	array	是	配送通道，参考开发须知1.2
└ price_setting[]	array	否	价格补偿
└ sort	string	是	配送通道，参考开发须知1.2
└ price	double	是	补偿价格
└ price_minute	int	是	轮投间隔分钟数
└ price_max	double	是	最高配送费限制

3.5.2 自动轮投设置

请求接口：open/setting/appoint_price

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
is_send_price	int	是	是否价格轮投
data	array	是	自动派单设置，建议与电脑版选择器的值对齐
└ price_sends[]	array	是	配送通道，参考开发须知1.2
└ price_setting[]	array	否	价格补偿
└ sort	string	是	配送通道，参考开发须知1.2
└ price	double	是	补偿价格
└ price_minute	int	是	轮投间隔分钟数
└ price_max	double	是	最高配送费限制

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

3.6 配送投诉

请求接口：open/send/complaint

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
send_id	string	是	根据订单数据返回的配送单id
complaint	array	是
└ code	string	是	投诉编码：230:其他, 150:未保持餐品完整, 160:服务态度恶劣,190:额外索取费用,170:诱导收货人或商户退单,140:提前点击送达,210:虚假标记异常,220:少餐错餐,200:虚假配送, 130:未进行配送
└ desc	string	是	投诉原因描述

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

3.7 配送索赔

请求接口：open/send/claim

API请求参数说明

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
shop_id	int	是	外卖邦门店ID，从客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
send_id	string	是	根据订单数据返回的配送单id
claim	array	是
└ code	string	是	索赔编码：150: 未保持餐品完整,160: 服务态度恶劣,170: 诱导收货人或商户退单,210:虚假标记异常,130: 骑手接单后未完成配送,320:少餐错餐,190:额外索取费用,140:提前点击送达,200:骑手点击配送成功，实际未配送
└ desc	string	是	索赔原因描述
└ amount	double	是	索赔金额，单位元

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

打印接口

4.1 云打印

请求接口：open/order/cloud_print

API请求参数说明

名称	类型	必传	描述	默认值
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
order_id	int	是	创建订单返回的订单ID

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

4.2 云声音播报

请求接口：open/order/cloud_sound

API请求参数说明

名称	类型	必传	描述	默认值
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
message	string	是	创建订单返回的订单ID自定义播报的内容

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

4.3 云打印机配置

请求接口：open/setting/print_edit

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
print_id	int	是	打印机ID
data	array	是	打印机配置内容
└ nickname	string	是	打印机别名
└ ticket_num	int	是	打印机联数，0表示不打印
└ remark	string	是	打印票底部内容
└ remark_top	string	是	打印票头部内容

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

4.4 云打印机样式

请求接口：open/setting/print_style

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
print_id	int	是	打印机ID
is_style	int	是	样式类型，0默认样式，1自定义样式
styles[key]	array	否	打印机选择的样式，key值表示样式的对应项，保存时按style[key]=value返回
└ shop_name	string	是	门店名称：大字big,中字mid,小字small,隐藏hidden
└ required	string	是	备注：大字big,中字mid,小字small,隐藏hidden
└ invoice	string	是	发票：大字big,中字mid,小字small,隐藏hidden
└ created_at	string	是	下单时间：大字big,中字mid,小字small,隐藏hidden
└ good_time	string	是	送达时间：大字big,中字mid,小字small,隐藏hidden
└ order_no	string	是	订单编号：大字big,中字mid,小字small,隐藏hidden
└ product	string	是	商品信息：大字big,中字mid,小字small,隐藏hidden
└ product_sku	string	是	商品货码：大字big,中字mid,小字small,隐藏hidden
└ product_upc	string	是	商品条码：大字big,中字mid,小字small,隐藏hidden
└ product_shelf	string	是	商品货架：大字big,中字mid,小字small,隐藏hidden
└ discount	string	是	优惠信息：大字big,中字mid,小字small,隐藏hidden
└ amount	string	是	订单金额：大字big,中字mid,小字small,隐藏hidden
└ order_amount	string	是	顾客实付：大字big,中字mid,小字small,隐藏hidden
└ address	string	是	顾客地址：大字big,中字mid,小字small,隐藏hidden
└ phone	string	是	顾客电话：大字big,中字mid,小字small,隐藏hidden
└ remark	string	是	商家备注：大字big,中字mid,小字small,隐藏hidden
└ top	string	是	页头广告：大字big,中字mid,小字small,隐藏hidden
└ bottom	string	是	页尾广告：大字big,中字mid,小字small,隐藏hidden
└ is_hidden_price	int	是	隐藏价格：0显示，1隐藏
└ is_hidden_extend	int	是	隐藏规格：0显示，1隐藏
└ is_same_name	int	是	同名合并：0否，1合并
└ is_send_time	int	是	建议送达：0不显示，1显示
└ is_distance	int	是	骑行距离：0不显示，1显示
└ is_buy_price	int	是	显示特价：0显示原价，1显示特价

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

4.5 云打印机分单设置

请求接口：open/setting/print_product

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
print_id	int	是	打印机ID
plat_id	int	是	云昊线上门店ID，1.4获取
plat_pid	int	是	云昊线上门店商品ID
is_closed	int	否	0或不传设置，1关闭设置

API响应结果说明

名称	类型	必传	描述	默认值
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

团购接口

5.1 团购输码查询券

请求接口：open/group/code

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
code	string	是	填写的券码
source	string	否	团购来源，mttg美团，douyin抖音，kuaishou快手，source或plat_id二选一
plat_id	int	否	团购来源id，source或plat_id二选一

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
product	array	是	返回商品信息

5.2 团购扫码查询券

请求接口：open/group/qrcode

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
code	string	是	扫出来的券码
source	string	否	团购来源，mttg美团，douyin抖音，kuaishou快手，source或plat_id二选一
plat_id	int	否	团购来源id，source或plat_id二选一

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
product	array	是	返回商品信息

5.3 团购核销券码

请求接口：open/group/verify

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
codes	array	是	填写的券码，或扫出来的券码（有可能是加密软件）
└ type	string	是	券码类型scan扫码得来，code输入得来
└ code	string	是	券码编号或扫出来的码
source	string	否	团购来源，mttg美团，douyin抖音，kuaishou快手，source或plat_id二选一
plat_id	int	否	团购来源id，source或plat_id二选一
order_id	int	是	请求方的订单编号，方便查询

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
product	array	是	返回商品信息

5.4 取消核销券码

请求接口：open/group/cancel

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
plat_id	int	是	团购来源id
order_id	int	是	请求方的订单编号，核稍时传入

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败

5.5 获取授权的团购平台

请求接口：open/store/group

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
plats	array	是	返回团购平台参数
└ id	string	是	平台id
└ source	string	是	平台类型
└ plat_name	string	是	平台名称
└ full_name	string	是	门店在平台名称

5.6 团购评价

请求接口：open/group/comment_list

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
plat_id	int	否	团购来源id
source	string	否	团购来源，mttg美团，douyin抖音，kuaishou快手，source或plat_id二选一
data	array	是	参数
└ startDate	string	是
└ endDate	string	是
└ limit	string	是
└ offset	string	是

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败

5.7 回复团购评价

请求接口：open/group/comment_reply

API请求参数说明

名称	类型	必传	描述
dev_id	int	是	开发者ID
shop_id	int	是	外卖邦门店ID
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
plat_id	int	是	团购来源id
data	array	是	参数

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败

商品接口

6.1 线上商品更新

请求接口：open/product/refresh

API请求参数说明：24小时内，只能更新自动更新一次

名称	类型	必传	描述
app_id	int	是	开发者ID，从咨询客服获取
open_id	int	是	门店唯一识别码，授权时第三方保存
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
shop_id	int	是	云昊系统对应的门店编号
plat_id	int	是	线上门店ID

API响应结果说明

名称	类型	必传	描述
code	int	是	结果返回编码：0成功，1失败
msg	string	是	结果返回文字说明：OK

四. 配送回调

回调地址

由第三方提供给云昊设置完成

回调参数

回调参数以json的数据格式回传，平台根据实际情况处理

名称	类型	必传	描述
shop_id	int	是	店铺ID
timestamp	int	是	时间戳,单位秒，即unix-timestamp
signature	string	是	签名Hash值，参见：接口签名规则
plat_id	int	是	平台ID
sort	string	是	平台对应别名：meituan美团外卖，elem饿了么，douyin抖音.....
status	string	是	配送状态，参见枚举数据
data	array	是
└ shop_id	string	是	店铺ID
└ third_shop_id	string	是	店铺编号
└ order_no	string	是	订单编号
└ send_id	string	是	配送单编号
└ sender_name	string	是	配送员名字
└ sender_mobile	string	是	配送员电话
└ sort	string	是	配送渠道：sf顺丰，daown达达，ss闪送......
└ base_amount	double	是	配送金额
└ tips_amount	double	是	配送加小费
└ deduct_amount	double	是	取消扣款金额
└ discount_amount	stringdouble	是	配送已优惠金额
└ is_merge_pay	int	是	是否聚合支付扣款，非聚合支付可不需要理会