雅座OpenAPI

0 开放平台介绍

雅座开放平台（简称OpenAPI）是基于OAuth2.0的认证授权开放体系，针对用户需求，为用户提供的数据分享对接平台。以此，用户可以通过开放平台建立与第三方系统的快速集成，如收银对接、预定等位、POS或自助点餐、自建网站等。

基本职能

雅座开放平台是“会员数据共享”理念实践的重要基础设施，由理念成为现实的资源整合与运营管理后台，承载着对接并服务于第三方服务厂商、用户信息平台、数据资源整合者等的基本职能。推动会员数据在餐饮行业发挥更大价值，为企业用户创造完整的数据链路。在经用户授权通过的前提下，对外共享CRM核心价值数据，包括会员信息、卡信息、积分、储值、优惠券、交易流水；整合第三方点餐订单、菜品数据，为用户提供全面的数据分析增值服务。
价值与意义

客户通过雅座开放平台，可以整合原有预定系统、排队系统、收银系统、外卖平台、网上商城等，扩大会员来源渠道，纳入雅座CRM管理体系，为会员提供预订、等位、点餐、结账、积分兑换全方位的精细化运营服务，精准分析顾客消费行为、喜好及门店经营状况，提高顾客综合满意度，为餐饮品牌客户提高核心竞争力。
技术原理

雅座开放平台完全基于OAuth2.0开放授权协议，提供第三方登录页面（类似QQ、微信的第三方登录）和登录接口，用户登陆后获取Token调用业务接口进行数据交换。所有接口均采用HTTPS网络通讯协议，为用户提供基于身份认证的、更为安全的网络数据传输。

1 快速开始

1.1 接口中的请求参数说明

HTTP/POST，所有数据整体打包成 JSON 格式传输，且字符编码为 UTF-8 （暂不考虑加密，如需后续可扩展），数据结构如下，ciphertext 字段为数据字段，其他字段为协议字段

{
    "timestamp": 1429704178,
    "version": 1,
    "access_token" : "8ddee38fd03446c59ff8c8f15bd2ff37",
    "ciphertext" : {

    }
}

注：下一节 OAuth授权接口使用POST application/x-www-form-urlencoded提交数据

1.2 返回参数格式说明

调用方需判断http的响应码：

200表调用成功
500，502表系统内部错误，可稍后再试
401表未授权
403表禁止访问通常以Json格式返回，返回格式如下：

POST请求或GET请求

当http响应200时，接口返回的数据格式如下

{"code": 错误码, "message": "success", "data":""}

注：更多错误码参看附录错误码列表

1.3 授权机制

雅座开放接口的调用，都是需要获取用户身份认证的。目前开放平台用户身份鉴权主要采用的是OAuth2.0。

OAuth2.0概述

关于OAuth2.0协议的授权流程可以参考下面的流程图，其中Client指第三方应用，Resource Owner指用户，Authorization Server是我们的授权服务器，Resource Server是API服务器。

开发者可以先浏览OAuth2.0的接口文档，熟悉OAuth2.0的接口及参数的含义，不同应用场景各自如何使用OAuth2.0请阅读OAuth授权接口。

1.4 收银系统对接流程

1.5 智能点餐对接流程

2 OAuth授权接口

第三方开发者可以使用AppID和AppSecret调用本接口来获取access_token，相关信息由雅座技术在接口对接时提供。

access_token是雅座OpenAPI的全局唯一票据，第三方开发者调用各接口时都需使用access_token。access_token的存储至少要保留512个字符空间。access_token的有效期目前为2个小时，需定时刷新，重复获取将导致上次获取的access_token失效。

2.1 PASSWORD授权模式

此方式推荐传统收银公司使用，在收银员签到时实现用户登录功能，登录成功后保存对应信息用于后续接口操作

2.1.1 根据用户名密码获取token

请求参数

功能描述	使用使用雅座收银员账号基于PASSWORD模式获取令牌
正式环境地址	https://openapi.yazuo.com/oauth/token
method	POST
Content_Type	application/x-www-form-urlencoded
返回值	JSON

参数说明

参数名	类型	是否必填	描述
client_id	String(64)	是	第三方开发者APPID
client_secret	String(64)	是	第三方开发者密钥
grant_type	String(64)	是	校验模式，现支持password
scope	String(64)	是	权限范围
username	String(64)	是	商户用户名
password	String(64)	是	商户密码

返回值说明

参数名	类型	是否必填	描述
access_token	String(64)	是	接口访问凭证
expires_in	Integer	是	有效期时间（秒）
refresh_token	String(64)	是	使用此令牌到期强制刷新token
brand_id	Integer	是	对应雅座商家ID
merchant_id	Integer	是	对应雅座门店ID
merchant_no	String	是	对应雅座门店编号
terminal_no	String	是	对应操作终端号

2.2 授权码授权模式

此方式推荐第三方WEB应用使用，建议提前联系雅座技术对接门店关系导入及配置回调地址

2.2.1 关联第三方门店并获取授权码

请求参数

功能描述	请求获取对接雅座门店授权成功返回授权码
正式环境地址	https://openapi.yazuo.com/oauth/authorize
method	POST
Content_Type	application/x-www-form-urlencoded
返回值	JSON

参数说明

参数名	类型	是否必填	描述
client_id	String(64)	是	第三方开发者APPID
client_secret	String(64)	是	第三方开发者密钥
response_type	String(64)	是	校验模式，固定值code
scope	String(64)	是	权限范围
thirdparty_merchant_no	String(64)	是	接入系统商家编号
thirdparty_store_no	String(64)	是	接入系统门店编号
thirdparty_merchant_name	String(64)	是	接口系统商家名称
thirdparty_store_name	String(64)	是	接口系统门店名称

返回值说明

如雅座授权通过后会导向客户端事先指定的"重定向URI"（redirection URI），同时附上一个授权码等参数信息，具体参数如下：

参数名	类型	是否必填	描述
code	String(64)	是	授权码
merchant_id	Integer	是	雅座门店ID
brand_id	Integer	是	雅座集团ID
thirdparty_merchant_no	String	是	接入系统商家编号
thirdparty_store_no	String	是	接入系统门店编号

2.2.2 使用授权码换取访问凭证

请求参数

功能描述	使用授权码换取访问令牌
正式环境地址	https://openapi.yazuo.com/oauth/token
method	POST
Content_Type	application/x-www-form-urlencoded
返回值	JSON

参数说明

参数名	类型	是否必填	描述
client_id	String(64)	是	第三方开发者APPID
client_secret	String(64)	是	第三方开发者密钥
grant_type	String(64)	是	校验模式，此处固定传值authorization_code
scope	String(64)	是	权限范围
code	String(64)	是	上一步返回的授权码
redirect_uri	String(64)	是	此URL必须与系统设置的授权回调地址一致

返回值说明

参数名	类型	是否必填	描述
access_token	String(64)	是	接口访问凭证
expires_in	Integer	是	有效期时间（秒）
refresh_token	String(64)	是	使用此令牌到期强制刷新token
brand_id	Integer	是	对应雅座商家ID
merchant_id	Integer	是	对应雅座门店ID
merchant_no	String	是	对应雅座门店编号
terminal_no	String	是	对应操作终端号

2.3 刷新接口访问凭证

请求参数

功能描述	使用Refresh_Token刷新token有效期
正式环境地址	https://openapi.yazuo.com/oauth/token
method	POST
Content_Type	application/x-www-form-urlencoded
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
client_id	String(64)	是	第三方开发者APPID
client_secret	String(64)	是	第三方开发者密钥
grant_type	String(64)	是	校验模式，固定传值refresh_token
refresh_token	String(64)	是	获取access_token接口后返回项中的refresh_token取值

返回值说明

参数名	类型	是否必填	描述
access_token	String(64)	是	接口访问凭证
expires_in	Integer	是	有效期时间（秒）
refresh_token	String(64)	是	使用此令牌到期强制刷新token

3 菜品管理

3.1 创建菜品分类

请求参数

功能描述	用于第三方单条同步菜品分类信息
正式环境地址	https://openapi.yazuo.com/dishes/syncDishCategory
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
categoryId	String(64)	是	第三方分类ID
categoryName	String(64)	是	第三方分类名称
categoryCode	String(64)	否	分类编号
parentId	String	是	所属父级分类ID，顶级默认为0
categorySort	Integer	是	分类展示顺序，按数字大小排序
thirdpartyMerchantNo	String	否	第三方商户编号，（对接的三方需要提前将该值告诉雅座开发人员）
merchantId	Integer	否	雅座商户ID（和thirdpartyMerchantNo至少要有设置一项）
status	Integer	是	菜品状态 1-正常 2-作废

参数请求示例

{
    "access_token": "${access_token}",
    "ciphertext": {
        "categoryId": "100000000001",
        "categoryName": "凉菜",
        "parentId": "0",
        "categorySort": "100",
        "thirdpartyMerchantNo": "MD000001",
        "status": 1
    }
}

返回结果示例

{
   "message": "添加成功",
   "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

3.2 查询菜品分类

请求参数

功能描述	查询商户下已同步的菜品分类
正式环境地址	https://openapi.yazuo.com/dishes/queryBrandDishCategory
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brand_id	Integer	是	雅座商户ID

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}"
  }
}

返回结果示例

{
  "message": "查询成功",
  "code": 0,
  "data": {
    "total": "10",
    "categories": [
      {
        "id": "1",
        "catetoryId": "1",
        "catetoryName": "凉菜",
        "catetoryCode": "A01",
        "parentId": "0",
        "categorySort": 100
      },
      ...
    ]
  }
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	Json	否	正常返回具体数据

data属性说明

参数名	类型	是否必填	描述
categories	JOSNObject	是	返回Categorty对象列表
total	long	是	总页数

Categorty对象说明

参数名	类型	是否必填	描述
id	Integer	是	雅座分类ID
categoryId	String(64)	是	第三方分类ID
categoryName	String(64)	是	第三方分类名称
categoryCode	String(64)	否	分类编号
parentId	String	是	所属父级分类ID，顶级默认为0
categorySort	Integer	是	分类展示顺序，按数字大小排序
thirdpartyMerchantNo	String	是	第三方商户编号
merchantId	Integer	是	对应雅座商户ID
status	Integer	是	菜品状态 1-正常 2-作废

3.3 单条菜品同步

请求参数

功能描述	同步一条菜品信息，如菜品编号存在则更新
正式环境地址	https://openapi.yazuo.com/dishes/syncThirdpartyDish
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述	示例
dishCode	String(64)	是	第三方菜品编号，保证唯一	A000001
dishName	String(64)	是	菜品名称	鱼香肉丝
dishMainCode	String(64)	是	主菜品ID，能够标识是同一商家一菜品，一般对应商户菜品SKU（此ID用来关联菜品券）	A000001
sellPrice	Float(10,2)	是	菜品售价，单位元	20.00
vipPrice	Float(12,2)	是	会员售价	18.00
theoMargin	Float(12,2)	否	理论毛利	0.1
theoCost	Float(12,2)	否	理论成本	15.00
dishPic	String(512)	否	菜品图片URL
description	String(1024)	否	菜品描述
typeId	String(64)	是	菜品类型ID
typeName	String(64)	是	菜品类型名称
unit	String(16)	是	菜品单位
thirdpartyStoreNo	String(64)	是	第三方门店ID
merchantId	Integer	否	雅座商户ID（和thirdpartyMerchantNo至少要有设置一项）	15
isCombo	Boolean	是	是否套餐	false
isNew	Boolean	否	是否新品	false
isRecommend	Boolean	否	是否推荐	false
recommendLevel	Integer	否	推荐星级	5
sort	Integer	否	菜品排序	1
heat	String(32)	否	热量，菜品卡路里程度	中
ingredients	String(32)	否	材料，主要食材	猪肉、胡萝卜
spicy	String(32)	否	辣度	微辣
flavor	String(32)	否	口味	鱼香味
cuisine	String(32)	否	菜系	川菜
dishList	JSONArray	否	套餐菜品明细	[{"dishesId":"A0001","sellPrice":20.00,"quantity":1}]
dishTagList	JSONArray	否	菜品的标签 1:String TagId 2:String tagName 名称 3: String TagType 1份量 2做法	[{"tagId":1,"tagName":"微辣","tagType":"spicy"},{"tagId":2,"tagName":"川菜","tagType":"cuisine"}]
status	Integer	是	菜品状态 1-正常 2-作废	1

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "dishCode": "A00008",
    "dishName": "宫保鸡丁",
    "dishMainCode": "A00008",
    "sellPrice": "22",
    "vipPrice": "20",
    "theoMargin": "5",
    "theoCost": "15",
    "dishPic": "http://z.url/j.jpg",
    "description": "家常菜",
    "typeId": "11",
    "typeName": "家常菜",
    "unit": "盘",
    "thirdpartyStoreNo": "MD000001",
    "isCombo": "false",
    "isNew": "false",
    "isRecommend": "false",
    "recommendLevel": "1",
    "sort": "1",
    "heat": "100卡",
    "ingredients": "猪肉、胡萝卜",
    "spicy": "微辣",
    "flavor": "鱼香味",
    "cuisine": "川菜",
    "dishList": null,
    "dishTagList": [
      {
        "tagId": 1,
        "tagName": "微辣",
        "tagTypeId": "spicy"
      },
      {
        "tagId": 2,
        "tagName": "川菜",
        "tagTypeId": "cuisine"
      }
    ],
    "status": 1
  }
}

返回结果示例

{
  "message": "查询成功",
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

3.4 批量菜品同步

请求参数

功能描述	批量同步菜品信息
正式环境地址	https://openapi.yazuo.com/dishes/batchSyncThirdpartyDish
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
dishesList	JSONArray	是	菜品明细列表,单项参数参看单条添加菜品接口

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "dishesList": [
      {
        "dishCode": "A00008",
        "dishName": "宫保鸡丁",
        "dishMainCode": "A00008",
        "sellPrice": "22",
        "vipPrice": "20",
        "theoMargin": "5",
        "theoCost": "15",
        "dishPic": "http://z.url/j.jpg",
        "description": "家常菜",
        "typeId": "11",
        "typeName": "家常菜",
        "unit": "盘",
        "thirdpartyStoreNo": "MD000001",
        "isCombo": "false",
        "isNew": "false",
        "isRecommend": "false",
        "recommendLevel": "1",
        "sort": "1",
        "heat": "100卡",
        "ingredients": "猪肉、胡萝卜",
        "spicy": "微辣",
        "flavor": "鱼香味",
        "cuisine": "川菜",
        "dishList": null,
        "dishTagList": [
          {
            "tagId": 1,
            "tagName": "微辣",
            "tagTypeId": "spicy"
          },
          {
            "tagId": 2,
            "tagName": "川菜",
            "tagTypeId": "cuisine"
          }
        ],
        "status": 1
      }
    ]
  }
}

返回结果示例

{
  "message": "查询成功",
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

4 商户管理

4.1 获取雅座商户信息

请求参数

功能描述	根据第三方门店编号获取雅座商户信息
正式环境地址	https://openapi.yazuo.com/merchant/queryMerchantsByThirdpartyMerchantNo
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
thirdPartyMerchantNo	String	是	第三方商户编号（需上线前联系雅座技术进行门店关系映射）

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "thirdPartyMerchantNo": "MD000000001"
  }
}

返回结果示例

