OPEN PLATFORM

乐悠客开放平台

提供账号、店铺、订单、商品、商品类目、会员与消息推送等 API 接口文档，便于第三方系统快速接入乐悠客业务能力。

Open API Reference Base URL: https://open.leuke.cn/openapi 示例域名已更新为 yun5.leuke.cn

文档说明

本文档为乐悠客开放平台（Leyouke Open Platform）对外开放接口说明，供接入方（商户系统 / 第三方开发者）对接乐悠客收银、商品、订单、会员等能力使用。

Base URL（请替换为正式环境域名）：https://open.leuke.cn/openapi

当前文档示例数据基于测试环境 http://yun5.leuke.cn，上线前请确认正式网关地址与 appkey 分配。

公共请求参数

所有接口（除特别说明外）均需在请求中携带以下公共参数：

参数名类型必填说明
appkeystring是接入方标识（用户 appkey），由乐悠客开放平台分配
signstring是请求签名，生成规则见签名生成规则

响应格式

所有接口统一返回 JSON，结构如下（字段含义：code 响应编码、message 响应消息、data 业务数据）：

{
  "code": 200,
  "message": "成功",
  "data": {}
}

签名生成规则

签名生成规则：签名用于请求接口验证合法性。

签名用于请求接口验证合法性
规则说明：
				把入参（除了签名sign）按照字母的字典排序，以key=value 用 & 拼接起来，然后拼接后的字符串首尾加上secretkey 转小写进行sha加密
例子：
       入参：
			       appkey=sdaqwe1231 , pageNo=1 , pageSize=20 拼接字符串：appkey=sdaqwe1231&pageNo=1&pageSize=20  然后首尾加上secretkey=sdasd123124
			 最终：
				      sign = strtolower(sha1(sdasd123124appkey=sdaqwe1231&pageNo=1&pageSize=20sdasd123124, false))   (PHP例子)

账号

GET /openapi/get-user-info?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8

获取管理员账号信息

（接口说明待补充）

请求参数

Query 参数

参数名类型必填说明示例
appkeystring是用户appkey690915912393536872
signstring是签名（参考签名生成规则文档）8fce40ca5db8c6f99b969790afb51496d179e7e8

请求示例

GET /openapi/get-user-info?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.userobject管理员
data.user.idnumber管理员id6909
data.user.login_idnumber登录账号13575457741
data.user.mobilenumber手机13575457741
data.user.passwordnumber登录密码123477
data.user.Cdatenumber创建时间2019-09-02 16:25:58
data.user.Udatenumber更新时间2020-06-04 10:55:53
data.user.company_namenumber公司名称13575457741店铺
data.user.logoobject公司logohttp://asqweqweqw/asdas.jpg
data.user.if_auto_synchnumber交班前是否需要对现金0
data.user.sms_remainnumber短信余额20
data.user.service_typenumber服务类型：1(初级版，仅限收银)，2（专业版，ERP全开）1
data.user.send_smsnumber是否发送日报表0

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "user": {
      "id": "6909",
      "login_id": "13575457741",
      "mobile": "13575457741",
      "password": "123477",
      "Cdate": "2019-09-02 16:25:58",
      "Udate": "2020-06-04 10:55:53",
      "company_name": "13575457741店铺",
      "logo": "",
      "if_auto_synch": "0",
      "sms_remain": "20",
      "service_type": "1",
      "send_sms": "0"
    }
  }
}

店铺

GET /openapi/get-shop-list?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8

获取账户店铺列表

（接口说明待补充）

请求参数

Query 参数

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名8fce40ca5db8c6f99b969790afb51496d179e7e8
shopidstring否店铺id8554
mobilestring否查询手机号13575457741
startTimestring否店铺创建开始时间2020-09-01 00:00:00
endTimestring否店铺创建结束时间2020-09-09 00:00:00

请求示例

GET /openapi/get-shop-list?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8&shopid=8554&mobile=13575457741&startTime=2020-09-01 00:00:00&endTime=2020-09-09 00:00:00

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.shop_listobject店铺列表
data.shop_list.idnumber店铺id8554
data.shop_list.shop_namenumber店铺名13575457741店铺总店
data.shop_list.longitudenumber店铺位置经度116.423457
data.shop_list.latitudenumber位置纬度39.903052
data.shop_list.addressstring店铺具体位置北京市,北京市,朝阳区,崇文门外大街5-10号
data.shop_list.phonenumber联系人手机号13575457741
data.shop_list.creatednumber创建时间2019-09-02 16:25:58
data.shop_list.usernamenumber登录账户13575457741
data.shop_list.passwordnumber登录密码123477
data.shop_list.sortnumber排序0
data.shop_list.alipay_qr_codeobject支付宝收款二维码图片地址
data.shop_list.wx_qr_codeobject微信收款二维码图片地址
data.shop_list.sendnumber是否发送日报1
data.shop_list.sms_remainnumber短信余额（加盟店短信余额分开）0
data.shop_list.join_typenumber加盟方式：0：直营店 ，1：加盟0
data.shop_list.ratenumber服务费0
data.shop_list.business_nameobject店铺商户名
data.shop_list.business_urlobject营业执照url
data.shop_list.unit_nameobjectunit_name
data.shop_list.legal_personobject法人
data.shop_list.credit_codeobject社会信用代码

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "shop_list": [
      {
        "id": "8554",
        "shop_name": "13575457741店铺总店",
        "longitude": "116.423457",
        "latitude": "39.903052",
        "address": "北京市,北京市,朝阳区,崇文门外大街5-10号",
        "phone": "13575457741",
        "created": "2019-09-02 16:25:58",
        "username": "13575457741",
        "password": "123477",
        "sort": "0",
        "alipay_qr_code": "",
        "wx_qr_code": "",
        "send": "1",
        "sms_remain": "0",
        "join_type": "0",
        "rate": "0",
        "business_name": "",
        "business_url": "",
        "unit_name": "",
        "legal_person": "",
        "credit_code": ""
      }
    ]
  }
}

