龙收银开放平台标准API接口文档

openapi


用户全量获取券信息接口

简要描述:

  • 用户全量获取券(本地优惠券,不包含抖音券等第三方)信息接口

请求URL:

  • http://192.168.12.67/s1/openapi/openapi/base/arch/completepullarchinfo

请求方式:

  • POST

请求类型:

  • application/json

加密类型:

  • RSA

    请求示例

  {
    "ispInfoId": 10001,
    "data":
"hJOx8SJeNp8Yb2Pn+1EuHJ4QPy0FlwVawCcYtXb8Af+j+3sv8jtYAHebjbqr56wvfATPiF6xSGBWVTNLwMK2MENSSuYnTXaVLJwZQ27r20TrL25Xh5Rvc0kukDJ97sDKMYfuu+mNG+C/fdhW2xgHDyCWz3Jtl+n/3GP8nJtbNZk="
  }

data请求参数说明:

参数名 必选 类型 说明
centerId Integer 集团ID
type Integer 1:商品 2:商品类别 3:单位 4:套餐 5:券 6:支付方式 7:营销活动
limit Integer 每页显示条数
page Integer 当前页数

返回示例

  {
    "result": 0,
    "msg": "请求成功",
    "code": "0",
    "errorMsg": "",
    "data":
"hJOx8SJeNp8Yb2Pn+1EuHJ4QPy0FlwVawCcYtXb8Af+j+3sv8jtYAHebjbqr56wvfATPiF6xSGBWVTNLwMK2MENSSuYnTXaVLJwZQ27r20TrL25Xh5Rvc0kukDJ97sDKMYfuu+mNG+C/fdhW2xgHDyCWz3Jtl+n/3GP8nJtbNZk="
  }

返回示例

  {
    "result": 0,
    "msg": "请求成功",
    "code": "0",
    "errorMsg": "",
    "data":
            "{
              "data": {
                "page": 1,
                "limit": 10,
                "count": 1,
                "itemList": [
                  {
                    "id": "599235939333603328",
                    "name": "开放平台测试券",
                    "createShopId": 10494,
                    "isEnable": true,
                    "beginDay": "2021-05-12 00:00:00",
                    "endDay": "2021-05-31 23:59:59",
                    "isAllShop": true,
                    "isAllItem": false,
                    "isShiftLimit": true,
                    "isWeekLimit": true,
                    "isParticularDateLimit": true,
                    "fullMoney": 10.0,
                    "offMoney": 100.0,
                    "isRecordincome": false,
                    "ratio": 0.0,
                    "limitCount": 1,
                    "itemList": [
                      {
                        "id": "1049400000000000208",
                        "name": "测试品相",
                        "unitName": "例"
                      },
                      {
                        "id": "1049400000000000001",
                        "name": "打包盒",
                        "unitName": "个"
                      }
                    ],
                    "shopList": [

                    ],
                    "pDateList": [
                      "2021-05-27 00:00:00"
                    ],
                    "shiftList": [
                      {
                        "startTime": "1970-01-01 09:00:00",
                        "endTime": "1970-01-01 09:00:00"
                      }
                    ],
                    "weekList": [
                      1,
                      2,
                      3
                    ]
                  }
                ]
              },
              "result": 0,
              "success": true
            }"
    }

返回参数说明

参数名 类型 说明
result int 状态(0-成功,-1-失败)
msg String 调用成功返回信息)
code String 调用结果Code
errorMsg String 错误信息
data String 返回数据(加密后)

data

参数名 类型 说明
page Integer 当前页数
limit Integer 每页显示条数
count Integer 总条数
itemList List<MarketingTickeInfoVo> 内容

MarketingTickeInfoVo

参数名 类型 说明
id Long 券ID
name String 券名称
isEnable Boolean 是否启用
beginDay Date 活动开始时间
endDay Date 活动结束时间
isAllShop Boolean 是否全部店应用
isAllItem Boolean 是否全部品项应用
isShiftLimit Boolean 是否进行时间段限制
isWeekLimit Boolean 是否进行星期限制
isParticularDateLimit Boolean 是否进行日期范围限制
createShopId Long 创建店铺id
createTime Date 创建时间
creatorId Long 创建人id
delflg Integer 删除标记 0:使用 1:删除
vipAvailable Integer 会员专项类型
fullMoney BigDecimal 消费满足条件
offMoney BigDecimal 劵面额金额
isRecordincome Boolean 是否计入收入
ratio Boolean 折现率
limitCount Integer 单次限制使用劵张数
itemList List<NotShowItemVo> 不参加活动的菜品
shopList List<ShowShopVo> 使用门店范围
shiftList List<TicketShiftVo> 有效时间段
weekList List<Integer> 有效星期
pDateList List<Date> 排除在外的日期

NotShowItemVo

参数名 类型 说明
id Long 菜品ID
name String 菜品名称
unitName String 菜品单位

ShowShopVo

参数名 类型 说明
id Integer 店铺ID
name String 铺名称

TicketShiftVo

参数名 类型 说明
startTime Date 设定每日使用的开始时间范围
endTime Date 设定每日使用的结束时间范围

备注

  • 更多返回错误代码请看首页的错误代码描述

页面列表

ITEM_HTML