{
    "code": 0,
    "message": "获取商户成功",
    "data": {
        "rules": {
            "isExchangeIntegral": "true",
            "integralRate": 1
        },
        "list": [
            {
                "merchantId": 16456,
                "merchantName": "雅座在线测试商户992",
                "brand": "雅座在线",
                "merchantNo": "222222222222222",
                "status": 1,
                "brandId": 15,
                "type": 3,
                "parent": 15,
                "thirdpartyMerchantNo": "1111111"
            }
        ],
        "pageSize": 2,
        "currentPage": 1,
        "total": 10
    }
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JSONObject	否	返回的业务信息

data（嵌套）属性

参数名	类型	是否必填	描述
rules	JSONObject	是	商户相关全局规则设置
list	JOSNObject	是	返回Merchant对象列表

Rules（嵌套）属性

参数名	类型	是否必填	描述
isExchangeIntegral	Boolean	是	商户是否容许积分抵现
integralRate	Float	是	积分抵现比例（0至1的小数）

Merchant（嵌套）属性

参数名	类型	是否必填	描述
merchantId	Integer	是	雅座商户Id
merchantName	String	是	商户名称
merchantNo	String	是	雅座商户编号
parent	Integer	是	父级商户Id
brand	String	是	商户品牌名称
status	Integer	是	状态（1-正常 2-作废 3-闭店）
type	Integer	是	类型（1-集团 2-域 3-门店）
thirdpartyMerchantNo	String	是	关联的第三方商户编号

4.2 查询商户卡类型

请求参数

功能描述	查询商户下全部卡类型
正式环境地址	https://openapi.yazuo.com/card/queryCardtype
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}"
  }
}

返回结果示例

{
  "message": "查询卡类型成功",
  "data": {
    "list": [
      {
        "id": 1397,
        "merchantId": 15,
        "cardtype": "测试卡",
        "description": "测试卡",
        "status": 1,
        "price": 0,
        "isTradePassword": true,
        "isSimplePassword": true
      }
    ],
    "total": 1
  },
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	会员对象

data（嵌套）属性

参数名	类型	可为空	描述
list	JOSNObject	是	返回CardType对象列表
total	Integer	是	总记录数

Cardtype对象属性说明

参数名	类型	是否必填	描述
id	Integer	是	卡类型ID
merchantId	Integer	是	所属商户ID
cardtype	String	是	卡类型名称
description	String	是	卡类型描述
status	Integer	是	卡显示状态 0：正常显示，1：处于隐藏状态
price	Float(10,2)	否	卡售价
isTradePassword	Boolean	是	是否需要交易密码
isSimplePassword	Boolean	否	是否容许简单密码
icon	String	否	卡样图片

4.3.1 获取门店奖励规则

请求参数

功能描述	根据当前授权门店获取门店奖励规则
正式环境地址	https://openapi.yazuo.com/merchant/queryAwardRuleByMerchantId
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
merchantId	Integer	是	当前授权雅座门店ID
transCode	String(16)	否	交易类型（1：现金消费 2：储值充值 3：储值消费默认全选，逗号分隔）
brandId	Integer	是	雅座集团ID

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "merchantId": "${merchantId}",
    "transCode": "3",
    "brandId": "${brandId}"
  }
}

返回结果示例

{
    "code": 0,
    "message": "获取门店奖励规则成功",
    "data": {
        "pageSize": 2,
        "currentPage": 1,
        "total": 2,
        "list": [
            {
                "id": 180004528,
                "lowerLimit": 3.3,
                "upperLimit": 4.3,
                "awardAmount": 4,
                "transCode": "2002",
                "couponTypeId": null,
                "cardtypeId": null,
                "awardType": 1,
                "awardAmountType": 1,
                "birthdayDoubleFlag": 0,
                "birthmonthDoubleFlag": 0,
                "birthweekDoubleFlag": 0,
                "payWay": null,
                "membershipLevel": null,
                "firstDoubleFlag": null,
                "membershipType": null,
                "benefitsId": null,
                "crowdId": null,
                "userWeekList": [
                    3,
                    4,
                    6,
                    7
                ]
            }
        ]
    }
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
list	JOSNObject	是	返回AwardRule对象列表
total	long	是	总记录数

AwardRule对象描述

参数名	类型	是否必填	描述
id	Integer	是	规则ID
lowerLimit	Float(10,2)	是	规则范围（下限）
upperLimit	Float(10,2)	是	规则范围（上限）
awardAmount	Float(10,2)	否	奖励额度
transCode	String	是	适用交易类型
couponTypeId	Integer	否	适用券模板ID
cardtypeId	Integer	否	适用卡类型ID
awardType	Short	是	奖励类型（1：积分奖励 2：储值奖励 3：券奖励）
awardAmountType	Short	否	奖励类型（1：金额类型 2：比率类型）
birthdayDoubleFlag	Short	否	生日当天双倍（0：否 1：是）
birthmonthDoubleFlag	Short	否	生日当月双倍（0：否 1：是）
birthweekDoubleFlag	Short	否	生日当周双倍（0：否 1：是）
payWay	String	否	支付方式：具体值参考支付方式列表
membershipLevel	String	否	适用会员等级ID
firstDoubleFlag	Short	否	首次交易双倍
membershipType	Short	否	不适用会员身份（1：粉丝会员 2：支付会员 3：认证会员）
benefitsId	Integer	否	权益ID
crowdId	Integer	否	标签人群ID
userWeekList	List	否	适用周

4.3.2 获取门店限制规则

请求参数

功能描述	预咨询门店限制规则（门店-域-集团顺序）
正式环境地址	https://openapi.yazuo.com/rule/queryRuleInfos
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
merchantId	String	是	门店id

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
mutexRuleExtends	JOSNObject	是	返回权益互斥
couponConsumeOpenDTO	JOSNObject	是	返回优惠券互斥

mutexRuleExtends属性

参数名	类型	是否必填	描述
extendRuleCode	String	是	消费类型\|券类型
extendRuleCodeMutexCode	String	是	互斥的消费类型或券类型（以，隔开）
extendRuleCodeMutexCode	String	是	1 为消费类型 2 为券类型
merchantId	Integer	是	门店id

couponConsumeOpenDTO属性

参数名	类型	是否必填	描述
couponConsumeOpen	JOSNObject	是	单笔支付使用优惠券数量上限
couponConsumeOpenChilds	JOSNObject	是	单笔支付各类优惠券使用数量限制

couponConsumeOpen属性

参数名	类型	是否必填	描述
merchantId	String	是	门店id
enableFlag	Boolean	是	是否有限制
upperLimit	Integer	是	单笔限制张数
useAloneFlag	Boolean	是	是否允许单独使用优惠券

couponConsumeOpenChilds属性

参数名	类型	是否必填	描述
enableFlag	Integer	是	是否有限制
upperLimit	String	是	限制数量
extendRuleCode	Integer	是	券类型id

4.3.3 获取门店储值和券奖励规则接口

请求参数

功能描述	获取门店储值和券奖励规则
正式环境地址	https://openapi.yazuo.com/merchant/getAwardRule
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
merchantId	String	是	门店ID

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
merchantId	Integer	是	门店Id（商户Id）
lowerLimit	BigDecimal	是	规则范围（下限）
upperLimit	BigDecimal	否	规则范围（上限）
awardType	Short	否	奖励类型（ 2：储值奖励 3：券奖励）
awardAmountType	Short	否	奖励储值形式(1：金额类型 2：比率类型)
awardAmount	BigDecimal	否	奖励额度(储值、券)
scope	Integer	否	范围1：本店可用 2：本连锁可用 3：部分店可用 4：仅限发卡门店使用
activeId	Integer	否	活动id
activeName	String	否	活动名称
activeTypeName	String	否	活动类型
cardtypeId	List	否	卡类型id
begin	Date	否	开始时间
end	Date	否	结束时间
couponId	Integer	否	券模板id
couponCount	Integer	否	券数量
couponName	String	否	券名称
couponDesc	String	否	券描述
awardExecType	String	否	送券1：及时执行，2：次日执行
rules	Integer	否	活动规则
systemId	Integer	否
batchNo	Integer	否	批次号
categoryId	Short	否	券类型
ruleId	Integer	否	规则id

4.3.4 获取积分限制规则

请求参数

功能描述	查询门店限制规则
正式环境地址	https://openapi.yazuo.com/card/queryTradeLimitRule
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
merchantId	String	是	门店ID

参数请求示例

                    
                        {
                            "access_token": "${access_token}",
                            "ciphertext": {
                            "brandId": "${brandId}",
                            "merchantId": "${merchantId}",
                            "merchantNo": "666660000277610"
                            }
                        }

返回结果示例

                    
                        {
                            "code": 0,
                            "message": "获取积分限制
                            规则成功",
                            "data": {
                                "integralAsCash": true,
                                "integralExchangeRate": 1,
                                "integralPercentLimit": 6,
                                "integralUpperLimit"": 5,
                                "integralDivisible": false,
                                "storeLimitValueRate": null,
                                "aloneUseCoupon": true,
                                "couponMaxUse": null,
                                "integralAndCouponUsed": false
                            }
                        }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	limitRules	否	成功返回limitRules相关数据

limitRules属性

参数名	类型	是否必填	描述
integralAsCash	Bool	是	是否限制积分抵钱使用（调用组合消费接口中可以使用积分结账），当为真时限制
integralExchangeRate	Integer	是	多少积分抵扣一元
integralUpperLimit	Float(10,2)	是	一单内可以使用的积分上限金额，0代表不限制
integralPercentLimit	Float(10,2)	是	积分占订单金额总额百分比上限，默认100不限制
aloneUseCoupon	Boolean	否	是否限制单纯使用券消费，当为真时限制
couponMaxUse	Integer	否	同一订单最多可使用张数，默认为空不限制

4.4 创建新门店

请求参数

功能描述	创建新门店
正式环境地址	https://openapi.yazuo.com/merchant/createMerchantFromThirdParty
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
merchantId	Long	是	门店id(用于校验)
thirdpartyBrandNo	String(64)	是	第三方商户标识
thirdpartyBrandName	String(128)	否	第三方集团名称
thirdpartyTopAreaName	String(64)	是	第三方上级域（创建域传集团名称，创建门店传域名称）
thirdpartyMerchantNo	String(64)	是	第三方门店标识/域标识
thirdpartyMerchantName	String(128)	是	第三方门店名称/域名称
thirdpartyMerchantSort	String(128)	是	第三方门店序号/域序号(顺序排列)
province	String	否	省份
city	String	否	城市
area	String	否	区
address	String	否	详细地址

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

4.5 获取储值码链接接口

请求参数

功能描述	此接口用于生成服务员二维码，目前支持储值码手机号角色是店长
正式环境地址	https://openapi.yazuo.com/merchant/queryEmployeeURL
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
mobile	String	是	手机号

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
data	String	是	链接

5 会员类接口

5.1 会员查询接口

请求参数

功能描述	根据手机号/微信OPENID/支付用户ID查询会员
正式环境地址	https://openapi.yazuo.com/member/queryMembershipInfoEx
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
queryType	String(64)	是	查询类型0：雅座会员ID 1：手机号码 2：支付宝ID 3:微信OPENID
queryStr	String(16)	是	查询值（根据queryType传递对应会员ID、手机号、支付宝ID、微信OPENID）
brandId	Integer	是	雅座集团ID

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	返回会员拓展对象列表

data（嵌套）属性【MemberExtend】

参数名	类型	是否必填	描述
id	Integer	是	会员ID
name	String	否	会员名称
totalConsumeAmt	BigDecimal	是	累计消费
totalConsumeCount	Integer	是	累计消费次数
lastConsumeTime	String	是	最近消费时间
levelTotal	Integer	否	会员等级总数
membershipTypeName	String	否	会员身份
growth	Integer	否	当前成长值
needGrowth	Integer	否	升级所需成长值
nextLevelName	String	否	下一等级名称
aliUserId	String	否	阿里用户id
microMessageId	String	否	微信id
aliAvatar	String	否	阿里头像地址
weixinAvatar	String	否	微信头像地址
aliNickName	String	否	阿里昵称
weiXinNickName	String	否	微信昵称
createChannelName	String	否	会员来源
point	Integer	否	集点余额
nowLevelId	Integer	否	当前会员等级id
nowLevelSort	Integer	否	当前会员等级排序
nowLevelName	String	否	当前会员等级名称

5.2 创建会员

请求参数

功能描述	按指定类型查询会员，不存在时直接创建会员，返回会员对象
正式环境地址	https://openapi.yazuo.com/member/queryOrCreateMembership
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
thirtyType	String(64)	是	会员来源类型1：手机号码 2：支付宝ID 3:微信OPENID
thirtyMemberId	String(64)	是	根据来源类型传相应的手机号、支付宝ID、微信OPENID
membership	JsonObject	是	查询值
brandId	Integer	是	雅座集团编号

membership属性

参数名	类型	是否必填	描述
gender	Integer	否	会员性别（1-男 2-女）
birthType	Integer	是	生日类型（1-阳历 2-阴历）
name	String(128)	否	会员名称
mobile	String(11)	否	会员手机号（来源类型1时必填）
birthday	Date	否	生日
merchantId	Integer	是	所属雅座门店ID
email	String(64)	否	电子邮箱
description	String(256)	否	描述，备注
address	String(64)	否	地址
idNumber	String(32)	否	证件号码
postcode	String(8)	否	邮政编码
phone	String(16)	否	座机电话
typeId	Integer	否	证件类型
unionId	String(32)	否	微信unionId

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "thirtyType": 1,
    "thirtyMemberId": "23012340001",
    "membership": {
      "gender": 0,
      "birthType": 1,
      "name": "modify",
      "mobile": "23012340001",
      "birthday": null,
      "merchantId": 14068,
      "email": null,
      "joinDate": "2016-10-18 00:00:00",
      "status": 1,
      "description": null,
      "address": null,
      "idNumber": null,
      "postcode": null,
      "phone": null,
      "typeId": null,
      "brandId": "${brand_id}",
      "constellation": null,
      "microMessageId": null,
      "unionId":null
    }
  }
}

返回结果示例

{
  "message": "查询会员成功",
  "data": {
    "list": [
      {
        "id": 9021317,
        "gender": 1,
        "birthType": 1,
        "name": "张三",
        "mobile": "13412345678",
        "birthday": "1987-11-07",
        "merchantId": 21,
        "email": null,
        "joinDate": "2013-08-31",
        "status": 1,
        "description": null,
        "address": null,
        "idNumber": null,
        "postcode": null,
        "phone": null,
        "typeId": null,
        "constellation": null,
        "brandId": 15
      }
    ],
    "total": 2
  },
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	会员对象

data（嵌套）属性

参数名	类型	是否必填	描述
isNewMembership	Boolean	是	是否新会员
membership	JOSNObject	是	会员对象

5.3 更新会员

请求参数

功能描述	修改会员基本信息
正式环境地址	https://openapi.yazuo.com/member/modifyMembership
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
membershipId	Integer	是	雅座会员ID
gender	Integer	否	会员性别（1-男 2-女）
birthType	Integer	是	生日类型（1-阳历 2-阴历）
name	String(128)	否	会员名称
mobile	String(11)	否	会员手机号（来源类型1时必填）
birthday	Date	否	生日
merchantId	Integer	是	所属雅座门店ID
email	String(64)	否	电子邮箱
description	String(256)	否	描述，备注
address	String(64)	否	地址
idNumber	String(32)	否	证件号码
postcode	String(8)	否	邮政编码
phone	String(16)	否	座机电话
typeId	Integer	否	证件类型
brandId	Integer	是	雅座集团ID
unionId	String(32)	否	微信unionId

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "membershipId": 30110501,
    "gender": 0,
    "birthType": 1,
    "name": "modify",
    "mobile": "23012340001",
    "birthday": null,
    "merchantId": 14068,
    "email": null,
    "joinDate": "2016-10-18 00:00:00",
    "status": 1,
    "description": "测试",
    "address": null,
    "idNumber": null,
    "postcode": null,
    "phone": null,
    "typeId": null,
    "brandId": "${brand_id}",
    "constellation": null,
    "unionId":null
  }
}