POST /openapi/add-shop

新增店铺

新增店铺

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeyString是appkey690915912393536872
signString是签名（参考签名生成规则文档）5c93d4ea722a92e3d08fdb2a20ea3904425855e6
shop_nameString是店铺名称北京分店
addressString是店铺地址北京朝阳区紫荆豪庭
phoneString是店铺电话15364879223
usernameString是店铺账号lingcen001
passwordString是店铺密码13216464
sortString否店铺排序2
alipay_qr_codeString否支付宝收款码图片地址http://www.xxxxxxxx.1231.jpg
wx_qr_codeString否微信收款码图片地址http://www.xxxxxxxx.1231.jpg
join_typeString否加盟类型：0：直营，1：加盟，默认：00
rateString否费率0
business_nameString否商户名凌金生
business_urlString否营业执照图片地址http://www.xxxxxxx.321.png
unit_nameString否进货单位折算斤数10
legal_personString否法人凌金生
credit_codeString否营业执社会信用代码asd121515114er
avatarString否商户头像图片地址http://www.xxxxxxx.321.png
stall_noString否摊位号A-422
location_noString否位置2321

请求示例

POST /openapi/add-shop
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "5c93d4ea722a92e3d08fdb2a20ea3904425855e6",
  "shop_name": "北京分店",
  "address": "北京朝阳区紫荆豪庭",
  "phone": "15364879223",
  "username": "lingcen001",
  "password": "13216464",
  "sort": "2",
  "alipay_qr_code": "http://www.xxxxxxxx.1231.jpg",
  "wx_qr_code": "http://www.xxxxxxxx.1231.jpg",
  "join_type": "0",
  "rate": "0",
  "business_name": "凌金生",
  "business_url": "http://www.xxxxxxx.321.png",
  "unit_name": "10",
  "legal_person": "凌金生",
  "credit_code": "asd121515114er",
  "avatar": "http://www.xxxxxxx.321.png",
  "stall_no": "A-422",
  "location_no": "2321"
}

响应参数

字段类型说明示例
codeNumber响应编码200
messageString响应消息说明成功
dataObject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

POST /openapi/up-shop

修改店铺

修改店铺

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）52d049bdb625552f406f2af4d338cce8b1910667
idstring是店铺id16363
shop_namestring是店铺id北京分店1
addressstring是商品名北京朝阳区紫荆豪庭
phonestring是商品售价15364879223
usernamestring是商品库存，默认0lingcen001
passwordstring是商品条码13216464
sortstring否销售单位2
alipay_qr_codestring否支付宝收款码图片地址http://www.xxxxxxxx.1231.jpg
wx_qr_codestring否微信收款码图片地址http://www.xxxxxxxx.1231.jpg
join_typestring否加盟类型：0：直营，1：加盟，默认：00
ratestring否会员价0
business_namestring否商户名凌金生
business_urlstring否营业执照图片地址http://www.xxxxxxx.321.png
unit_namestring否进货单位折算斤数10
legal_personstring否法人凌金生
credit_codestring否营业执社会信用代码asd121515114er
avatarstring否商户头像图片地址http://www.xxxxxxx.321.png
stall_nostring否摊位号A-422
location_nostring否位置2321

请求示例

POST /openapi/up-shop
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "52d049bdb625552f406f2af4d338cce8b1910667",
  "id": "16363",
  "shop_name": "北京分店1",
  "address": "北京朝阳区紫荆豪庭",
  "phone": "15364879223",
  "username": "lingcen001",
  "password": "13216464",
  "sort": "2",
  "alipay_qr_code": "http://www.xxxxxxxx.1231.jpg",
  "wx_qr_code": "http://www.xxxxxxxx.1231.jpg",
  "join_type": "0",
  "rate": "0",
  "business_name": "凌金生",
  "business_url": "http://www.xxxxxxx.321.png",
  "unit_name": "10",
  "legal_person": "凌金生",
  "credit_code": "asd121515114er",
  "avatar": "http://www.xxxxxxx.321.png",
  "stall_no": "A-422",
  "location_no": "2321"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

订单

POST /openapi/add-trade

新增订单

新增订单

请求参数

Body 参数（json）

参数名类型必填说明示例
{appkeystring是690915912393536872,
restaurant_idstring是店铺id8554,
latitudestring是店铺经度12314,
longitudestring是纬度8551254,
signstring是签名（参考签名生成规则文档）fae20655ffa8facc268fc5bf67be490f,
shop_namestring是店铺名'13575457741店铺总店',
statusstring是订单状态 -2(未付款) 0/1(待处理)2/9(已处理)3(已完成)-1(订单取消)-3(支付超时)-4(接单超时)-51,
buyer_namestring是买家名'张三',
buyer_mobilestring是买家手机号'13647497623',
addressstring是买家地址'杭州下城xxxx',
createdstring是创建时间'2020-05-30 00:10:10',
total_pricestring是订单总价105,
paymentstring是订单实付100,
pay_typestring是付款方式 支付宝:1,wx:2,现金:3,pos:4,会员卡:5，现金卡：6，混合支付：7,挂账:8,扫呗:93,
cashstring是实付现金95,
plamt_fromstring是来源平台 ol:线下'ol',
operator_idstring是收银员id1234,
guider_idstring是导购员id1365,
remarkstring是订单备注'老顾客',
discountstring是订单折扣10,
goodsstring是[
{string是{
good_titlestring是'慢慢',
numiidstring是3548729,
numstring是2,
pricestring是52.5,
barcodestring是'131646423',
origin_pricestring是53.5,
}string是}
],string是],
discount_detailstring是[
titlestring是'单品优惠',
valstring是2,
descstring是'单品优惠总额',
]}string是]}

