企迈云-开放平台

API 2.0

API 2.0 > 7.7 会员交易 > 7.7.3 会员交易预览接口

7.7.3 会员交易预览接口

开启令牌和权限后可调用。签名方式请查看开发指南

场景描述：根据商品和优惠券，余额预览消费

餐饮

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	user.consume-preview	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	默认值	描述
user_coupon_id	string	否		兼容用戶优惠券ID 【对应会员详情中的cardId】，和核销码
user_id	string	否		用户id，当user_coupon_id 是扫码核销码时user_id 非必传，其他情况下user_id必传
items	array	否
├0	array	否
├num	string	是		商品数量
├trade_mark	string	是		商品实体标识
├price	string	是		商品实体金额元
multi_mark	string	是		门店编码
coupon_id	string	否		优惠券模板
type_cate	string	是		就餐方式,1堂食,3外卖
discount_price	string	是		订单折扣金额元
type	int	否		type=1时user_coupon_id 填核销码
is_use_balance	int	是	0	是否使用余额 1使用 0不使用
phone	string	是		手机号
use_balance	string	否		is_use_balance为1时，必填，使用余额金额数

响应参数

参数	参数类型	描述
status	bool	成功或失败标识
code	int	成功失败状态
message	string	描述
data	array
├type_cate	string	就餐方式,1堂食,2自取,3外卖
├multi_mark	string	门店编码
├coupon_discount	string	优惠券优惠掉的金额
├user_coupon_name	string	优惠券名称当type=1时user_coupon_id 填核销码此参数才会返回
├user_coupon_id	string	用户优惠券id 对应会员三合一接口中的cardId 当type=1时user_coupon_id 填核销码此参数才会返回
├finance_payment	string	财务支付金额当type=1时user_coupon_id 填核销码此参数才会返回
├balance_pay	string	余额需要扣减金额元
├money_pay	string	现金需要扣减金额元

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "user.consume-preview",
    "Params": {
        "user_coupon_id": "",
        "user_id": "",
        "items": [
            {
                "num": "",
                "trade_mark": "",
                "price": ""
            }
        ],
        "multi_mark": "",
        "coupon_id": "",
        "type_cate": "",
        "discount_price": "",
        "type": "",
        "is_use_balance": "",
        "phone": "",
        "use_balance": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "type_cate": "",
        "multi_mark": "",
        "coupon_discount": "",
        "user_coupon_name": "",
        "user_coupon_id": "",
        "finance_payment": "",
        "balance_pay": "",
        "money_pay": ""
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}