返回结果示例

{
  "message": "修改会员成功",
  "data": {
    "membership": {
      "id": 9021317,
      "gender": 1,
      "birthType": 1,
      "name": "闰丰",
      "mobile": "23766924372",
      "birthday": "1987-11-07",
      "merchantId": 21,
      "email": null,
      "joinDate": "2013-08-31",
      "status": 1,
      "description": null,
      "address": null,
      "idNumber": null,
      "postcode": null,
      "phone": null,
      "typeId": null,
      "brandId": 15
    }
  },
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	返回的具体数据

data（嵌套）属性

参数名	类型	是否必填	描述
membership	JsonObject	是	返回Membership对象

5.4.1 会员ID查询会员卡列表

请求参数

功能描述	根据会员ID查询该会员下所有会员卡
正式环境地址	https://openapi.yazuo.com/card/queryCard
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
membershipId	int	是	会员ID

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext": {
                        "brandId": "${brand_id}",
                        "membershipId": 30110501
                      }
                    }

返回结果示例

                    
                    {
                      "message": "查询卡成功",
                      "data": {
                        "list": [
                          {
                            "cardNo": "6201300193506808",
                            "merchantNo": "666660000000021",
                            "activeDate": 1397145600000,
                            "expiredDate": null,
                            "storeBalance": 0,
                            "integralBalance": 0,
                            "integralAvailable": 0,
                            "merchantId": 15,
                            "cardtypeId": null,
                            "membershipId": 11671221,
                            "brandId": 15
                          }
                        ],
                        "total": 1
                      },
                      "code": 0
                    }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
list	JOSNObject	是	返回Card对象列表
total	long	是	总记录数

Card对象描述

参数名	类型	是否必填	描述
cardNo	String	是	卡号
merchantNo	String	是	卡属商户编号
activeDate	Date	是	激活时间
expiredDate	Date	否	有效期至
storeBalance	Float(10,2)	是	储值
integralBalance	Float(10,2)	是	积分额
integralAvailable	Float(10,2)	是	可用积分额
merchantId	Integer	是	商户ID
cardtypeId	Integer	否	卡类型ID
membershipId	Integer	是	会员ID
brandId	Integer	是	集团ID

5.4.2 手机号查询会员卡列表

请求参数

功能描述	根据手机号、brandId查询会员卡列表
正式环境地址	https://openapi.yazuo.com/card/queryMemberCards
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
queryMobile	String(16)	是	查询值（手机号）
brandId	Integer	是	雅座集团ID

参数请求示例

                    
                        {
                          "access_token": "${access_token}",
                          "ciphertext": {
                            "queryMobile": "18451391523",
                            "brandId": "${brand_id}"
                          }
                        }

返回结果示例

                    
                        {
                        "code": 0,
                        "message": "查询会员卡成功",
                        "data": {
                            "list": [
                                {
                                    "cardNo": "6201200562281268",
                                    "merchantNo": "555555555555555",
                                    "activeDate": "2017-12-21",
                                    "expiredDate": null,
                                    "storeBalance": 0,
                                    "integralBalance": 900,
                                    "integralAvailable": 900,
                                    "merchantId": 243,
                                    "cardtypeId": 180000008,
                                    "membershipId": 215272493,
                                    "brandId": 243
                                }
                            ],
                            "pageSize": 1,
                            "currentPage": 1,
                            "total": 1
                        }
                    }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
list	JOSNObject	是	返回Card对象列表
total	long	是	总记录数

Card对象描述

参数名	类型	是否必填	描述
cardNo	String	是	卡号
merchantNo	String	是	卡属商户编号
activeDate	Date	是	激活时间
expiredDate	Date	否	有效期至
storeBalance	Float(10,2)	是	储值
integralBalance	Float(10,2)	是	积分额
integralAvailable	Float(10,2)	是	可用积分额
merchantId	Integer	是	商户ID
cardtypeId	Integer	否	卡类型ID
membershipId	Integer	是	会员ID
brandId	Integer	是	集团ID

5.5.1 查询会员券列表【支持卡号或券码查询】

请求参数

功能描述	场景一：会员中心券资产查询，根据雅座会员卡号查询全部优惠券(手机券和当前卡券) 场景二：POS侧查询当前门店该卡的可用券场景三：扫券码查询券详情
正式环境地址	https://openapi.yazuo.com/coupon/queryAllCouponList
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
queryType	Integer	是	查询类型（1-卡号 2-券ID）
queryStr	Long	是	查询值
merchantNo	String	否	门店编号（ 1.查询类型为卡号时，如果填写，查询的是适用该门店的券 2.查询类型为id时，如果填写判断该券是否可用）
status	Integer	否	券状态（1-可用券 2-已消费券 3-作废券 4-过期券 5-待用券）（注: 1.查询类型为[1]卡号时，不填写，查询的是全部状态券; 2.券状态5,当前和未来的可用券）
channel	String	否	优惠券可用渠道 999 全部渠道可用券 1000 堂食(参数不传默认为堂食) 1031 外卖 1066 有赞商城

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
list	JOSNObject	是	返回Coupon对象列表
voucher	long	是	总记录数

Coupon对象说明

参数名	类型	是否必填	描述
id	Long	是	ID
couponId	String	否	券ID
name	String	是	名称
amount	Decimal(2,1)	是	金额(券类型为折扣券时，值为折扣率)
batchNo	Integer	是	批次号
cardNo	String	否	会员卡号（为空时券归属为会员）
mobile	String	否	手机号（为空时券归属为卡账户）
startDate	Date	是	开始时间（有效期）
expiredDate	Date	是	到期时间（有效期）
beginTime	Time	否	每天开始时间（可用周期）
endTime	Time	否	每天结束时间（可用周期）
merchantId	Integer	是	所属门店
sendTime	Timestamp	是	发送时间
sendQuantity	Integer	是	发送数量
availableQuantity	Integer	是	有效劵数量
couponCategoryId	Integer	是	券种类ID（见附表4，枚举值全场代金、全场折扣、单品代金、单品折扣、单品兑换）
startWeek	Integer	否	周使用限制（可用周期）
endWeek	Integer	否	周使用限制（可用周期）
membershipId	Integer	否	会员ID
status	Integer	是	券状态
maxAmount	Decimal(2,1)	否	最高优惠金额（折扣券会有）
goodsList	JOSNArray	否	菜品相关List
cost	Decimal(2,1)	否	券现金成本
couponIntegral	Decimal(2,1)	否	券积分成本
isAloneUse	Boolean	否	是否限制与其他券不同享,真为限制
brandId	Integer	是	集团ID
usageRules	JOSNArray	否	使用规则，待扩展（需第三方遍历此数组，判断ruleType等于对应规则类型，解析规则实现相应逻辑）
channelIdList	List	否	券渠道信息，为null则所有渠道可用
applySenseCode	Integer	否	券投放途径
applySenseCon	String	否	券投放途径中文描述
applyMerchants	List	否	券可使用门店名称
otherCouponLogo	String	否	第三方券模板logo
otherCouponLogo2	String	否	第三方券模板logo2

usageRules对象属性说明

参数名	类型	是否必填	描述
ruleType	String	是	使用限制规则类型
operator	String	是	使用值操作类型，取值现包括（“EQ” 等于 “NEQ” 不等于 “GT” 大于 “LT” 小于 “IN” 列表中 “BETWEEN” 介于）
values	String	是	规则取值，根据操作符不同设置不同值（“EQ”、“NEQ”、“GT”和“LT” 返回单个数值； “IN” 返回逗号分割的数字串； “BETWEEN” 返回逗号分隔的两个数字）

当前可使用的规则类型

ruleType	描述
baseRuleAmount	最低消费限额，对应values取值为数值类型
couponExclusive	最低消费限额，对应values取值为数值类型

goodsList象属性说明

参数名	类型	是否必填	描述
usedType	Integer	是	菜品设置类型（1-关联菜品/品类 2-不参与菜品/品类 3-消费菜品/品类）
goodsType	Integer	是	菜品类型（1-菜品 2-品类）
goodsId	String	是	菜品/品类id
goodsName	String	是	菜品/品类名称
quantity	Integer	否	消费菜品数量（菜品设置类型为3是适用

applyMerchants对象属性说明

参数名	类型	是否必填	描述
merchantId	Integer	否	门店id
merchantName	String	否	门店名称

5.5.2 查询正在进⾏营销活动的券和⾃定义券

请求参数

功能描述	查询正在进⾏营销活动的券和⾃定义券
正式环境地址	https://openapi.yazuo.com/coupon/queryCouponAboutActive
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
merchantId	Integer	是	门店ID
applySenseCodeList	List	否	券投放途径，枚举定义见附录

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
activeCouponTemplates	JOSNObject	是	在进⾏营销活动的券list
customizeCouponTemplates	JOSNObject	是	⾃定义券list

activeCouponTemplates属性

参数名	类型	是否必填	描述
name	String	是	券模板名称
batchNo	String	是	批次
couponCategoryId	Integer	是	券类型
applySenseCode	Integer	是	券投放途径
applySenseCon	String	是	券投放途径中文描述

customizeCouponTemplates属性

参数名	类型	是否必填	描述
name	String	是	券模板名称
batchNo	String	是	批次
couponCategoryId	Integer	是	券类型
applySenseCode	Integer	是	券投放途径
applySenseCon	String	是	券投放途径中文描述

tags数组元素属性

参数名	类型	是否必填	描述
groupId	Integer	是	标签组id
groupName	String	是	标签名称
id	Integer	是	标签ID
name	String	是	标签名称

5.6.1 重置卡交易密码

请求参数

功能描述	此接口用于重置会员卡交易密码，重置后的交易密码短信发送到会员卡绑定手机上重置卡密码在一分钟以内同一卡号不允许操作两次，并且同一卡号24小时以内最多操作5次
正式环境地址	https://openapi.yazuo.com/card/ resetCardPasswd
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	卡号
merchantId	Integer	是	所属雅座门店ID

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantId": "${merchant_id}"
  }
}

返回结果示例

{
  "message": "SUCCESS",
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

5.6.2 校验卡交易密码

请求参数

功能描述	此接口用于在会员消费前校验交易是否正确商户对应卡类型是否要求交易密码请查看卡类型查询接口返回数据
正式环境地址	https://openapi.yazuo.com/card/checkCardPwd
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	卡号
password	String	是	卡交易密码
merchantId	Integer	是	所属雅座门店ID

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantId": "${merchant_id}",
    "password": "123456"
  }
}

返回结果示例