请求示例

POST /openapi/add-trade
Content-Type: application/json

{
  "{appkey": "690915912393536872,",
  "restaurant_id": "8554,",
  "latitude": "12314,",
  "longitude": "8551254,",
  "sign": "fae20655ffa8facc268fc5bf67be490f,",
  "shop_name": "'13575457741店铺总店',",
  "status": "1,",
  "buyer_name": "'张三',",
  "buyer_mobile": "'13647497623',",
  "address": "'杭州下城xxxx',",
  "created": "'2020-05-30 00:10:10',",
  "total_price": "105,",
  "payment": "100,",
  "pay_type": "3,",
  "cash": "95,",
  "plamt_from": "'ol',",
  "operator_id": "1234,",
  "guider_id": "1365,",
  "remark": "'老顾客',",
  "discount": "10,",
  "goods": "[",
  "{": "{",
  "good_title": "'慢慢',",
  "numiid": "3548729,",
  "num": "2,",
  "price": "52.5,",
  "barcode": "'131646423',",
  "origin_price": "53.5,",
  "}": "}",
  "],": "],",
  "discount_detail": "[",
  "title": "'单品优惠',",
  "val": "2,",
  "desc": "'单品优惠总额',",
  "]}": "]}"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.tidnumber成功订单号31316464

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "tid": "31316464"
  }
}

POST /openapi/get-trade-list

获取订单列表

获取线下订单列表

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
pagenostring否页码1
pagesizestring否每页数量20
start_createdstring否订单开始时间2020-06-04 00:00:00
end_createdstring否订单结束时间2020-06-04 23:25:00
statusstring否订单状态 -2(未付款) 0/1(待处理)2/9(已处理)3(已完成)-1(订单取消)-3(支付超时)-4(接单超时)-53
restaurant_idstring否店铺id8554
plamt_fromstring否来源平台 ol:线下ol
signstring是签名（参考签名生成规则文档）96e2e06897b8c245054ed1c84cdbc6a53a8e2edb

请求示例

POST /openapi/get-trade-list
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "pageno": "1",
  "pagesize": "20",
  "start_created": "2020-06-04 00:00:00",
  "end_created": "2020-06-04 23:25:00",
  "status": "3",
  "restaurant_id": "8554",
  "plamt_from": "ol",
  "sign": "96e2e06897b8c245054ed1c84cdbc6a53a8e2edb"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.total_resultsnumber订单总数1
data.tradesobject订单列表
data.trades.tidnumber订单tid690985541591252549429
data.trades.useridnumber总管理员账号id6909
data.trades.openidobject顾客微商城openid
data.trades.original_pricenumber订单原价3.22
data.trades.restaurant_namenumber店铺名13575457741店铺总店
data.trades.refund_idobject退款id,0为没有退款
data.trades.refund_codenumber退款code 0 (未申请退单) 2(用户申请退单) 3(餐厅不同意退单) 4(退单仲裁中) 5(退单失败) 6(退单成功)7(商家同意退款)8（用户取消退款申请）9(退款结束)0
data.trades.status_codenumber订单状态 -2(未付款) 1(待处理)2(已处理)3(已完成)-1(订单取消)-3(支付超时)-4(接单超时)3
data.trades.restaurant_idnumber店铺id8554
data.trades.service_feenumber服务费0.00
data.trades.consigneeobject顾客名
data.trades.is_online_paidnumber是否在线支付1
data.trades.descriptionobject订单卖家备注
data.trades.delivery_geoobject买家经纬度
data.trades.created_atnumber订单创建时间2020-06-04 14:36:17
data.trades.modify_timenumber订单修改时间2020-06-04 14:37:01
data.trades.cashnumber订单现金实付3.22
data.trades.total_pricenumber订单实付3.22
data.trades.addressobject顾客地址
data.trades.phoneobject顾客手机
data.trades.ordersstring订单商品详情[{"numiid":"3548729","good_title":"慢慢","cost":"9.00","origin_price":"3.22","price":"3.22","is_discount":"0","num":"1","unit":"个","total_price":"3.22","payment":"3.22","barcode":"1804251346515","sum":"3.22","card_id":"0","used_time":"0","used_price":"0","is_group":"0"}]
data.trades.plamt_fromstring订单来源 ol:线下，xcx_wsc:小程序微商城ol
data.trades.infoobject顾客留言
data.trades.operatornumber收银员12476
data.trades.guider_idnumber导购员0
data.trades.pay_typenumber付款类型3
data.trades.discountnumber订单折扣0.00
data.trades.discount_detailstring折扣详情[{"title":"单品优惠","val":"0.00","desc":"单品优惠总额"}]

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "total_results": "1",
    "trades": [
      {
        "tid": "690985541591252549429",
        "userid": "6909",
        "openid": "",
        "original_price": "3.22",
        "restaurant_name": "13575457741店铺总店",
        "refund_id": "",
        "refund_code": "0",
        "status_code": "3",
        "restaurant_id": "8554",
        "service_fee": "0.00",
        "consignee": null,
        "is_online_paid": "1",
        "description": "",
        "delivery_geo": "",
        "created_at": "2020-06-04 14:36:17",
        "modify_time": "2020-06-04 14:37:01",
        "cash": "3.22",
        "total_price": "3.22",
        "address": "",
        "phone": null,
        "orders": "[{\"numiid\":\"3548729\",\"good_title\":\"慢慢\",\"cost\":\"9.00\",\"origin_price\":\"3.22\",\"price\":\"3.22\",\"is_discount\":\"0\",\"num\":\"1\",\"unit\":\"个\",\"total_price\":\"3.22\",\"payment\":\"3.22\",\"barcode\":\"1804251346515\",\"sum\":\"3.22\",\"card_id\":\"0\",\"used_time\":\"0\",\"used_price\":\"0\",\"is_group\":\"0\"}]",
        "plamt_from": "ol",
        "info": null,
        "operator": "12476",
        "guider_id": "0",
        "pay_type": "3",
        "discount": "0.00",
        "discount_detail": "[{\"title\":\"单品优惠\",\"val\":\"0.00\",\"desc\":\"单品优惠总额\"}]"
      }
    ]
  }
}