{
  "message": "SUCCESS",
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

5.6.3 会员密码修改【根据原密码修改】

请求参数

功能描述	此接口用于修改会员卡交易密码，修改后的交易密码短信发送到会员卡绑定手机上修改卡密码在一分钟以内同一卡号不允许操作两次，并且同一卡号24小时以内最多操作5次，若为非简单密码的，限制为，查询卡类型请见【6.13.1】综合查询接口
正式环境地址	https://openapi.yazuo.com/card/resetCardPasswdByOldPasswd
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	卡号
merchantId	Integer	是	所属雅座门店ID
prePassword	Integer	是	原卡密码
password	Integer	是	修改后的卡密码

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

5.6.4 会员密码修改【根据验证码修改】

请求参数

功能描述	此接口用于通过验证码修改会员卡交易密码，修改密码在一分钟以内同一卡号不允许操作两次，并且同一卡号24小时以内最多操作5次
正式环境地址	https://openapi.yazuo.com/card/modifyCardPwdByCode
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	会员卡号
merchantId	Integer	是	所属雅座门店ID
password	Integer	是	修改后的卡密码
mobile	String	是	手机号
identifycode	String	是	验证码

参数请求示例

{
                  "access_token": "${access_token}",
                  "ciphertext": {
                    "brandId": "${brand_id}",
                    "merchantId": "${merchant_id}",
                    "cardNo": "6201305668069628",
                    "password": "120911",
                    "identifycode": "214983",
                    "mobile": "18621564640"
                  }
                }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

5.7 外卡导入接口

请求参数

功能描述	外卡导入（作用于自身有会员系统厂商，绑定厂商卡和雅座卡）
正式环境地址	https://openapi.yazuo.com/card/queryExternalCard
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	卡号
mobile	Integer	是	手机号
merchantNo	String	是	门店
name	String	是	会员名称
gender	Integer	是	会员性别(1-男 2-女)
birthType	Integer	否	生日类型(1-阳历 2-阴历)
birthday	String	是	会员生日

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	返回会员对象列表

data(嵌套)属性

参数名	类型	是否必填	描述
list	JOSNObject	是	返回Membership对象列表
pageSize	Integer	是	每页显示条数
currentPage	long	是	当前页
total	long	是	总页数

Membership对象属性

参数名	类型	是否必填	描述
id	Integer	是	会员ID
gender	Integer	否	会员性别
birthType	Integer	是	生日类型(1-阳历 2-阴历)
name	String	否	会员名称
mobile	String	否	会员手机号
birthday	Date	否	生日
merchantId	Integer	是	所属门店
email	String	否	电子邮箱
joinDate	Date	是	加入时间
status	Integer	是	状态
description	String	是	描述、备注
address	String	是	地址
idNumber	String	否	证件号码
postcode	String	否	邮政编码
phone	String	否	座机电话
typeid	String	否	证件类型
constellation	String	否	星座
microMessageId	String	否	微信id
brandId	Integer	是	集团ID
defaultCard	String	否	用户设置的默认卡
membershipLevelId	Integer	否	会员等级
membershipLevelName	Integer	否	会员等级名称
isVerified	Bool	否	是否已认证,已认证为true
benefits	JSONObject	否	会员权益
tags	JSONArray	否	会员绑定的标签

5.8 更换会员默认卡

请求参数

功能描述	更换会员默认卡
正式环境地址	https://openapi.yazuo.com/card/modifyMembershipDefaultCard
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
oldCardNo	String(16)	是	原来默认卡的卡号
cardNo	String(16)	是	需要设置为默认卡的卡号
merchantId	Long	是	会员所属雅座门店

返回参数

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

5.9 获取会员最新评价信息

请求参数

功能描述	获取会最新评价信息
正式环境地址	https://openapi.yazuo.com/evaluate/queryEvaluateLast
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
mobile	String	是	会员手机号
merchantId	Integer	是	评价门店

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	String	是	授权code {warranty}

data（嵌套）属性

参数名	类型	是否必填	描述
transWaterId	Long	是	交易流水id
evaluateDatetime	Date	是	评论时间
content	String	是	评价内容
evaluateParameters	JsonObject	是	标签拼接数据

evaluateParameters属性说明

参数名	类型	是否必填	描述
satisfaction	String	是	满意度描述
score	Integer	是	分数
tagChildText	String	是	评价标签组合
tagName	String	是	标签类型

返回结果示例

                    
                    {
                        "code": 0,
                        "message": "查询成功",
                        "data": [{
                            "id": 180001480,
                            "mobile": "15311428231",
                            "uid": 0,
                            "merchantId": 180276011,
                            "evaluateDatetime": "2019-11-13",
                            "transWaterId": 426102275,
                            "content": "测试评价内容",
                            "source": 3,
                            "type": 1,
                            "score": 3,
                            "brandId": 180276008,
                            "impress": "口味偏淡 菜品不新鲜 装修有格调 服务态度差 服务热情周到",
                            "tasteMark": 5,
                            "environmentMark": 4,
                            "serviceMark": 3,
                            "couponId": null,
                            "weiboEvaluateId": null,
                            "isShareWeibo": false,
                            "activeId": null,
                            "fourMark": 3,
                            "fiveMark": 3,
                            "isDeal": 0,
                            "isReply": 0,
                            "remark": null,
                            "emotionNegative": null,
                            "emotionPositive": null,
                            "evaluateParameters": [
                                {
                                    "satisfaction": "一般",
                                    "score": 3,
                                    "tagChildText": null,
                                    "tagName": "总评分",
                                },
                                {
                                    "satisfaction": "很满意",
                                    "score": 5,
                                    "tagChildText": "口味偏淡 菜品不新鲜",
                                    "tagName": "口味",
                                },
                                {
                                    "satisfaction": "比较满意",
                                    "score": 4,
                                    "tagChildText": "装修有格调",
                                    "tagName": "环境",
                                },
                                {
                                    "satisfaction": "一般",
                                    "score": 3,
                                    "tagChildText": "服务态度差 服务热情周到",
                                    "tagName": "服务",
                                }
                            ]


                        }]
                    }

5.10 开放平台提供check微信卡&支付宝卡状态接口

请求参数

功能描述	开放平台提供check微信卡&支付宝卡状态接口
正式环境地址	https://openapi.yazuo.com/member/checkAliANDWeixinMemberInfo
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
aliUserId	String	否	阿里会员id，不填默认不查询阿里会员信息
openId	String	否	微信openId,不填默认不查询微信会员信息

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	String	是	data数据

data（嵌套）属性

参数名	类型	是否必填	描述
weixinMemberCard	Object	是	微信会员信息
aliMemberCard	Object	是	阿里会员信息

weixinMemberCard属性说明

参数名	类型	是否必填	描述
hasCard	String	是	是否领卡
code	String	是	微信code

aliMemberCard属性说明

参数名	类型	是否必填	描述
hasCard	String	是	是否领卡
passId	String	是	阿里passId

返回结果示例

                    
                    {
                        "code": 0,
                        "message": "查询成功",
                        "data": {
                            "weixinMemberCard":{
                                "hasCard":true,
                                "code":""
                            },
                            "aliMemberCard"{
                                "hasCard":true,
                                "passId":""
                            }
                        }
                    }

5.11 根据wid查询openId(雅座收银专用)

请求参数

功能描述	根据wid查询openId
正式环境地址	https://openapi.yazuo.com/member/queryOpenIdByWid
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
wid	String	是	三方会员ID
brandId	Integer	是	集团ID(用于校验)

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	List	是	openId

返回结果示例

                    
                    {
                        "code": 0,
                        "message": "请求成功",
                        "data": [
                            "xxddgcv47Xhhnrq0_02-sgENxiI",
                            "oyiiqv17XLTnrq0_06-RgENxiIOo"
                        ]
                    }

5.12 会员统计数据查询接口

请求参数

功能描述	根据商户ID查询会员统计数据
正式环境地址	https://openapi.yazuo.com/member/queryMembershipStatisticsDataByBrandId
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	雅座集团ID

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	String	是	data数据

data（嵌套）属性

参数名	类型	是否必填	描述
genderProportion	Object	是	性别占比
membershipStatistics	Object	是	会员统计
merchantStoredRechargeTop	Object	是	门店储值排行前10
membershipAgeDistribution	Object	是	年龄分布

genderProportion属性说明

参数名	类型	是否必填	描述
manNumber	Integer	是	男性会员数量
manRate	Float(10,2)	是	男性会员占比
womanNumber	Integer	是	女性会员数量
womanRate	Float(10,2)	是	女性会员占比
otherNumber	Integer	是	其他会员数量
otherRate	Float(10,2)	是	其他会员占比

membershipStatistics属性说明

参数名	类型	是否必填	描述
totalMembershipNumber	Integer	是	总会员数
dailyNewMembershipNumber	Integer	是	当日新增会员数
monthlyNewMembershipNumber	Integer	是	当月新增会员数
dailyStoredRechargePrincipal	Float(10,2)	是	每日储值金额(本金)
dailyStoredRechargeReward	Float(10,2)	是	每日储值金额(赠金)
monthlyStoredRechargePrincipal	Float(10,2)	是	每月储值金额(本金)
monthlyStoredRechargeReward	Float(10,2)	是	每月储值金额(赠金)

merchantStoredRechargeTop属性说明

参数名	类型	是否必填	描述
merchantId	Integer	是	大雅门店ID
merchantName	String	是	门店名称
storedRechargePrincipal	Float(10,2)	是	门店储值金额(本金)
storedRechargeReward	Float(10,2)	是	门店储值金额(溢价)

membershipAgeDistribution属性说明

参数名	类型	是否必填	描述
name	String	是	年龄段
membershipNumber	Integer	是	会员数量
membershipRate	Float(10,2)	是	占比

返回结果示例

                    
                        {
                            "code": 0,
                            "message": "请求成功",
                            "data": {
                                "genderProportion": {
                                    "otherNumber": 112210,
                                    "manNumber": 2277,
                                    "otherRate": 48.07,
                                    "womanRate": 50.95,
                                    "manRate": 0.98,
                                    "womanNumber": 118932
                                },
                                "membershipStatistics": {
                                    "totalMembershipNumber": 234096,
                                    "dailyStoredRechargeReward": 0.00,
                                    "dailyStoredRechargePrincipal": 2000.00,
                                    "monthlyNewMembershipNumber": 205,
                                    "monthlyStoredRechargeReward": 17076.20,
                                    "monthlyStoredRechargePrincipal": 399011.29,
                                    "dailyNewMembershipNumber": 0
                                },
                                "merchantStoredRechargeTop": [
                                    {
                                        "merchantId": 180276068,
                                        "storedRechargePrincipal": 314744.78,
                                        "storedRechargeReward": 12763.19,
                                        "merchantName": "五芳斋测试门店1"
                                    },
                                    {
                                        "merchantId": 180276067,
                                        "storedRechargePrincipal": 68491.51,
                                        "storedRechargeReward": 4113.01,
                                        "merchantName": "五芳斋测试"
                                    }
                                ],
                                "membershipAgeDistribution": [
                                    {
                                        "membershipNumber": 1231231,
                                        "membershipRate": 50.48,
                                        "name": "14~18岁"
                                    },
                                    {
                                        "membershipNumber": 21312,
                                        "membershipRate": 0.87,
                                        "name": "19~25岁"
                                    },
                                    {
                                        "membershipNumber": 123124,
                                        "membershipRate": 5.05,
                                        "name": "26~35岁"
                                    },
                                    {
                                        "membershipNumber": 54321,
                                        "membershipRate": 2.23,
                                        "name": "36~45岁"
                                    },
                                    {
                                        "membershipNumber": 654324,
                                        "membershipRate": 26.83,
                                        "name": "46~60岁"
                                    },
                                    {
                                        "membershipNumber": 123432,
                                        "membershipRate": 5.06,
                                        "name": "61~80岁"
                                    },
                                    {
                                        "membershipNumber": 231397,
                                        "membershipRate": 9.48,
                                        "name": "其他"
                                    }
                                ]
                            }
                        }

6 交易类接口

6.1.1 会员卡激活

请求参数

功能描述	此接口用于门店实体卡激活
正式环境地址	https://openapi.yazuo.com/card/activate
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Long	是	集团ID(用于校验)
cardNo	String(16)	是	卡号
merchantNo	String(15)	是	雅座交易门店编号
cashierSerial	String(64)	是	第三方订单号（收银流水号）
mobile	String(11)	是	交易手机号
cardtypeId	Integer	是	卡类型ID
terminalNo	String(8)	是	门店终端号
idNumber	String(18)	否	身份证号（是否必填见卡类型要求）
password	String(32)	否	交易密码（是否必填见卡类型要求，默认设置000000）

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantNo": "${merchant_no}",
    "cashierSerial": "20161230103122",
    "terminalNo": "1111111",
    "cardtypeId": "143",
    "integralValue": 10,
    "password": "890764",
    "mobile": "13611337674",
    "idNumber": "440301197907160325"
  }
}

返回结果示例

{
  "message": "SUCCESS",
  "data": {
    "card": {
      "cardNo": "6201300193506808",
      "merchantNo": "666660000000021",
      "activeDate": 1397145600000,
      "expiredDate": null,
      "storeBalance": 0,
      "integralBalance": 0,
      "integralAvailable": 0,
      "merchantId": 15,
      "cardtypeId": null,
      "membershipId": 11671221,
      "brandId": 15
    },
    "voucher": "1234356"
  },
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
card	是	JOSNObject	返回激活后卡对象信息
voucher	是	Integer	终端流水号(6个字节)

6.1.2 礼品卡激活

请求参数

功能描述	此接口用于门店礼品卡激活
正式环境地址	https://openapi.yazuo.com/card/activateGift
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
cardNo	String(16)	是	卡号
merchantNo	String(15)	是	雅座交易门店编号
cashierSerial	String(64)	是	第三方订单号（收银流水号）
cardtypeId	Integer	是	卡类型ID
storeValue	Float(10,2)	是	激活时充值金额（卡售价）
terminalNo	String(8)	是	门店终端号
password	String(32)	否	交易密码（是否必填见卡类型要求，默认设置000000）

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext":
                      {
                        "brandId": "${brand_id}",
                        "cardNo": "6201200562333628",
                        "merchantNo": "666660000277706",
                        "cashierSerial": "20161230103122",
                        "terminalNo": "1111111",
                        "cardtypeId": "120775",
                        "storeValue": 80,
                        "password": "000000"
                      }
                    }

返回结果示例

                    
                    {
                      "code": 0,
                      "message": "请求成功"
                      "data":
                      {
                        "card":
                        {
                            "cardNo": "6201200562333628",
                            "cardtype": null,
                            "merchantNo": "666660000277706",
                            "activeDate": "2020-02-11",
                            "expiredDate": null,
                            "storeBalance":0,
                            "integralBalance": 0,
                            "integralAvailable": 0,
                            "merchantId": 180276067,
                            "cardtypeId": 120775,
                            "membershipId": 215454690,
                            "brandId": 180276067,
                            "storeAvailable": null
                        },
                        "voucher": 359684
                      }
                    }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
card	JOSNObject	是	返回激活后卡对象信息
voucher	Integer	是	终端流水号(6个字节)

6.1.3 卡升级激活

请求参数

功能描述	此接口用于电子会员卡升级为实体会员卡
正式环境地址	https://openapi.yazuo.com/card/transferCards
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
oldCardNo	String(16)	是	旧卡卡号
merchantNo	String(15)	是	雅座交易门店编号
newCardNo	String(16)	是	新卡卡号
terminalNo	String(8)	是	门店终端号

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext":
                      {
                        "brandId": "${brand_id}",
                        "oldCardNo": "6201200562333628",
                        "merchantNo": "666660000277706",
                        "newCardNo": "6201200562333648",
                        "terminalNo": "1111111"
                      }
                    }

返回结果示例

                    
                    {
                      "code": 0,
                      "message": "请求成功"
                      "data":
                      {

                        "fromCardNo": "6201200562333638",
                        "toCardNo":  "6201200562333648 ",
                        "merchantId": 180276072,
                        "amount": null,
                        "voucherNo": 118125,
                        "terminalNo": "1111111 ",
                        "batchNo": 396436,
                        "remark": null,
                        "transferType": null,
                        "merchantNo": 120775
                      }
                    }

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
fromCardNo	String(16)	是	旧卡卡号
toCardNo	String(16)	是	新卡卡号
merchantId	String	是	门店编码
amount	BigDecimal	是	交易金额
voucherNo	Integer	否	凭证号
terminalNo	String(8)	否	雅座终端号(授权后返回)
batchNo	Integer	是	批次号
remark	String	否	备注
transferType
merchantNo	String	是	商户编号

6.1.4 礼品卡批量激活

请求参数

功能描述	此接口用于POS批量激活实体卡
正式环境地址	https://openapi.yazuo.com/card/batchActivateGift
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
cardList	List	是	激活卡列表(30张之内，包括30)
merchantNo	String(15)	是	雅座交易门店编号
cashierSerial	String(64)	是	第三方订单号（收银流水号）
terminalNo	String(8)	是	门店终端号

cardList对象属性说明

参数名	类型	是否必填	描述
cardNo	Long	是	卡号
cardtypeId	Interger	是	卡类型ID
storeValue	Float(10,2)	是	激活时充值金额（卡售价）
password	String	否	交易密码（是否必填见卡类型要求，默认设置000000）

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext":
                      {
                        "brandId": "${brand_id}",
                        "merchantNo": "666660000277706",
                        "cashierSerial": "20161230103129",
                        "terminalNo": "1111111",
                        "cardList":[
                        {
                        	"cardNo": "6201500000193538",
                        	"cardtypeId": "120796",
                        	"storeValue": "80",
                        	"password": "000000"
                        },{
                        	"cardNo": "6201500000192758",
                        	"cardtypeId": "120796",
                        	"storeValue": "80",
                        	"password": "000000"
                    	}]
                      }
                    }

返回结果示例

                    
                    成功
                    {
                      "code": 0,
                      "message": "请求成功"
                    }
                    失败
                    {
                      "code": -1,
                      "message": "请求失败"
                      "data":[
                      	{

                        "cardNo": "6201500000193878",
                        "message":  "卡已激活 "
                      	},{

                        "cardNo": "6201500000193888",
                        "message":  "卡已激活 "
                      	}
                      ]

                    }

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	List	否	失败卡及原因

6.2 会员卡充值前置校验

请求参数

功能描述	此接口用于储值卡充值前置校验
正式环境地址	https://openapi.yazuo.com/trade/checkRecharge
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Long	是	集团ID(用于校验)
cardNo	String(16)	是	卡号
merchantNo	String(15)	是	雅座交易门店编号
terminalNo	String(8)	是	雅座终端号
cashierSerial	String(64)	是	第三方订单号（收银流水号）
storeNumber	Float(10,2)	是	总计储值额
payWays	JOSNArray	是	支付方式明细

payways 数组属性

参数名	类型	是否必填	描述
id	Integer	是	支付方式：具体值参考支付方式列表
value	Float(10,2)	是	单项支付金额

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantNo": "${merchant_no}",
    "cashierSerial": "20161230103122",
    "terminalNo": "11111111",
    "storeNumber": 100,
    "payWays": [
      {
        "id": "1",
        "value": 100
      }
    ]
  }
}

返回结果示例

{
    "code": 0,
    "message": "请求成功",
    "data": {
        "status": "0",
        "detail": "成功"
    }
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
status	String	是	状态值0：校验通过 -1：校验不通过
detail	String	是	提示语

6.3 会员卡充值

请求参数

功能描述	此接口用于储值卡充值
正式环境地址	https://openapi.yazuo.com/trade/recharge
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Long	是	集团ID(用于校验)
cardNo	String(16)	是	卡号
merchantNo	String(15)	是	雅座交易门店编号
terminalNo	String(8)	是	雅座终端号
cashierSerial	String(64)	是	第三方订单号（收银流水号）
storeNumber	Float(10,2)	是	总计储值额
payWays	JOSNArray	是	支付方式明细

payways 数组属性

参数名	类型	是否必填	描述
id	Integer	是	支付方式ID：具体值参考支付方式列表
value	Float(10,2)	是	单项支付金额

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantNo": "${merchant_no}",
    "cashierSerial": "20161230103122",
    "terminalNo": "11111111",
    "storeNumber": 100,
    "payWays": [
      {
        "id": "1",
        "value": 100
      }
    ]
  }
}

返回结果示例

{
  "message": "SUCCESS",
  "data": {
    "voucher": 899094,
    "totalStore": 110,
    "details": {
      "transTime": "11:00:00",
      "cardNo": "6201200537637618",
      "storeBalance": "110",
      "integralBalance": "0",
      "storeBonus": "10",
      "integralBonus": "10",
      "couponBonus": [
        {
          "id": "9821311",
          "couponName": "代金券",
          "amount": "10.00",
          "startDate": "2016-09-01",
          "endDate": "2016-09-30"
        }
      ]
    }
  },
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
totalStore	Float(10,2)	是	总储值额
voucher	Integer	是	终端流水号(6个字节)
details	JOSNObject	是	储值结果详情

detail对象属性说明

参数名	类型	是否必填	描述
transTime	String	是	交易时间
storeBonus	Float(10,2)	是	本次储值增送额
integralBonus	Float(10,2)	否	本次积分赠送额
storeBalance	Float(10,2)	是	当前储值卡余额
integralBalance	Float(10,2)	是	当前积分余额
couponBonus	JOSNArray	否	赠送的券列表

6.4 会员卡消费接口

请求参数

功能描述	调用此接口进行雅座系统会员核销
正式环境地址	https://openapi.yazuo.com/trade/consumptionSec
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	卡号
merchantNo	String	是	雅座门店编号
thirdMerchant	String	否	开票门店编号
cashierSerial	String	是	收银流水号
password	String	是	交易密码
cashValue	Float(10,2)	是	现金额(此处金额为扣除优惠、积分、储值外的实收现金部分 )
integralValue	Float(10,2)	是	需扣除的雅座积分额
storeValue	Float(10,2)	是	需扣除的雅座储值额
ticketInfoArray	Array	否	本次使用的雅座优惠券信息列表（id，张数，优惠金额）注:优惠金额为每张券的优惠金额，券id相同，优惠金额不同时，请单张的传，优惠金额永远为单张的金额
dishArray	Array	否	菜品列表本次消费菜品信息列表,每项包含（菜品编码,菜品中文名,菜品数量，实付金额，应付金额，券id) 示例： "dishArray": [ ["20222", "蟹子鹅肝蒸蛋", "1", "22.8", "22.8", "1233"] ],
payway	Integer	是	支付方式：具体值参考支付方式列表
payWays	Array	否	支付方式明细。场景说明和集合描述见参考下方文档
remark	String(32)	否	备注
mobile	String(11)	否	交易手机号
source	Integer	否	交易流水来源
terminalNo	String(8)	否	雅座终端号（授权后返回）
orderId	String	否	幂等校验，防止重复消费
undiscountableAmount	Float(10,2)	否	现金消费中不参与优惠金额的部分
financeDate	String	否	财务日期
settleFlag	Boolean	否	是否结清标识，默认为是
mixPayList	List	否	支付方式明细，见下方详细说明

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
detail	JOSNObject	是	返回明细
voucher	int	是	终端流水号(6个字节)

detail对象属性说明

参数名	类型	是否必填	描述
transTime	String	是	交易时间
integralBonus	Float(10,2)	是	本次积分赠送(现金消费按一定比例产生积分赠送)
storeBalance	Float(10,2)	否	当前储值卡余额
integralBalance	Float(10,2)	否	当前积分余额
couponBonus	JOSNArray	否	赠送的券列表
overflowAmount	Float(10,2)	否	储值消费现金部分

couponBonus对象属性说明

参数名	类型	是否必填	描述
couponName	String	是	券名称
availableQuantity	Integer	是	可用券张数
amount	Float(10,2)	是	券金额
startDate	String	是	有效期起始日期
endDate	String	是	有效期结束日期

payWays对象属性说明

参数名	类型	是否必填	描述
id	Integer	是	雅座支付方式id
value	String	是	支付方式金额

mixPayList>MixPay对象属性说明

参数名	类型	是否必填	描述
storeAmount	BigDecimal	是	支付方式金额
payId	String	是	第三方支付id
payCode	payCode	否	第三方支付名称
integralFlag	Boolean	否	是否参与积分 0 不参与，1 参与
growthFlag	Boolean	否	支付金额

6.5.1 会员卡撤销

请求参数

功能描述	实现通过上送凭证号，实现撤单交易。成功后，则卡内各项数值回滚到交易前状态。撤销操作同一张卡不允许隔笔撤销,就是一张卡做了交易A，然后做了交易B，这时不能撤销交易A，只能先撤销交易B，才能撤销交易A。
正式环境地址	https://openapi.yazuo.com/trade/revocation
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	卡号
voucherNumber	String	是	终端流水号
cashierSerial	String	是	收银流水号
merchantNo	String	是	雅座门店编号

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantNo": "${merchant_no}",
    "cashierSerial": "20161230103121",
    "voucherNumber": "${voucherNumber}"
  }
}

返回结果示例

{
  "message": "SUCCESS",
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

6.5.2 会员卡隔笔撤销

请求参数

功能描述	实现通过上送凭证号，实现撤单交易。成功后，则卡内各项数值回滚到交易前状态。只支持三天内的隔笔撤销
正式环境地址	https://openapi.yazuo.com/trade/overRevocation
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	卡号
voucherNumber	String	是	终端流水号
cashierSerial	String	是	收银流水号
merchantNo	String	是	雅座门店编号

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantNo": "${merchant_no}",
    "cashierSerial": "20161230103121",
    "voucherNumber": "${voucherNumber}"
  }
}

返回结果示例

{
  "message": "SUCCESS",
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

6.6.1 积分兑换接口

请求参数

功能描述	此接口适用于第三方如游戏、商城使用雅座积分抵扣等用途
正式环境地址	https://openapi.yazuo.com/trade/consumeIntegral
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Long	是	集团ID(用于校验)
cardNo	String(16)	是	卡号
merchantNo	String(15)	是	雅座交易门店编号
cashierSerial	String(64)	是	第三方订单号（收银流水号）
password	String(32)	是	交易密码
integralValue	Float(10,2)	是	积分额
remark	String(32)	否	备注
mobile	String(11)	否	交易手机号
batchNo	Integer	否	券批次号,用于发券
sendCouponFlag	Boolean	否	是否发券,默认否不发券

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantNo": "${merchant_no}",
    "cashierSerial": "20161230103122",
    "integralValue": 10,
    "password": "890764",
    "remark": "测试积分兑换",
    "mobile": "13611337674"
  }
}

返回结果示例

{
  "message": "SUCCESS",
  "data": {
    "card": {
      "cardNo": "6201300193506808",
      "merchantNo": "666660000000021",
      "activeDate": 1397145600000,
      "expiredDate": null,
      "storeBalance": 0,
      "integralBalance": 0,
      "integralAvailable": 0,
      "merchantId": 15,
      "cardtypeId": null,
      "membershipId": 11671221,
      "brandId": 15
    },
    "voucher": "1234356"
  },
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
card	JOSNObject	是	返回消费后卡对象信息
voucher	Integer	是	终端流水号(6个字节)
issuedCoupon	JOSNObject	否	返回发券信息

issuedCoupon属性

参数名	类型	是否必填	描述
couponName	String	否	券名称
amount	String	否	券面额
thresHold	String	否	最低消费限额
startDate	String	否	开始日期
endDate	String	否	截止日期
couponId	Long	否	发放的券id

6.6.2 积分奖励（签到送积分）

请求参数

功能描述	此接口用于签到等行为的奖励积分
正式环境地址	https://openapi.yazuo.com/trade/awardIntegral
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	会员卡号
mobile	String	否	手机号（可以是微信粉丝会员签到奖励积分）
merchantNo	String	是	雅座门店编号
integralValue	Float(10,2)	是	奖励积分数
cashierSerial	String	是	收银流水号
remark	String	是	积分增加的原因

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	json	是	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
integral	Float(10,2)	是	终端流水号(6个字节)

6.6.3 积分购券（第三方商城对接使用，积分+现金购买券/实物）

请求参数

功能描述	场景一:购买券，只支持一单一品，雅座扣资产&记录相关流水&充值券场景二：购买实物，雅座只扣资产&记录相关流水，不负责实物发货等订单操作
正式环境地址	https://openapi.yazuo.com/trade/integralCoupon
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	会员卡号
merchantNo	String	是	雅座门店编号
cashierSerial	String	是	第三方商城订单号
batchNo	String	否	券批次号
couponCount	Integer	否	购买券数量
cashValue	Float(10,2)	否	现金额（积分和现金不能同时为空）
integralValue	Float(10,2)	否	积分额（积分和现金不能同时为空）
payway	Integer	是	支付方式：具体值参考支付方式列表
remark	String(32)	否	备注
mobile	String(11)	否	交易手机号
source	Integer	否	交易流水来源
terminalNo	String(8)	否	雅座终端号（授权后返回）

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
card	JOSNObject	是	返回消费后卡对象信息
voucher	Integer	是	终端流水号(6个字节)

6.6.4 积分扣减（积分抽奖）

请求参数

功能描述	雅座直接扣减资产产生交易流水，使用场景如：获取积分抽奖资格等
正式环境地址	https://openapi.yazuo.com/trade/reduceIntegral
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String	是	会员卡号
merchantNo	String	是	雅座门店编号
integralValue	Float(10,2)	是	积分额
cashierSerial	String(64)	是	第三方商城订单号（收银流水号）
remark	String(32)	否	备注
mobile	String(11)	否	交易手机号（可以是微信粉丝会员玩游戏扣减）

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
card	JOSNObject	是	返回消费后卡对象信息
voucher	Integer	是	终端流水号(6个字节)

6.7.1 查询在线商城商品信息列表

请求参数

功能描述	此接口用于查询商品信息列表，目前支持会员权益、储值类商品
正式环境地址	https://openapi.yazuo.com/mall/queryGoodsList
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Long	是	集团ID
productType	Integer	是	商品类型（2：储值商品 5：会员权益商品）
membershipId	Integer	否	会员id（用于查询权益商品时过滤不可购买商品）
pageNum	Integer	否	页码（默认第一页）
pageSize	Integer	否	每页数据量（默认每页10条）

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "productType" : 5,
    "brandId" : 180000247,
    "membershipId" : 215272017,
    "pageNum" : 1,
    "pageSize" : 4
  }
}

返回结果示例

{
    "code": 0,
    "message": "查询商品信息列表成功",
    "data": {
        "list": [
            {
                "id": 100180,
                "goodsName": "最高等级",
                "status": 2,
                "introduce": "ASD发送到发达省份多对多",
                "useRules": null,
                "nowPriceCash": 0.01,
                "brandId": 180000247,
                "productType": 5,
                "memberLevelId": 260
            }
        ],
        "pageSize": 4,
        "currentPage": 1,
        "total": 1
    }
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	可为空	描述
list	JOSNObject	是	返回MallGoodsInfo对象列表
total	Integer	是	总记录数
pageSize	Integer	是	每页记录数
currentPage	Integer	是	页码

MallGoodsInfo对象属性说明

参数名	类型	是否必填	描述
id	Integer	是	商品ID
goodsName	String	是	商品名称
status	Integer	是	状态
introduce	String	是	商品介绍
useRules	String	是	商品使用规则
nowPriceCash	Float(10,2)	是	售价
brandId	Integer	是	集团id
productType	Integer	是	商品类型
memberLevelId	Integer	是	会员等级id

6.7.2 购买在线商城商品

请求参数

功能描述	此接口用于购买在线商城商品
正式环境地址	https://openapi.yazuo.com/mall/orderMallGood
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID
membershipId	Long	是	会员id
merchantId	Integer	是	门店id
merchantNo	String	是	门店编码
mallGoodsId	Long	是	商品id
totalAmount	BigDecimal	是	交易金额
payway	Integer	否	支付方式：具体值参考默认为其它支付方式列表

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": 180000247,
    "membershipId": 215272801,
    "merchantId": 180000249,
    "merchantNo": "666660000014184",
    "mallGoodsId": 100124,
    "totalAmount": 0.01
    }
}

返回结果示例

{
    "code": 0,
    "message": "SUCCESS"
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

6.8.1 注券接口

请求参数

功能描述	此接口用于根据手机号给会员注券
正式环境地址	https://openapi.yazuo.com/coupon/sendCoupon
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID
mobile	String	是	手机号
batchNo	Integer	是	券批次号
openId	String(64)	是	OPENID

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": 180000247,
    "mobile": 18888888988,
    "batchNo": 636448,
    "openId": "${openId}"
    }
}

返回结果示例

{
    "code": 0,
    "message": "发券成功"
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

6.8.2 注券接口(无加会员逻辑)

请求参数

功能描述	此接口用于根据手机号给会员注券(无加会员逻辑)
正式环境地址	https://openapi.yazuo.com/coupon/sendCouponAll
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
mobile	String	是	手机号
batchNo	Integer	是	券批次号

参数请求示例

                    
                    {
                        "access_token": "${access_token}",
                        "ciphertext": {
                            "brandId": 180000247,
                            "mobile": 18888888988,
                            "batchNo": 636448
                            }
                    }

返回结果示例

                    
                    {
                        "code": 0，
                        "message":"发券成功"
                    }

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	Integer	否	发送成功的券id

6.9.1 短信验证码发送接口

请求参数

功能描述	短信验证码发送发送验证码未到可再次发送时间：1分钟当日最大发送次数：10次验证码有效时间：1小时验证码位数：6位
正式环境地址	https://openapi.yazuo.com/member/sendShortMessage
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
merchantId	String	是	所属雅座门店ID
mobile	String	是	手机号
brandId	long	是	集团ID(用于校验)

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext": {
                        "brandId": "${brand_id}",
                        "merchantId": ${merchantId},
                        "moblie": "13276279394"
                      }
                    }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

6.9.2 短信验证码验证接口

请求参数

功能描述	短信验证码发送
正式环境地址	https://openapi.yazuo.com/member/checkVerificationCode
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
merchantId	String	是	所属雅座门店ID
mobile	String	是	手机号
identifyCode	String	是	验证码

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext": {
                        "brandId": "${brand_id}",
                        "merchantId":" ${merchantId}",
                        "moblie": "13276279394",
                        "identifycode": "40418"
                      }
                    }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

6.10.1 动态卡码生成

请求参数