POST /openapi/up-trade

修改订单

修改订单

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）9c964f5bccb9637a84c1ffb9061628931667373e
tidstring是订单号690985541591762635668
restaurant_idstring否店铺id8554
shop_namestring否店铺名13575457741店铺总店
statusstring是订单状态 -2(未付款) 1(待处理)2(已处理)3(已完成)-1(订单取消)-3(支付超时)-4(接单超时)1
buyer_namestring否买家名张三
buyer_mobilestring否买家手机号13647497623
addressstring否买家地址杭州下城中大银泰
remarkstring否订单备注老顾客

请求示例

POST /openapi/up-trade
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "9c964f5bccb9637a84c1ffb9061628931667373e",
  "tid": "690985541591762635668",
  "restaurant_id": "8554",
  "shop_name": "13575457741店铺总店",
  "status": "1",
  "buyer_name": "张三",
  "buyer_mobile": "13647497623",
  "address": "杭州下城中大银泰",
  "remark": "老顾客"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.tidnumber成功订单号31316464

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "tid": "690985541591762635668"
  }
}

POST /openapi/cancel-trade

取消订单

取消订单

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey124316001446223188
signstring是签名（参考签名生成规则文档）86461abe350750d7b00c43ec4c33a9b3890ffbcb
tidstring是订单号1308634725392343040

请求示例

POST /openapi/cancel-trade
Content-Type: application/json

{
  "appkey": "124316001446223188",
  "sign": "86461abe350750d7b00c43ec4c33a9b3890ffbcb",
  "tid": "1308634725392343040"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.tidnumber成功订单号31316464

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "tid": "690985541591762635668"
  }
}

POST /openapi/get-trade-list1

获取订单列表-new

获取线下订单列表

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeyString是appkey690915912393536872
pagenoString否页码1
pagesizeString否每页数量20
start_createdString否订单开始时间2020-06-04 00:00:00
end_createdString否订单结束时间2020-06-04 23:25:00
statusString否订单状态 -2(未付款) 0/1(待处理)2/9(已处理)3(已完成)-1(订单取消)-3(支付超时)-4(接单超时)-53
restaurant_idString否店铺id8554
plamt_fromString否来源平台 ol:线下ol
signString是签名（参考签名生成规则文档）fb7ee88f83adac5f729c6d15abaa8e491947564d

请求示例

POST /openapi/get-trade-list1
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "pageno": "1",
  "pagesize": "20",
  "start_created": "2020-06-04 00:00:00",
  "end_created": "2020-06-04 23:25:00",
  "status": "3",
  "restaurant_id": "8554",
  "plamt_from": "ol",
  "sign": "fb7ee88f83adac5f729c6d15abaa8e491947564d"
}

响应参数

字段类型说明示例
codeNumber响应编码200
messageString响应消息说明成功
dataObject响应具体数据 json格式
data.total_resultsNumber订单总数1
data.tradesObject订单列表
data.trades.tidNumber订单tid690985541591252549429
data.trades.useridNumber总管理员账号id6909
data.trades.openidObject顾客微商城openid
data.trades.original_priceNumber订单原价3.22
data.trades.restaurant_nameNumber店铺名13575457741店铺总店
data.trades.refund_idObject退款id,0为没有退款
data.trades.refund_codeNumber退款code 0 (未申请退单) 2(用户申请退单) 3(餐厅不同意退单) 4(退单仲裁中) 5(退单失败) 6(退单成功)7(商家同意退款)8（用户取消退款申请）9(退款结束)0
data.trades.status_codeNumber订单状态 -2(未付款) 1(待处理)2(已处理)3(已完成)-1(订单取消)-3(支付超时)-4(接单超时)3
data.trades.restaurant_idNumber店铺id8554
data.trades.service_feeNumber服务费0.00
data.trades.consigneeObject顾客名
data.trades.is_online_paidNumber是否在线支付1
data.trades.descriptionObject订单卖家备注
data.trades.delivery_geoObject买家经纬度
data.trades.created_atNumber订单创建时间2020-06-04 14:36:17
data.trades.modify_timeNumber订单修改时间2020-06-04 14:37:01
data.trades.cashNumber订单现金实付3.22
data.trades.total_priceNumber订单实付3.22
data.trades.addressObject顾客地址
data.trades.phoneObject顾客手机
data.trades.ordersString订单商品详情[{"numiid":"3548729","good_title":"慢慢","cost":"9.00","origin_price":"3.22","price":"3.22","is_discount":"0","num":"1","unit":"个","total_price":"3.22","payment":"3.22","barcode":"1804251346515","sum":"3.22","card_id":"0","used_time":"0","used_price":"0","is_group":"0"}]
data.trades.plamt_fromString订单来源 ol:线下，xcx_wsc:小程序微商城ol
data.trades.infoObject顾客留言
data.trades.operatorNumber收银员12476
data.trades.guider_idNumber导购员0
data.trades.pay_typeNumber付款类型3
data.trades.discountNumber订单折扣0.00
data.trades.discount_detailString折扣详情[{"title":"单品优惠","val":"0.00","desc":"单品优惠总额"}]

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "total_results": "1",
    "trades": [
      {
        "tid": "690985541591252549429",
        "userid": "6909",
        "openid": "",
        "original_price": "3.22",
        "restaurant_name": "13575457741店铺总店",
        "refund_id": "",
        "refund_code": "0",
        "status_code": "3",
        "restaurant_id": "8554",
        "service_fee": "0.00",
        "consignee": null,
        "is_online_paid": "1",
        "description": "",
        "delivery_geo": "",
        "created_at": "2020-06-04 14:36:17",
        "modify_time": "2020-06-04 14:37:01",
        "cash": "3.22",
        "total_price": "3.22",
        "address": "",
        "phone": null,
        "orders": "[{\"numiid\":\"3548729\",\"good_title\":\"慢慢\",\"cost\":\"9.00\",\"origin_price\":\"3.22\",\"price\":\"3.22\",\"is_discount\":\"0\",\"num\":\"1\",\"unit\":\"个\",\"total_price\":\"3.22\",\"payment\":\"3.22\",\"barcode\":\"1804251346515\",\"sum\":\"3.22\",\"card_id\":\"0\",\"used_time\":\"0\",\"used_price\":\"0\",\"is_group\":\"0\"}]",
        "plamt_from": "ol",
        "info": null,
        "operator": "12476",
        "guider_id": "0",
        "pay_type": "3",
        "discount": "0.00",
        "discount_detail": "[{\"title\":\"单品优惠\",\"val\":\"0.00\",\"desc\":\"单品优惠总额\"}]"
      }
    ]
  }
}