功能描述	此接口用于动态卡码的生成
正式环境地址	https://openapi.yazuo.com/card/generateCardCode
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
merchantNo	String	是	交易门店编号
cardNo	String	是	卡号
membershipId	Integer	是	会员id
width	Integer	是	宽度
height	Integer	是	高度

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
cardNo	String	是	卡号
cardCode	String	是	动态卡号
barCode	String	是	一维码（字节流）
QRCode	String	是	二维码（字节流）

6.10.2 动态券码生成

请求参数

功能描述	此接口用于动态券码的生成
正式环境地址	https://openapi.yazuo.com/coupon/generateCouponCode
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
couponId	String	是	券id
width	Integer	是	宽度
height	Integer	是	高度

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
cardNo	String	是	卡号
cardCode	String	是	动态卡号
barCode	String	是	一维码（字节流）
QRCode	String	是	二维码（字节流）

6.11.1 收银对接消费接口

请求参数

功能描述	调用此接口进行雅座系统会员核销
正式环境地址	https://openapi.yazuo.com/trade/consumptionCashier
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
cardNo	String	是	卡号
merchantNo	String	是	雅座门店编号
thirdMerchant	String	否	开票门店编号
cashierSerial	String	是	收银流水号
password	String	是	交易密码
cashValue	Float(10,2)	是	现金额(此处金额为扣除优惠、积分、储值外的实收现金部分)
integralValue	Float(10,2)	是	需扣除的雅座积分额
integralAmount	Float(10,2)	否	积分兑换的金额
storeValue	Float(10,2)	是	需扣除的雅座储值额
ticketInfoArray	Array	否	本次使用的雅座优惠券信息列表（id，张数，优惠金额）注:优惠金额为每张券的优惠金额，券id相同，优惠金额不同时，请单张的传 eg： "dishArray": [ ["95031", "百草素", "1", "28", "28", "0"], ["30010", "菜泡饭", "1", "25.5", "25.5", "0"], ["10059", "精美十二味碟", "1", "479.7", "480", "0"], ["20222", "蟹子鹅肝蒸蛋", "1", "22.8", "22.8", "1233"] ], 优惠金额永远为单张的金额
dishArray	Array	否	菜品列表本次消费菜品信息列表,每项包含（菜品编码,菜品中文名,菜品数量，实付金额，应付金额，券id)
payway	Integer	是	支付方式：具体值参考支付方式列表
remark	String(32)	否	备注
mobile	String(11)	否	交易手机号
source	Integer	否	交易流水来源
terminalNo	String(8)	否	雅座终端号(授权后返回)
voucherNumber	Integer	否	6位数字，用于幂等校验（非0开头）
undiscountableAmount	Float(10,2)	否	现金消费中不参与优惠金额的部分
financeDate	String	否	财务日期
settleFlag	Boolean	否	是否结清标识，默认为否
mixPayList	Array	否	支付方式明细，见下方详细说明
transOrderTime	String	否	账单创建时间

mixPayList支付方式明细说明

参数名	类型	是否必填	描述
storeAmount	BigDecimal	是	支付方式金额
payId	String	是	第三方支付id
payCode	String	否	第三方支付编码
integralFlag	Boolean	是	是否参与积分 0 不参与，1 参与
growthFlag	Boolean	否	是否送成长值
origPayCode	String	否	原始支付方式编码

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
detail	JOSNObject	是	返回明细
voucher	Integer	是	终端流水号(6个字节)

detail对象属性说明

参数名	类型	是否必填	描述
transTime	String	是	交易时间
integralBonus	Float(10,2)	是	本次积分赠送(现金消费按一定比例产生积分赠送)
storeBalance	Float(10,2)	否	当前储值卡余额
integralBalance	Float(10,2)	否	当前积分余额
couponBonus	JOSNArray	否	赠送的券列表
overflowAmount	Float(10,2)	否	储值消费现金部分

couponBonus对象属性说明

参数名	类型	是否必填	描述
couponName	String	是	券名称
availableQuantity	Integer	是	可用券张数
amount	Float(10,2)	是	券金额
startDate	String	是	有效期起始日期
endDate	String	是	有效期结束日期

6.11.2 收银撤销对接接口

请求参数

功能描述	调用此接口进行雅座系统会员核销
正式环境地址	https://openapi.yazuo.com/trade/overRevocation
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
cardNo	String	是	卡号
voucherNumber	String	是	撤销凭证
cashierSerial	String	否	收银流水号
merchantNo	String	是	门店编号
settleFlag	Boolean	否	是否推送微信消息，true推送，false不推送
voucherNoList	List	否	需要推送的相关凭证，为null时，只推送撤销的凭证信息

6.12.1 会员历史交易流水查询

请求参数

功能描述	此接口用于收银查询交易记录
正式环境地址	https://openapi.yazuo.com/card/queryHistoricalTransWaterList
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
merchantNo	String(15)	否	雅座交易门店编号
source	Integer	否	交易流水来源（xxx:雅座收银）
transCode	String(16)	否	交易类型
cashierSerial	String(64)	否	第三方订单号（收银流水号）
mobile	String	否	手机号
membershipId	Integer	否	雅座会员ID
cardNo	String	否	卡号
startTime	String	是	查询开始时间
endTime	String	是	查询结束时间

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
transwater	JOSNObject	是	返回Transwater对象列表
total	Integer	是	总页数

Transwater对象属性说明

参数名	类型	是否必填	描述
id	Long	是	交易流水ID
masterId	Long	是	主交易流水ID
voucherNo	Integer	否	凭证号
transDate	Date	是	交易时间
cardNo	String	否	交易会员卡号
cardMerchant	String	是	会员卡所属门店
transTime	Timestamp	是	交易时间
transMerchant	String	是	交易门店
transCode	String	是	交易编码
amount	BigDecimal	是	交易金额
balance	BigDecimal	是	余额
available	BigDecimal	否	可用额
mobile	String	否	会员手机号
couponsId	Long	否	券消费关联券ID
reversedflag	Boolean	是	冲正标识
revocationflag	Boolean	是	撤销标识
cashierSerial	String	是	收银流水号
terminalNo	String	是	交易终端编码
operId	String	否	操作人员
oldWaterId	Long	否	原始流水号
couponConsumeQuantity	Integer	否	券消费张数
financeDate	Date	否	财务日期
remark	String	否	备注
couponName	String	否	券名称
cardtypeId	Integer	否	卡类型ID
membershipId	Integer	是	会员ID
expansivity	BigDecimal	否	膨胀系数
brandId	Integer	是	集团id
merchantName	String	是	门店名称
transName	String	是	交易类型

6.12.2 历史交易流水查询

请求参数

功能描述	此接口用于检查已提交交易是否成功，系统只查询一日内的交易记录
正式环境地址	https://openapi.yazuo.com/card/queryTranswater
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
cardNo	String(16)	是	卡号
merchantNo	String(15)	是	雅座交易门店编号
cashierSerial	String(64)	是	第三方订单号（收银流水号）

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "cardNo": "6201310258262628",
    "merchantNo": "${merchant_no}",
    "cashierSerial": "20161230103122",
    "terminalNo": "11111111"
  }
}

返回结果示例

{
  "message": "查询成功",
  "data": {
    "transwater": [
      {
        "id": null,
        "masterId": 1214674016,
        "voucherNo": null,
        "batchNo": null,
        "transDate": "2014-05-28",
        "cardNo": null,
        "cardMerchant": "333333333333333",
        "transTime": "2014-05-28 14:38:30",
        "transMerchant": "333333333333333",
        "transCode": "0001",
        "amount": 0.00,
        "balance": 0.00,
        "available": null,
        "mobile": null,
        "couponsId": null,
        "reversedflag": null,
        "revocationflag": null,
        "cashierSerial": null,
        "terminalNo": null,
        "operId": null,
        "oldWaterId": null,
        "couponConsumeQuantity": null,
        "financeDate": null,
        "remark": null,
        "couponName": null,
        "cardtypeId": null,
        "membershipId": null,
        "expansivity": null,
        "brandId": null,
        "merchantName": "雅座上地店",
        "transName": null
      }
    ],
    "total": 1
  },
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
transwater	JOSNObject	是	返回Transwater对象列表
total	Integer	是	总页数

Transwater对象属性说明

参数名	类型	是否必填	描述
id	Long	是	交易流水ID
masterId	Long	是	主交易流水ID
voucherNo	Integer	否	凭证号
batchNo	Integer	是	批次号
transDate	Date	是	交易时间
cardNo	String	否	交易会员卡号
cardMerchant	String	是	会员卡所属门店
transTime	Timestamp	是	交易时间
transMerchant	String	是	交易门店
transCode	String	是	交易编码
amount	BigDecimal	是	交易金额
balance	BigDecimal	是	余额
available	BigDecimal	否	可用额
mobile	String	否	会员手机号
couponsId	Long	否	券消费关联券ID
reversedflag	Boolean	是	冲正标识
revocationflag	Boolean	是	撤销标识
cashierSerial	String	是	收银流水号
terminalNo	String	是	交易终端编码
operId	String	否	操作人员
oldWaterId	Long	否	原始流水号
couponConsumeQuantity	Integer	否	券消费张数
financeDate	Date	否	财务日期
remark	String	否	备注
couponName	String	否	卷名称
cardtypeId	Integer	否	卡类型ID
membershipId	Integer	是	会员ID
expansivity	BigDecimal	否	膨胀系数
brandId	Integer	是	集团id
merchantName	String	是	门店名称
transName	String	是	交易类型

6.12.3 查询交易流水菜品信息

请求参数

功能描述	查询交易流水菜品信息
正式环境地址	https://openapi.yazuo.com/card/queryHistoricalTransWaterById
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
transWaterId	Long	是	主交易流水id

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
transWaterId	String	是	交易流水id
dishId	String	是	菜品id
dishName	String	是	菜品名称
quantity	BigDecimal	是	数量
amount	BigDecimal	是	实付金额
payableAmount	BigDecimal	是	应付金额
couponId	Long	是	消费券id
batchNo	Long	是	券批次

6.13.1 动态卡码/券码/卡号/手机号查询会员卡信息【综合查询】

请求参数

功能描述	此接口用于交易会员查询
正式环境地址	https://openapi.yazuo.com/card/queryInfoByStr
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
queryStr	String	是	会员【卡号/动态卡号/动态券码/微信商家券券编码/手机号】
channel	String	否	优惠券可用渠道 999 全部渠道可用券 1000 堂食 1031 外卖 1066 有赞商城
merchantNo	String	是	交易门店编号

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
status	bool	是	返回的卡状态是否正常
message	String	是	卡状态异常时返回原因
info	JOSNObject	否	返回激活卡相关信息
benefits	JOSNObject	否	返回持卡会员权益相关规则
card	JOSNObject	否	返回Card对象
membership	JOSNObject	否	返回卡所属会员对象
couponList	JsonArray	否	返回可消费的新优惠券列表

info属性

参数名	类型	是否必填	描述
isYazuoCard	Bool	是	是否雅座卡
isTradePassword	Bool	是	是否要求交易密码
isIdNumber	Bool	是	是否要求登记证件号
cardNo	String	是	卡号
cardType	String	是	卡类型名称
cardtypeId	String	是	卡类型ID
price	Float(10,2)	否	卡售价

Membership对象属性

参数名	类型	是否必填	描述
id	Integer	是	会员ID
gender	Integer	否	会员性别
birthType	Integer	是	生日类型（阴阳历）
name	String	否	会员名称
mobile	String	否	会员手机号
birthday	Date	否	生日
merchantId	Integer	是	所属门店
email	String	否	电子邮箱
joinDate	Date	是	加入时间
status	Integer	是	状态
description	String	是	描述，备注
address	String	是	地址
idNumber	String	否	证件号码
postcode	String	否	邮政编码
phone	String	否	座机电话
typeId	Integer	否	证件类型
constellation	String	否	星座
brandId	Integer	是	集团ID
defaultCard	String	否	用户设置的默认卡
membershipLevelId	Integer	否	会员等级
membershipLevelName	Integer	否	会员等级名称
isVerified	Bool	否	是否已认证,已认证为true
benefits	JSONObject	否	会员权益
tags	JSONArray	否	会员绑定的标签下下

Card对象描述

参数名	类型	是否必填	描述
cardNo	String	是	卡号
merchantNo	String	是	卡属商户编号
activeDate	Date	是	激活时间
expiredDate	Date	否	有效期至
storeBalance	Float(10,2)	是	储值
integralBalance	Float(10,2)	是	积分额
integralAvailable	Float(10,2)	否	可用积分额
merchantId	Integer	否	商户ID
cardtypeId	Integer	否	卡类型ID
membershipId	Integer	否	会员ID
brandId	Integer	否	集团ID

benefits属性

参数名	类型	是否必填	描述
vipPrice	Bool	是	是否享受会员价权益，当为真时享受
vipDiscount	BoIntegerol	是	享受会员全单折扣价（100内整数），默认100不打折
priorityQueue	Bool	否	享受排队优先权利，当为真时享受
freeBoxFee	Bool	否	享受免包房费权利，当为真时享受
freeServiceFee	Bool	否	享受免服务费权利，当为真时享受
freePkgFee	Bool	否	享受免打包费权利，当为真时享受

tags数组元素属性

参数名	类型	是否必填	描述
id	Integer	是	标签ID
name	String	是	标签名称

Coupon对象说明

参数名	类型	是否必填	描述
id	long	是	ID
couponId	String	否	劵ID
name	String	是	名称
amount	Decimal(2,1)	是	金额(券类型为折扣券时，值为折扣率)
batchNo	Integer	是	批次号
cardNo	String	否	会员卡号（为空时券归属为会员）
mobile	String	否	手机号（为空时券归属为卡账户）
startDate	Date	否	开始时间（有效期）
expiredDate	Date	否	到期时间（有效期）
beginTime	Time	否	每天开始时间（可用周期）
endTime	Time	否	每天结束时间（可用周期）
merchantId	Integer	是	所属门店
sendTime	Timestamp	是	发送时间
sendQuantity	Integer	是	发送数量
availableQuantity	Integer	是	有效劵数量
couponCategoryId	Integer	是	券种类ID（见附表4，枚举值全场代金、全场折扣、单品代金、单品折扣、单品兑换）
startWeek	Integer	是	周使用限制（可用周期）
endWeek	Integer	是	周使用限制（可用周期）
membershipId	Integer	是	会员ID
status	Integer	是	券状态
maxAmount	Integer	是	最高优惠金额（折扣券会有）
goodsList	JOSNArray	否	菜品相关List
cost	Decimal(2,1)	否	券现金成本
couponIntegral	Decimal(2,1)	否	券积分成本
isAloneUse	Boolean	否	是否限制与其他券不同享,真为限制
brandId	Integer	是	集团ID
usageRules	JOSNArray	否	使用规则，待扩展（需第三方遍历此数组，判断ruleType等于对应规则类型，解析规则实现相应逻辑）
couponTemplateId	Long	是	券模板Id
useMaxCount	Integer	是	多张使用上限（若无上限则填0，默认为0）
superpositionCouponFlag	Boolean	是	叠加券，是否可以叠加使用，true可以叠加，false不行(规则要适配useMaxCount&usageRules)
couponSharingFlag	Boolean	是	是否与其他优惠券共享，false不共享，true共享
couponEquityList	List	是	优惠券线下权益集合
equityFlag	Boolean	是	是否权益券
equityCount	Integer	否	权益券当前可使用次数
equityCountByDay	Integer	否	券当前周期内可使用次数
channelIdList	List	否	券渠道信息，为null则所有渠道可用
applySenseCode	Integer	否	券投放途径
applySenseCon	String	否	券投放途径中文描述
applyMerchants	List	否	券可使用门店名称
otherCouponLogo	String	否	第三方券模板logo
otherCouponLogo2	String	否	第三方券模板logo2

usageRules对象属性说明

参数名	类型	是否必填	描述
ruleType	String	是	使用限制规则类型
operator	String	是	使用值操作类型，取值现包括（“EQ” 等于 “NEQ” 不等于 “GT” 大于 “LT” 小于 “IN” 列表中 “BETWEEN” 介于）
values	String	是	规则取值，根据操作符不同设置不同值（“EQ”、“NEQ”、“GT”和“LT” 返回单个数值； “IN” 返回逗号分割的数字串； “BETWEEN” 返回逗号分隔的两个数字）

当前可使用的规则类型

ruleType	描述
baseRuleAmount	最低消费限额，对应values取值为数值类型
couponExclusive	最低消费限额，对应values取值为数值类型

goodsList象属性说明

参数名	类型	是否必填	描述
id	Integer	是	主键
batchNo	Integer	是	券批次号
usedType	Sting	是	菜品设置类型（1-关联菜品/品类 2-不参与菜品/品类 3-消费菜品/品类）
goodsType	Sting	是	菜品类型（1-菜品 2-品类）
goodsId	Integer	是	菜品/品类id
goodsName	String	是	菜品/品类名称
quantity	Integer	否	消费菜品数量（菜品设置类型为3是适用

applyMerchants对象属性说明

参数名	类型	是否必填	描述
merchantId	Integer	否	门店id
merchantName	String	否	门店名称

API内主要业务逻辑

入参组合情况	场景举例	业务处理逻辑
入参为卡码[YZ开头]	会员出示动态卡码	解析卡码为卡号,返回以上全部信息
入参为券码[QM开头]	会员出示动态券码	解析卡码为券id,返回券信息（包含默认卡号信息）
入参为卡号[other]	会员报卡号	返回以上全部信息
入参为手机号[1开头11位数字]	会员报手机号	返回会员信息包含默认卡号信息）

6.13.2 根据动态券码查询会员，默认卡号，券信息

请求参数

功能描述	根据动态券码查询会员，默认卡号，券信息。非手机券的话，返回的卡号信息为券所属卡号信息
正式环境地址	https://openapi.yazuo.com/coupon/queryMemberInfoByGenerateCouponCode
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
generateCouponCode	String	是	动态券码
merchantNo	String	是	门店编号

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
status	bool	是	返回的卡状态是否正常
message	String	否	卡状态异常时返回原因
card	JOSNObject	否	返回Card对象列表
membership	JOSNObject	否	会员对象
couponList	JOSNObject	否	返回查询的优惠券信息

Membership对象属性

参数名	类型	是否必填	描述
id	Integer	是	会员ID
gender	Integer	否	会员性别
birthType	Integer	是	生日类型(1-阳历 2-阴历)
name	String	否	会员名称
mobile	String	否	会员手机号
birthday	Date	否	生日
merchantId	Integer	是	所属门店
email	String	否	电子邮箱
joinDate	Date	是	加入时间
status	Integer	是	状态
description	String	是	描述、备注
address	String	是	地址
idNumber	String	否	证件号码
postcode	String	否	邮政编码
phone	String	否	座机电话
typeid	String	否	证件类型
constellation	String	否	星座
microMessageId	String	否	微信id
brandId	Integer	是	集团ID
defaultCard	String	否	用户设置的默认卡
membershipLevelId	Integer	否	会员等级
membershipLevelName	Integer	否	会员等级名称
isVerified	Bool	否	是否已认证,已认证为true
benefits	JSONObject	否	会员权益
tags	JSONArray	否	会员绑定的标签

Card对象描述

参数名	类型	是否必填	描述
cardNo	String	是	卡号
merchantNo	String	是	卡属商户编号
activeDate	Date	是	激活时间
expiredDate	Date	否	有效期至
storeBalance	Float(10,2)	是	储值
integralBalance	Float(10,2)	是	积分额
integralAvailable	Float(10,2)	是	可用积分额
merchantId	Integer	是	商户ID
cardtypeId	Integer	否	卡类型ID
membershipId	Integer	是	会员ID
brandId	Integer	是	集团ID

Coupon对象说明

参数名	类型	是否必填	描述
id	Long	是	ID
couponId	String	否	券ID
name	String	是	名称
amount	Decimal(2,1)	是	金额(券类型为折扣券时，值为折扣率)
batchNo	Integer	是	批次号
cardNo	String	否	会员卡号
mobile	String	否	手机号
startDate	Date	是	开始时间（有效期）
expiredDate	Date	是	到期时间（有效期）
beginTime	Time	否	每天开始时间（可用周期）
endTime	Time	否	每天结束时间（可用周期）
merchantId	Integer	是	所属门店
sendTime	Timestamp	是	发送时间
sendQuantity	Integer	是	发送数量
availableQuantity	Integer	是	有效劵数量
couponCategoryId	Integer	是	券种类ID（见附表4）
startWeek	Integer	否	周使用限制（可用周期）
endWeek	Integer	否	周使用限制（可用周期）
membershipId	Integer	否	会员ID
status	Integer	是	券状态
maxAmount	Decimal(2,1)	否	最高优惠金额（折扣券会有）
goodsList	JOSNArray	是	菜品相关List
cost	Decimal(2,1)	否	券现金成本
couponIntegral	Integer	否	券积分成本
aloneUse	Boolean	否	是否限制与其他券不同享,真为限制
brandId	long	是	集团ID
usageRules	JOSNArray	否	使用规则，待扩展（需第三方遍历此数组，判断ruleType等于对应规则类型，解析规则实现相应逻辑）
useMaxCount	Integer	是	多张使用上限（若无上限则填0，默认为0）
couponSharingFlag	Boolean	是	是否与其他优惠券共享，false不共享，true共享
applySenseCode	Integer	否	券投放途径
applySenseCon	String	否	券投放途径中文描述
applyMerchants	List	否	券可使用门店名称
otherCouponLogo	String	否	第三方券模板logo
otherCouponLogo2	String	否	第三方券模板logo2

usageRules对象属性说明

参数名	类型	是否必填	描述
ruleType	String	是	使用限制规则类型
operator	String	是	使用值操作类型，取值现包括（“EQ” 等于 “NEQ” 不等于 “GT” 大于 “LT” 小于 “IN” 列表中 “BETWEEN” 介于）
values	String	是	规则取值，根据操作符不同设置不同值（“EQ”、“NEQ”、“GT”和“LT” 返回单个数值； “IN” 返回逗号分割的数字串； “BETWEEN” 返回逗号分隔的两个数字）

当前可使用的规则类型

ruleType	描述
baseRuleAmount	最低消费限额，对应values取值为数值类型
couponExclusive	最低消费限额，对应values取值为数值类型

goodsList对象属性说明

参数名	类型	是否必填	描述
id	Integer	是	主键
batchNo	Integer	是	券批次号
usedType	Integer	是	菜品设置类型（1-关联菜品/品类 2-不参与菜品/品类 3-消费菜品/品类）
goodsType	Integer	是	菜品类型（1-菜品 2-品类 3-套餐）
goodsId	Integer	是	菜品/品类id
goodsName	String	是	菜品/品类名称
quantity	Integer	否	消费菜品数量（菜品设置类型为3是适用

applyMerchants对象属性说明

参数名	类型	是否必填	描述
merchantId	Integer	否	门店id
merchantName	String	否	门店名称

6.13.3 预咨询券(储值、积分)接口

请求参数

功能描述	调用此接口进行雅座系统资产预咨询
正式环境地址	https://openapi.yazuo.com/coupon/intelligentSelectCoupon
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
cardNo	String	是	卡号(动态卡码、卡号)
merchantNo	String	是	雅座门店编号（交易门店）
integralExchange	Boolean	否	是否使用积分抵现（是的话会在出参返回最多可用的积分额），不传默认为否
cardNo	Boolean	否	是否使用储值消费（是的话会在出参返回最多可用的储值额），不传默认为否
cardNo	Boolean	否	是否已享受POS侧活动，不传默认为否
billAmount	Decimal(2,1)	是	可参与优惠的订单金额
billDish	JOSNArray	是	可参与优惠的菜品集合
dishFirst	String	否	优先核销的菜品编号（键位菜品，暂不支持品类和套餐），不传默认无（重复菜品不在billDIsh传）
billState	Integer	否	标识当前账单使用场景,默认填0
couponLimit	Integer	否	标识限制返回券的数量,-1不限制，默认填-1

billDish对象属性说明

参数名	类型	是否必填	描述
dishNo	String	是	菜品编号
dishType	Integer	是	菜品类型（1-菜品 2-品类 3-套餐）
dishName	String	是	菜品名称
dishPrice	Decimal(2,1)	是	菜品价格
dishCount	Integer	是	菜品数量
memberShipPrice	Decimal(2,1)	否	会员价(单道菜品的会员价)
isSendIntegral	Boolean	是	是否赠送积分（单道菜的属性）

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext":
                      {
                        "brandId": "${brand_id}",
                        "merchant":
                            {
                             "merchantNo":"6201310258262628"
                            }
                        "merchantNo": "6201310258262628",
                        "cardNo": "6201305992560138",
                        "integralExchange": null,
                        "useStore": false,
                        "posActive": false,
                        "billAmount": 45.8,
                        "dishFirst": null,
                        "billState": 0,
                        "couponLimit": -1,
                        "billDish":
                            [{
                                "dishNo": "13425",
                                "dishType": 1,
                                "dishName": "千张牛肉粉丝汤+雄霸有料粽（热/剥）",
                                "dishPrice": 22.9,
                                "dishCount": 2,
                                "memberShipPrice": null,
                                "isSendIntegral": true
                            }]
                      }
                    }

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
detail	JOSNObject	是	返回明细

detail对象属性说明

参数名	类型	是否必填	描述
storeAvalaible	Decimal(2,1)	是	当前可用储值额
integralAvaliable	Decimal(2,1)	是	当前可用积分积分额
integralAsCash	Bool	是	是否限制积分抵钱使用（调用组合消费接口中可以使用积分结账），当为真时限制
integralExchangeRate	Integer	是	多少积分抵扣一元
billDish	JOSNArray	是	预咨询后的菜品列表
integeralLimitAmount	Decimal(2,1)	否	不参与积分赠送金额
couponUse	JOSNArray	是	咨询后的券列表
memberPriceDiscount	Decimal(2,1)	否	会员价优惠金额

couponUse对象属性说明

参数名	类型	是否必填	描述
couponId	Integer	是	券id
couponType	Integer	是	券类型
couponAmount	Decimal(2,1)	是	券面额
couponName	String	是	券名称
amount	Decimal(2,1)	是	优惠金额
cousumeAmount	Decimal(2,1)	是	消费金额门槛
effectiveDate	Date	是	券生效时间
expiredDate	Date	是	券到期时间
cashAmount	Decimal(2,1)	否	现金成本
integralAmount	Decimal(2,1)	否	积分成本
disCountDish	String	否	核销菜品编号
disCountDishName	String	否	核销菜品名称
disCountDishType	Integer	否	核销产品类型（1-菜品 2-品类 3-套餐）

billDish对象属性说明

参数名	类型	是否必填	描述
dishNo	String	是	菜品编号
dishType	Integer	是	菜品类型(1-菜品 2-品类 3-套餐)
dishName	String	是	菜品名称
dishPrice	Decimal(2,1)	是	菜品价格
dishCount	Integer	是	菜品数量
dishPay	Decimal(2,1)	是	菜品实付价格

6.14 左庭右院单卡单券接口

请求参数

功能描述	此接口用于左庭右院单卡单券查询
正式环境地址	https://openapi.yazuo.com/card/queryCardByTransTime
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
membershipId	int	是	会员ID

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "${brand_id}",
    "membershipId": 30110501
  }
}

返回结果示例

{
  "message": "查询卡成功",
  "data": {
    "card": {
        "cardNo": "6201300193506808",
        "merchantNo": "666660000000021",
        "activeDate": 1397145600000,
        "expiredDate": null,
        "storeBalance": 0,
        "integralBalance": 0,
        "integralAvailable": 0,
        "merchantId": 15,
        "cardtypeId": null,
        "membershipId": 11671221,
        "brandId": 15
      },
      "coupon":{
        "id": 118284632,
        "name": "20元代金券",
        "amount": 20,
        "batchNo": 793141,
        "cardNo": "6201301116950968",
        "startDate": "2016-10-18",
        "expiredDate": "2016-10-31",
        "beginTime": "1970-01-01",
        "endTime": "1970-01-01",
        "source": "sop",
        "merchantId": 243,
        "scope": 2,
        "status": 1,
        "sendTime": "2016-10-18",
        "sendQuantity": 1,
        "availableQuantity": 1,
        "couponCategoryId": 1,
        "startWeek": 1,
        "endWeek": 7,
        "membershipId": 27370591,
        "brandId": 243,
        "couponBeginUse": true,
        "couponExpired": false,
        "useTime": true,
        "isAloneUse": false,
        "usageRules": [
          {
            "ruleType": "baseRuleAmount",
            "operator": "GT",
            "values": "100"
          },
          {
            "ruleType": "couponExclusive",
            "operator": "IN",
            "values": "793128,793140"
          }
        ]
      }
    }
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
data	JOSNObject	是	返回Card对象列表

Card对象描述

参数名	类型	是否必填	描述
cardNo	String	是	卡号
merchantNo	String	是	卡属商户编号
activeDate	Date	是	激活时间
expiredDate	Date	否	有效期至
storeBalance	Float(10,2)	是	储值
integralBalance	Float(10,2)	是	积分额
integralAvailable	Float(10,2)	是	可用积分额
merchantId	Integer	是	商户ID
cardtypeId	Integer	否	卡类型ID
membershipId	Integer	是	会员ID
brandId	Integer	是	集团ID

Coupon对象说明

参数名	类型	是否必填	描述
id	Long	是	ID
couponId	String	否	劵ID
name	String	是	名称
amount	Float(10,2)	是	金额
batchNo	Integer	是	批次号
cardNo	String	否	会员卡号
mobile	String	否	手机号
startDate	Date	是	开始时间
expiredDate	Date	是	到期时间
beginTime	Time	否	每天开始时间
endTime	Time	否	每天结束时间
merchantId	Integer	是	所属门店
sendTime	Timestamp	是	发送时间
sendQuantity	Integer	是	发送数量
availableQuantity	Integer	是	有效劵数量
couponCategoryId	Integer	是	券种类ID（见附表4）
startWeek	Integer	否	周使用限制
endWeek	Integer	否	周使用限制
membershipId	Integer	否	会员ID
isShare	Boolean	否	是否优惠同享，如否时支付宝接口传递禁止优惠同享（收银方判断）
isAloneUse	Boolean	否	是否限制与其他券不同享,真为限制
brandId	Integer	是	集团ID
dishNo	String	否	菜品券时对应菜品编号
usageRules	JOSNArray	否	使用规则，待扩展（需第三方遍历此数组，判断ruleType等于对应规则类型，解析规则实现相应逻辑）

usageRules对象属性说明

参数名	类型	是否必填	描述
ruleType	String	是	使用限制规则类型
operator	Sting	是	使用值操作类型，取值现包括（“EQ” 等于 “NEQ” 不等于 “GT” 大于 “LT” 小于 “IN” 列表中 “BETWEEN” 介于）
values	String	是	规则取值，根据操作符不同设置不同值（“EQ”、“NEQ”、“GT”和“LT” 返回单个数值； “IN” 返回逗号分割的数字串； “BETWEEN” 返回逗号分隔的两个数字）

当前可使用的规则类型

ruleType	描述
baseRuleAmount	最低消费限额，对应values取值为数值类型
couponExclusive	不可同时使用的券,对应Values取值为逗号分隔的券批次号

6.15 储值霸王餐

请求参数

功能描述	此接口用于储值卡充值
正式环境地址	https://openapi.yazuo.com/trade/cardRechargeActive
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)
cardNo	String(16)	是	卡号
merchantNo	String(15)	是	雅座交易门店编号
terminalNo	String(8)	是	雅座终端号
cashierSerial	String(64)	是	第三方订单号（收银流水号）
storeNumber	Float(10,2)	是	总计储值额
orderAmount	Float(10,2)	是	账单消费金额
payWays	JOSNArray	是	支付方式明细