商品

POST /openapi/add-good

新增商品

新增商品

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）beb06b41e5346e4be3c643554d795fae4a66cdad
shopidstring是店铺id8554
namestring是商品名广西香蕉
sell_pricestring是商品售价15
stockstring是商品库存，默认00
barcodestring是商品条码13216464
sell_unitstring是销售单位个
catelogidstring是商品分类id0
pic_liststring是图片地址
pricestring是商品进价10
vip_pricestring是会员价13
is_vipstring是是否开启会员价1
unitstring是进货单位箱
zhe_jinstring是进货单位折算斤数10
zhe_jin_unitstring是折算单位斤

请求示例

POST /openapi/add-good
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "beb06b41e5346e4be3c643554d795fae4a66cdad",
  "shopid": "8554",
  "name": "广西香蕉",
  "sell_price": "15",
  "stock": "0",
  "barcode": "13216464",
  "sell_unit": "个",
  "catelogid": "0",
  "pic_list": "",
  "price": "10",
  "vip_price": "13",
  "is_vip": "1",
  "unit": "箱",
  "zhe_jin": "10",
  "zhe_jin_unit": "斤"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

POST /openapi/up-good

修改商品

修改商品

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）3462f2a0be685e752ad727f3a89e45e080db0846
shopidstring是店铺id8554
numiidstring是商品numiid6938000
namestring否商品名广西香蕉2
sell_pricestring否商品售价15
stockstring否商品库存，默认00
barcodestring否商品条码13216464
sell_unitstring否销售单位个
catelogidstring否商品分类id0
pic_liststring否图片地址
pricestring否商品进价10
vip_pricestring否会员价13
is_vipstring否是否开启会员价1
unitstring否进货单位箱
zhe_jinstring否进货单位折算斤数10
zhe_jin_unitstring否折算单位斤

请求示例

POST /openapi/up-good
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "3462f2a0be685e752ad727f3a89e45e080db0846",
  "shopid": "8554",
  "numiid": "6938000",
  "name": "广西香蕉2",
  "sell_price": "15",
  "stock": "0",
  "barcode": "13216464",
  "sell_unit": "个",
  "catelogid": "0",
  "pic_list": "",
  "price": "10",
  "vip_price": "13",
  "is_vip": "1",
  "unit": "箱",
  "zhe_jin": "10",
  "zhe_jin_unit": "斤"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

GET /openapi/get-good-list?appkey=690915912393536872&sign=52aafac8d378638746ff2b5af1ffa39d16875368&numiid=6938000&shopid=8554&catelogid=&pageno=1&pagesize=20&numiid=

获取商品列表

获取商品列表

请求参数

Query 参数

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）52aafac8d378638746ff2b5af1ffa39d16875368
numiidstring否商品id6938000
shopidstring否店铺id8554
catelogidstring否商品分类id
pagenostring否页码 默认11
pagesizestring否每页数量 默认4020
numiidstring否商品nuniid数组

请求示例

GET /openapi/get-good-list?appkey=690915912393536872&sign=52aafac8d378638746ff2b5af1ffa39d16875368&numiid=6938000&shopid=8554&catelogid=&pageno=1&pagesize=20&numiid=?appkey=690915912393536872&sign=52aafac8d378638746ff2b5af1ffa39d16875368&numiid=6938000&shopid=8554&catelogid=&pageno=1&pagesize=20&numiid=

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.total_resultsnumber记录总数1
data.goodsobject商品列表
data.goods.numiidnumber商品id6938000
data.goods.useridnumber总账号id6909
data.goods.shopidnumber店铺id8554
data.goods.barcodenumber商品条形码13216464
data.goods.namestring商品名称广西香蕉
data.goods.pricenumber商品进价10.00
data.goods.sell_pricenumber商品售价15.00
data.goods.VIP_pricenumber会员价13.00
data.goods.special_pricenumber特价0.00
data.goods.is_specialnumber是否开启特价0
data.goods.if_VIPnumber是否开启会员价1
data.goods.stocknumber库存0.00
data.goods.sell_unitstring销售单位个
data.goods.unitstring进货单位箱
data.goods.zhe_jinnumber进货单位折算斤数10.00
data.goods.zhe_jin_unitstring折算单位斤
data.goods.pinyin_codestring拼音吗GXXQ;AXXJ;GXXQ;AXXJ
data.goods.catelogidnumber商品分类id0
data.goods.pic_listobject商品图片
data.goods.is_discountnumber商品是否折扣0

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "total_results": "1",
    "goods": [
      {
        "numiid": "6938000",
        "userid": "6909",
        "shopid": "8554",
        "barcode": "13216464",
        "name": "广西香蕉",
        "price": "10.00",
        "sell_price": "15.00",
        "VIP_price": "13.00",
        "special_price": "0.00",
        "is_special": "0",
        "if_VIP": "1",
        "stock": "0.00",
        "sell_unit": "个",
        "unit": "箱",
        "zhe_jin": "10.00",
        "zhe_jin_unit": "斤",
        "pinyin_code": "GXXQ;AXXJ;GXXQ;AXXJ",
        "catelogid": "0",
        "pic_list": "",
        "is_discount": "0"
      }
    ]
  }
}

GET /openapi/count-goods-sales?appkey=690915912393536872&sign=5ad0236f3acef900db8c1fc86ccf5fc46741de4f&shopids=[8554]&startTime=2020-09-02 00:00:00&endTime=2020-09-09 12:00:00

查询商品销量

获取账号下面所有类目

请求参数

Query 参数

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名5ad0236f3acef900db8c1fc86ccf5fc46741de4f
shopidsstring否店铺id数组[8554]
startTimestring否查询开始时间2020-09-02 00:00:00
endTimestring否查询结束时间2020-09-09 12:00:00

请求示例

GET /openapi/count-goods-sales?appkey=690915912393536872&sign=5ad0236f3acef900db8c1fc86ccf5fc46741de4f&shopids=[8554]&startTime=2020-09-02 00:00:00&endTime=2020-09-09 12:00:00?appkey=690915912393536872&sign=5ad0236f3acef900db8c1fc86ccf5fc46741de4f&shopids=[8554]&startTime=2020-09-02 00:00:00&endTime=2020-09-09 12:00:00

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.numiidnumber商品系统id3548665
data.good_titlestring商品标题恐龙蛋
data.pricenumber商品单价29.80
data.numnumber销售数量2.000
data.totalPricenumber销售总额59.60

响应示例

{
  "code": 200,
  "message": "成功",
  "data": [
    {
      "numiid": "3548665",
      "good_title": "恐龙蛋",
      "price": "29.80",
      "num": "2.000",
      "totalPrice": "59.60"
    },
    {
      "numiid": "3548765",
      "good_title": "冬枣",
      "price": "11.00",
      "num": "5.000",
      "totalPrice": "55.00"
    }
  ]
}

POST /openapi/delete-good

删除商品

删除商品

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）e94732c5d884a9cbc76bfec52619ad087a1002f9
shopidstring是店铺id8554
numiidstring是商品numiid3548720

请求示例

POST /openapi/delete-good
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "e94732c5d884a9cbc76bfec52619ad087a1002f9",
  "shopid": "8554",
  "numiid": "3548720"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

商品类目

GET /openapi/get-user-cate?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8&cate_id=178610

获取类目列表

获取账号下面所有类目

请求参数

Query 参数

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名8fce40ca5db8c6f99b969790afb51496d179e7e8
cate_idstring否类目id178610

请求示例

GET /openapi/get-user-cate?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8&cate_id=178610?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8&cate_id=178610

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.catesobject类目列表
data.cates.idnumber类目id178610
data.cates.useridnumber所属账号id6909
data.cates.namestring类目名柑桔柚
data.cates.parentidnumber父类目id0
data.cates.sort_indexnumber类目排序0

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "cates": [
      {
        "id": "178610",
        "userid": "6909",
        "name": "柑桔柚",
        "parentid": "0",
        "sort_index": "0"
      }
    ]
  }
}

POST /openapi/add-user-cate

新建类目

修改分类

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）de623de07805ef251c6a628e0c942dbab96915b9
namestring是类目名杂货
sort_indexstring否类目排序0

请求示例

POST /openapi/add-user-cate
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "de623de07805ef251c6a628e0c942dbab96915b9",
  "name": "杂货",
  "sort_index": "0"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

POST /openapi/up-user-cate

修改分类

修改分类

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）5cd08cfe79ebbc42068285beddcdc5fe1e75995d
namestring是类目名杂货2
cate_idstring是类目排序348734

请求示例

POST /openapi/up-user-cate
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "5cd08cfe79ebbc42068285beddcdc5fe1e75995d",
  "name": "杂货2",
  "cate_id": "348734"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

POST /openapi/delete-user-cate

删除类目

删除类目

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）96419e2bb9e0ee0510018c7f454aa05fd99a7a16
cate_idstring是类目排序348734

请求示例

POST /openapi/delete-user-cate
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "96419e2bb9e0ee0510018c7f454aa05fd99a7a16",
  "cate_id": "348734"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

会员

GET /openapi/get-member-level?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8

获取会员等级

获取会员等级列表

请求参数

Query 参数

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）8fce40ca5db8c6f99b969790afb51496d179e7e8

请求示例