payways 数组属性

参数名	类型	是否必填	描述
id	Integer	是	支付方式ID：具体值参考支付方式列表
value	Float(10,2)	是	单项支付金额

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext": {
                        "brandId": "${brand_id}",
                        "cardNo": "6201310258262628",
                        "merchantNo": "${merchant_no}",
                        "cashierSerial": "20161230103122",
                        "terminalNo": "11111111",
                        "storeNumber": 100,
                        "payWays":[{
                                "id":"1",
                                "value":100
                        }]

                      }
                    }

返回结果示例

                    
                    {
                        "message": "SUCCESS",
                        "data": {
                            "voucher":899094,
                            "totalStore":110,
                            "details": {
                                "transTime": "11:00:00",
                                "cardNo": "6201200537637618",
                                "storeBalance": "110",
                                "integralBalance": "0",
                                "storeBonus": "10",
                                "integralBonus": "10",
                                "couponBonus":[{
                                    "id": "9821311",
                                    "couponName": "代金券",
                                    "amount": "10.00",
                                    "startDate": "2016-09-01",
                                    "endDate": "2016-09-30"
                                }]
                            }
                        },
                         "code":0
                    }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JOSNObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
totalStore	Float(10,2)	是	总储值额
voucher	Integer	是	终端流水号(6个字节)
details	JOSNObject	是	储值结果详情

detail对象属性说明

参数名	类型	是否必填	描述
transTime	String	是	交易时间
storeBonus	Float(10,2)	是	本次储值增送额
integralBonus	Float(10,2)	否	本次积分赠送额
storeBalance	Float(10,2)	是	当前储值卡余额
integralBalance	Float(10,2)	是	当前积分余额
couponBonus	JOSNArray	否	赠送的券列表

6.16 授权码获取接口

请求参数

功能描述	扫码领取时传输授权码，接口只可访问一次
正式环境地址	https://openapi.yazuo.com/coupon/getDisposableSecretKey
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)【授权返回的】
merchantId	String	是	所属雅座门店ID【授权返回的】
orderId	String	是	订单id(唯一)

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext": {
                        "brandId": "${brand_id}",
                        "merchantId": "${merchant_id}",
                        "orderId": "${order_id}"
                      }
                    }

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	0 成功 1 失败 2 已验证过
message	String	是	返回消息内容
data	String	是	授权code {warranty}

6.17 会员卡安全码验证

请求参数

功能描述	此接口用于会员卡安全码验证
正式环境地址	https://openapi.yazuo.com/card/checkCardPassword
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
cardNo	String(16)	是	卡号

参数请求示例

                    
                    {
                      "access_token": "${access_token}",
                      "ciphertext":
                      {
                        "brandId": "${brand_id}",
                        "cardNo": "6201200562333628"
                      }
                    }

返回结果示例

                    
                    {
                      "code": 0,
                      "message": "请求成功"
                      "data":
                      {

                        "password": null
                      }
                    }

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
password	JOSNObject	是	安全码

6.18 获取会员订单信息接口

请求参数

功能描述	获取会员订单信息
正式环境地址	https://openapi.yazuo.com/card/queryHistoricalTransWaterOrderList
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

couponId

参数名	类型	是否必填	描述
brandId	long	是	集团ID(用于校验)【授权返回的】
merchantNo	String(15)	是	雅座交易门店编号
source	String	否	交易流水来源（xxx:雅座收银）
transCode	String(16)	否	交易类型
cashierSerial	String(64)	否	第三方订单号（收银流水号）
mobile	String	否	手机号
membershipId	Integer	否	雅座会员ID
cardNo	String	否	卡号
startTime	String	是	查询开始时间
endTime	String	是	查询结束时间

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
merchantNo	Integer	是	交易门店
transWaterId	String	是	交易流水id
transDate	BigDecimal	是	交易日期
merchantName	BigDecimal	是	交易门店名称
transAmount	BigDecimal	是	交易金额
couponAmount	BigDecimal	是	券消费
integralAmount	BigDecimal	是	积分消费
storeAmount	BigDecimal	是	储值消费
cashAmount	BigDecimal	是	现金消费

6.19 第三方收银同步支付接口

请求参数

功能描述	此接口用于第三方收银将支付方式同步给雅座
正式环境地址	https://openapi.yazuo.com/trade/addOrUpdatePayMode
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
mixPayList	List	是	支付列表
payId	Integer	是	第三方支付方式id
payName	String	是	支付方式名称
status	Short	是	状态(是否启用1：正常， 0：禁用)
isIntegral	Integer	否	是否赠送积分
isCalGrowth	Integer	否	是否正式成长值
payType	Integer	否	支付类型
payCode	Integer	否	支付编码
isIncome	Integer	是	是否实收(1:实收 0:虚收)

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	是否必填	描述
data	String	是	链接

6.20 已结账单的支付方式变更

请求参数

功能描述	此接口用于第三方收银将已结的账单的支付方式变更
正式环境地址	https://openapi.yazuo.com/trade/transWaterUpdatePayMode
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
cardNo	String	是	卡号
voucherNo	String	是	终端流水号
cashierSerial	String	是	收银流水号
merchantNo	String	是	雅座门店编号
payway	String	是	支付方式：具体值参考支付方式列表
mixPayList	String	是	支付方式列表

mixPayList属性说明

参数名	类型	是否必填	描述
storeAmount	BigDecimal	是	支付方式金额
payId	String	是	第三方支付id
payCode	String	否	第三方支付编码
integralFlag	Boolean	否	是否参与积分(0:不参与 1:参与)
growthFlag	Boolean	否	是否送成长值
origPayCode	String	否	原始支付方式编码

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

6.21 消费明细同步

请求参数

功能描述	同步第三方订单信息
正式环境地址	https://openapi.yazuo.com/order/syncThirdpartyOrder
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
orderId	String(64)	是	第三方账单ID
orderTime	String(16)	是	订单时间，YYYY-mm-dd HH:ii:ss 格式
totalPrice	Float(12,2)	是	总价(原价)
receivePrice	Float(12,2)	是	实收价格
discountPrice	Float(12,2)	否	折扣价格
mobile	String(11)	否	手机号，mobile和open_id其中之一必填
openId	String(64)	否	OPENID
tableNo	String(32)	否	桌台号
people	Integer	是	消费人数
payWays	Json	是	支付渠道
discount	Json	否	折扣明细
dishList	Json	是	菜品明细
thirdMerchantNo	String(64)	否	第三方交易门店编号（使用前需联系雅座开发人员配置对应关系）
merchantId	Integer	否	雅座商户ID（和thirdMerchantNo至少要有设置一项）
status	Integer	是	订单状态
description	String(512)	否	备注
membershipId	Integer	否	会员ID
source	Integer	否	订单来源（见附属字典表）

dishList（嵌套）属性

参数名	类型	是否必填	描述
dishCode	String	是	菜品ID
dishName	String	是	菜品名称
price	Float(10,2)	是	菜品销售价格
num	Integer	是	点菜数量

payways(嵌套)属性

参数名	类型	是否必填	描述
payPrice	Float(12,2)	是	支付金额
payWay	String(32)	是	支付方式

discount(嵌套)属性

参数名	类型	是否必填	描述
name	String(32)	是	优惠名称
price	Float(12,2)	是	优惠金额

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "orderId": "201612010000000000001",
    "orderTime": "2016-10-19 20:10:58",
    "totalPrice": 369.12,
    "receivePrice": "369.00",
    "discountPrice": "36.36",
    "mobile": "18310104695",
    "openId": "oCd87w1UjSD4Ieqw6p63PJ11eEi8",
    "tableNo": 1,
    "people": 5,
    "payWays": [
      {
        "payPrice": 48,
        "payWay": 2
      }
    ],
    "discount": [
      {
        "name": "全单折扣",
        "price": 10
      }
    ],
    "dishList": [
      {
        "dishCode": "CES000001",
        "dishName": "麻辣鱼块",
        "price": 15,
        "num": 2
      }
    ],
    "thirdMerchantNo": "MD000000001",
    "status": "1",
    "description": "",
    "membershipId": ""
  }
}

返回结果示例

{
  "message": "查询成功",
  "code": 0
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容

6.22 开放平台日结接口

请求参数

功能描述	根据传入的日结时间,实时更新报表数据
正式环境地址	https://openapi.yazuo.com/report/settlementDay
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	Integer	是	集团ID(用于校验)
merchantId	Integer	是	门店ID
merchantNo	String	是	门店编码
settlementDate	Date	是	日结日期

返回参数说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

6.23 新辣道储值提成接口

请求参数

功能描述	此接口用于新辣道获取储值提成数据
正式环境地址	https://openapi.yazuo.com/merchant/getBonusData
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
merchantId	String	是	门店ID
date	String	是	获取日期

参数请求示例

{
  "access_token": "${access_token}",
  "ciphertext": {
    "merchantId": "0000",
    "date": "20171226"
    }
}

返回结果示例

{
    "code": 0,
    "message": "获取数据成功",
    "data": {
        "list": [
            {
                "dtfinish": "2017-12-26",
                "orderno": ""YZ_AWP_5_2017122611355346059702"",
                "dtcreate": "2017-12-26",
                "producttype": 5,
                "mcid": "0000",
                "employeeno": 93,
                "totalamount": 9
            }
        ]
    }
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	JsonObject	否	成功返回相关数据

data（嵌套）属性

参数名	类型	可为空	描述
dtfinish	Date	是	操作完成时间
orderno	String	是	订单号
dtcreate	Date	是	操作开始时间
producttype	Integer	是	操作类型：5充值，7办卡
mcid	Integer	是	门店号
employeeno	String	是	操作员编号
totalamount	BigDecimal	是	充值金额

6.24 新扫码领券接口

请求参数

功能描述	扫码领取时传输授权码，接口只可访问一次
正式环境地址	https://openapi.yazuo.com/lottery/addCouponByScan/signDisposableSecretKey.do
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	int	是	集团ID(用于校验)【授权返回】
areaId	int	是	所属域ID【雅座线下提供】
activityId	int	是	活动id【雅座线下提供】
warranty	string	是	授权码【接口获取】

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	String	是	授权code {warranty}

6.25 生成微信商家券券编码

请求参数

功能描述	此接口用于获取微信商家券券编码
正式环境地址	https://openapi.yazuo.com/coupon/generateWeChatPayMerchantCouponsCouponCode
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	String	是	集团ID
couponTemplateId	Integer	是	雅座券模板id

参数请求示例


  {
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "180276161",
    "merchantId":"180276180",
    "couponTemplateId":57652
  }
}

返回结果示例


{
    "code": 0,
    "message": "请求成功",
    "data": "WCPMC005765220210203133504665739"
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	String	否	成功返回相关数据（券编码）

6.26 根据雅座券批次号查询商家券的微信批次号

请求参数

功能描述	根据雅座券批次号查询商家券的微信批次号
正式环境地址	https://openapi.yazuo.com/coupon/getWechatCouponByBatchNos
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	String	是	集团ID(用于校验)
yazuoBatchNos[]	Integer	是	雅座券批次号 (传数组)

参数请求示例


{
"access_token": "${access_token}",
"ciphertext": {
"brandId": "180276161",
"yazuoBatchNos":[180276180,180276181]
}
}

返回结果示例


{
"code": 0,
"message": "雅座券批次号查询商家券的微信批次号成功",
"data": {"wechatBatchNos":[{"yazuoBatchNo":180276180,"wechatBatchNo":180276161},...]}
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	String	否	成功返回相关数据

7 附录

7 其他

7.1 查询jsapi_ticket

请求参数

功能描述	此接口用于获取商户公众号的jsapi_ticket
正式环境地址	https://openapi.yazuo.com/weixin/queryJsApiTicket
method	POST
Content_Type	application/json
返回值	JSON

请求参数说明

参数名	类型	是否必填	描述
brandId	String	是	集团ID
officialAccountAppId	String	是	公众号appId

参数请求示例


  {
  "access_token": "${access_token}",
  "ciphertext": {
    "brandId": "180276161",
    "merchantId":"180276180",
    "officialAccountAppId":"XXXX"
  }
}

返回结果示例


{
    "code": 0,
    "message": "请求成功",
    "data": "XXXXX"
}

返回值说明

参数名	类型	是否必填	描述
code	Integer	是	错误码，0正常具体见附表错误码列表
message	String	是	返回消息内容
data	String	否	成功返回相关数据（ticket）

8 附录

错误码列表

错误码	含义
0	接口调用成功
1	参数不合法
40001	参数不完整，必填项校验失败
40002	用户未授权该API
40003	解析JSON/XML内容错误，不符合参数要求
40004	内部服务异常
40007	密码不正确
40008	API网关访问失败
40009	不存在消息内容
40010	卡不存在或非本公司卡
40011	会员卡被冻结
40012	该卡已挂失
40013	该卡已作废
40018	业务校验异常
42001	网关参数验证错误
42002	网关接口参数验证失败,不是有效的JSON数据格式
42003	API网关解析接口响应失败
42004	API网关访问失败
42005	API网关调用接口失败
50001	系统错误

支付方式列表

方式	含义
1	现金
2	支付宝
3	银行卡
4	支票
5	其它
6	微信

证件类型列表

类型	意义
1	身份证
2	军官证
3	护照
4	警官证
5	其他

优惠券类型列表

类型	意义
1	现金券
2	团购券
3	微信商城劵
5	支付宝代金券
7	菜品券
8	支付宝折扣券
9	支付宝兑换券
10	支付宝单品代金券
11	免单券
12	折扣券
13	单品折扣券
14	单品兑换券

订单来源渠道定义

来源	意义
1	堂食
2	美团外卖
3	百度外卖
4	饿了么外卖
9	其他

券投放途径定义

途径	定义
0	无门槛
1	商城售卖
2	储值送券
3	消费送券
4	抖音售卖
5	外卖运费

8 API更新日志

更新接口	変更类型	更新说明
接口连接	新增/修改	接口名称