GET /openapi/get-member-level?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8?appkey=690915912393536872&sign=8fce40ca5db8c6f99b969790afb51496d179e7e8

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.levelsobject等级列表
data.levels.idnumber等级id8311
data.levels.useridnumber用户id6909
data.levels.level_namestring等级名高级会员
data.levels.level_discountnumber等级折扣100
data.levels.if_pointnumber是否消费加积分1
data.levels.add_pointnumber消费一元加多少积分2.00
data.levels.if_autonumber是否自动升级0
data.levels.need_pointnumber多少积分自动升级100
data.levels.datetnumber创建时间2020-06-10 15:45:13
data.levels.if_dazhenumber是否打折0
data.levels.defaultnumber是否默认0
data.levels.default_vip_pricenumber是否享受会员价0
data.levels.freightnumber运费0

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "levels": [
      {
        "id": "8311",
        "userid": "6909",
        "level_name": "高级会员",
        "level_discount": "100",
        "if_point": "1",
        "add_point": "2.00",
        "if_auto": "0",
        "need_point": "100",
        "datet": "2020-06-10 15:45:13",
        "if_dazhe": "0",
        "default_vip_price": "0",
        "freight": "0"
      }
    ]
  }
}

POST /openapi/add-member

新增会员

新增会员

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）7e360288ed6354c3d04d512c464cf50c566c6043
shopidstring是店铺id8554
namestring是会员名李四
mobilestring是会员手机号13564979856
sexstring是会员性别1:男，2：女1
addressstring是会员地址杭州下城石祥路12
remarkstring是会员备注备注
member_cardstring是会员卡号136467
passwordstring是会员支付密码36543
ispassstring是会员支付是否需要输入密码1

请求示例

POST /openapi/add-member
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "7e360288ed6354c3d04d512c464cf50c566c6043",
  "shopid": "8554",
  "name": "李四",
  "mobile": "13564979856",
  "sex": "1",
  "address": "杭州下城石祥路12",
  "remark": "备注",
  "member_card": "136467",
  "password": "36543",
  "ispass": "1"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

POST /openapi/update-member

修改会员信息

新增会员

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）7e360288ed6354c3d04d512c464cf50c566c6043
idstring是会员id（id和手机号必须要传一个）2285465
mobilestring是会员手机号13564979856
shopidstring否店铺id8554
namestring否会员名李四
sexstring否会员性别1:男，2：女1
addressstring否会员地址杭州下城石祥路12
remarkstring否会员备注备注
member_cardstring否会员卡号136467
passwordstring否会员支付密码36543
ispassstring否会员支付是否需要输入密码1

请求示例

POST /openapi/update-member
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "7e360288ed6354c3d04d512c464cf50c566c6043",
  "id": "2285465",
  "mobile": "13564979856",
  "shopid": "8554",
  "name": "李四",
  "sex": "1",
  "address": "杭州下城石祥路12",
  "remark": "备注",
  "member_card": "136467",
  "password": "36543",
  "ispass": "1"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

GET /openapi/get-member-info?appkey=690915912393536872&sign=38bf1cf2d8c7d4cb1228bb49dd95c92928629ead&shopid=8554&id=2285465&mobile=13564979856

获取会员信息

获取单个会员信息

请求参数

Query 参数

参数名类型必填说明示例
appkeyString是appkey690915912393536872
signString是签名（参考签名生成规则文档）38bf1cf2d8c7d4cb1228bb49dd95c92928629ead
shopidString是店铺id8554
idString否会员id（id和手机号姓名必须要传一个）2285465
mobileString否会员手机号13564979856
nameString否会员名李四

Body 参数（urlencoded）

参数名类型必填说明示例
appkeyString是appkey690915912393536872
signString是签名（参考签名生成规则文档）b8f436c785667a7f7d4931b651766b7565f4d8d8
idString是会员id（id和手机号姓名必须要传一个）2285465
mobileString是会员手机号13564979856
shopidString否店铺id8554
nameString否会员名李四

请求示例

GET /openapi/get-member-info?appkey=690915912393536872&sign=38bf1cf2d8c7d4cb1228bb49dd95c92928629ead&shopid=8554&id=2285465&mobile=13564979856?appkey=690915912393536872&sign=38bf1cf2d8c7d4cb1228bb49dd95c92928629ead&shopid=8554&id=2285465&mobile=13564979856&name=李四

响应参数

（响应结构见下方示例）

响应示例

POST /openapi/member-recharge

会员充值

会员充值

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）d666109333f8e1fd3d0c6efbb49ba3c6a8f7a658
member_idstring是会员id 和 手机号 必填一个1321644
mobilestring是会员手机号13575457741
sumstring是充值总额=free_bal+real_bal10
free_balstring是赠送金额0
real_balstring是实付额10
balancestring是充值后余额500

请求示例

POST /openapi/member-recharge
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "d666109333f8e1fd3d0c6efbb49ba3c6a8f7a658",
  "member_id": "1321644",
  "mobile": "13575457741",
  "sum": "10",
  "free_bal": "0",
  "real_bal": "10",
  "balance": "500"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

POST /openapi/up-member-level

修改会员等级

修改会员等级

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）a52599be6096160f156ca720a259837e4c9cc32a
idstring是等级id8311
level_namestring是等级名高级会员2
level_discountstring是级等折扣 100是10折100
if_pointstring是否是积分 0：否，1：是1
add_pointstring是费消1元得到的积分1
if_dazhestring是是否自动打折 0：否，1：是1
freightstring是会员运费

请求示例

POST /openapi/up-member-level
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "a52599be6096160f156ca720a259837e4c9cc32a",
  "id": "8311",
  "level_name": "高级会员2",
  "level_discount": "100",
  "if_point": "1",
  "add_point": "1",
  "if_dazhe": "1",
  "freight": ""
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

GET /openapi/get-member-list?appkey=690915912393536872&sign=1954233393fac49d54b78099f285d8cf8a732fbd&shopid=8554&pageno=1&pagesize=20&mobile=13564979856&name=李四

获取会员列表

获取会员列表

请求参数

Query 参数

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）1954233393fac49d54b78099f285d8cf8a732fbd
shopidstring否店铺id8554
pagenostring否页码 1 开始，默认11
pagesizestring否每页条数，默认40条每页20
mobilestring否搜索手机号13564979856
namestring否搜索会员名李四

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名（参考签名生成规则文档）7e360288ed6354c3d04d512c464cf50c566c6043
idstring是会员id（id和手机号必须要传一个）2285465
mobilestring是会员手机号13564979856
shopidstring否店铺id8554
namestring否会员名李四
sexstring否会员性别1:男，2：女1
addressstring否会员地址杭州下城石祥路12
remarkstring否会员备注备注
member_cardstring否会员卡号136467
passwordstring否会员支付密码36543
ispassstring否会员支付是否需要输入密码1

请求示例

GET /openapi/get-member-list?appkey=690915912393536872&sign=1954233393fac49d54b78099f285d8cf8a732fbd&shopid=8554&pageno=1&pagesize=20&mobile=13564979856&name=李四?appkey=690915912393536872&sign=1954233393fac49d54b78099f285d8cf8a732fbd&shopid=8554&pageno=1&pagesize=20&mobile=13564979856&name=李四

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式
data.total_resultsnumber记录总数1
data.membersobject会员列表数组
data.members.idnumber会员id2285465
data.members.useridnumber账号id6909
data.members.shop_idnumber店铺id8554
data.members.openidobject微商城openid
data.members.namestring会员名李四
data.members.join_timenumber会员创建时间戳1591776005
data.members.mobilenumber手机号13564979856
data.members.sexnumber性别 1：男，2：女1
data.members.addressstring地址杭州下城石祥路12
data.members.longitudeobject地址经纬度
data.members.last_timenumber最近消费时间0
data.members.trade_numnumber消费次数0
data.members.trade_paynumber消费总额0.00
data.members.from_platformobject来源平台
data.members.balnumber会员余额0.00
data.members.pointnumber会员积分0.00
data.members.discountnumber会员折扣100
data.members.client_flagsobject会员标签
data.members.refund_numnumber退款次数0
data.members.remarkstring会员备注备注
data.members.member_cardnumber会员卡号136467
data.members.birthdayobject生日
data.members.passwordnumber支付密码36543
data.members.ispassnumber支付是否需要支付密码1
data.members.level_idnumber会员等级0
data.members.xcx_openidobject小程序openid
data.members.pic_urlobject会员头像url
data.members.agenumber会员年龄0

响应示例

{
  "code": 200,
  "message": "成功",
  "data": {
    "total_results": "1",
    "members": [
      {
        "id": "2285465",
        "userid": "6909",
        "shop_id": "8554",
        "openid": null,
        "name": "李四",
        "join_time": "1591776005",
        "mobile": "13564979856",
        "sex": "1",
        "address": "杭州下城石祥路12",
        "longitude": null,
        "last_time": "0",
        "trade_num": "0",
        "trade_pay": "0.00",
        "from_platform": null,
        "bal": "0.00",
        "point": "0.00",
        "discount": "100",
        "client_flags": "",
        "refund_num": "0",
        "remark": "备注",
        "member_card": "136467",
        "birthday": null,
        "password": "36543",
        "ispass": "1",
        "level_id": "0",
        "xcx_openid": null,
        "pic_url": "",
        "age": "0"
      }
    ]
  }
}

消息推送

POST /openapi/up-msg-url

更新需要推送消息的url

更新需要推送消息的url

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeystring是appkey690915912393536872
signstring是签名95b639e4c27d0d5361397dc4496114524098b327
msgurlstring是消息需要推送到的urlhttp://yun5.leuke.cn/msg/handle-msg

请求示例

POST /openapi/up-msg-url
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "95b639e4c27d0d5361397dc4496114524098b327",
  "msgurl": "http://yun5.leuke.cn/msg/handle-msg"
}

响应参数

字段类型说明示例
codenumber响应编码200
messagestring响应消息说明成功
dataobject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}

农贸发送公告消息

POST /openapi/send-notice

农贸发送公告消息

更新需要推送消息的url

请求参数

Body 参数（urlencoded）

参数名类型必填说明示例
appkeyString是appkey690915912393536872
signString是签名4bfe0019003a91f55fdc67039e54debd483ad6cd
contentString是消息内容欢迎光临象山中心菜场;本市场一贯秉持公平、公正、公开的原则;为了您和他人的健康，请戴口罩入场，谢谢您的配合;祝您购物愉快！

请求示例

POST /openapi/send-notice
Content-Type: application/json

{
  "appkey": "690915912393536872",
  "sign": "4bfe0019003a91f55fdc67039e54debd483ad6cd",
  "content": "欢迎光临象山中心菜场;本市场一贯秉持公平、公正、公开的原则;为了您和他人的健康，请戴口罩入场，谢谢您的配合;祝您购物愉快！"
}

响应参数

字段类型说明示例
codeNumber响应编码200
messageString响应消息说明成功
dataObject响应具体数据 json格式{}

响应示例

{
  "code": 200,
  "message": "成功",
  "data": []
}
本文档由乐悠客开放平台自动整理生成 · 接口最终解释权归杭州乐优客科技有限公司所有