目录
3.3外部平台券
3.2.28第三方核券准备接口
allinpay.shopoint.thirdCouponService.prepare
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
type
|
|
String |
是 |
|
类型 |
meituan tiktok dianping mtdz |
|
couponNo
|
|
String |
是 |
|
券号 |
|
|
shopId
|
|
Integer |
是 |
|
店铺号 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||||
|
msg |
String |
否 |
|
错误信息 |
|
||||
|
data
|
couponName
|
|
|
String |
|
|
券名称 |
|
|
|
couponValue
|
|
|
String |
|
|
券市场价 |
单位:元 |
||
|
couponBuyPrice |
|
|
String |
|
|
券售价 |
单位:元 |
||
|
couponType
|
|
|
String |
|
|
券类型 |
|
||
|
initAmount
|
|
|
Integer |
|
|
券面额 |
券可验证数量 |
||
|
validityBeginDate
|
|
|
String |
|
|
有效开始时间 |
yyyy-MM-dd HH:mm:ss |
||
|
validityEndDate
|
|
|
String |
|
|
有效截止时间 |
yyyy-MM-dd HH:mm:ss |
||
|
couponTemplateList |
|
|
|
|
|
|
|
||
|
|
templateId |
|
|
|
|
|
数字营销券模版id |
|
|
|
couponType |
|
|
|
|
|
数字营销券类型 |
0-金额券 2-计次券 3-满减券 |
||
|
meiTuan |
|
|
|
|
|
美团券才返回 |
|
||
|
dealBeginTime |
|
String
|
|
|
项目开始时间 |
yyyy-MM-dd |
|||
|
dealId |
|
Integer |
|
|
项目ID |
|
|||
|
dealValue |
|
Bigdecimal |
|
|
券面值/市场价 |
单位:元 |
|||
|
dealTitle |
|
String |
|
|
项目名称 |
|
|||
|
count |
|
Integer |
|
|
最大可验证张数 |
|
|||
|
singleValue |
|
Bigdecimal |
|
|
量贩项目的单张券原价 |
单位:元 |
|||
|
dealPrice |
|
Bigdecimal |
|
|
团购券价格 |
单位:元 |
|||
|
dianPing |
|
|
|
|
|
大众点评券美团到店综券才返回 |
|
||
|
dealId |
|
String |
|
|
商品id
|
|
|||
|
dealTitle |
|
String |
|
|
商品名称 |
|
|||
|
dealPrice |
|
Bigdecimal |
|
|
商品售卖价格 |
单位:元 |
|||
|
dealMarketPrice |
|
Bigdecimal |
|
|
商品市场价 |
单位:元 |
|||
|
dealGroupId |
|
String |
|
|
团购ID |
|
|||
|
count |
|
Integer |
|
|
最大可验证张数 |
|
|||
|
platformAmount |
|
Bigdecimal |
|
|
补贴金额（平台分摊） |
单位:元 |
|||
|
merchantAmount |
|
Bigdecimal |
|
|
补贴金额（商户分摊） |
单位:元 |
|||
|
tikTok
|
|
|
|
|
|
抖音券才返回 |
|
||
|
tiktokCertificateList |
|
|
|
|
可核销券列表 |
|
|||
|
certificateId |
String |
|
|
券id |
|
||||
|
num |
Integer |
|
|
可核销数量 |
仅次卡有该字段 |
||||
|
sku |
skuId
|
String |
|
|
团购skuId |
|
|||
|
title |
String |
|
|
团购名称 |
|
||||
|
accountId
|
String |
|
|
商家团购账号id |
|
||||
|
marketPrice
|
String |
|
|
团购市场价 |
单位:分 |
||||
|
soldStartTime |
String |
|
|
团购售卖开始时间，时间戳，单位秒 |
|
||||
|
thirdSkuId |
String |
|
|
商家系统（第三方）团购id |
|
||||
请求示例
{"type":"mtdz","couponNo":"5948286811","shopId":"147"}
响应示例
{
"code": "0",
"data": {
"validityBeginDate": "",
"couponName": "0.1团10百货券",
"couponType": "",
"mtdz": {
"dealId": "1316147453",
"dealTitle": "0.1团10百货券",
"dealPrice": 0.1,
"dealGroupId": "1081740947"
},
"initAmount": 1,
"validityEndDate": "",
"couponValue": "0.1",
"couponBuyPrice": "0.1"
}
}
3.2.29第三方核券接口
allinpay.shopoint.thirdCouponService.consume
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
type
|
|
String |
是 |
|
类型 |
1.meituan 2.tiktok 3. dianping mtdz |
|
orderId |
|
String |
是 |
|
订单id |
|
|
couponNo
|
|
String |
是 |
|
券号 |
|
|
num |
|
Integer |
是 |
|
核销数量 |
|
|
shopId
|
|
Integer |
是 |
|
店铺id |
|
|
operUserId |
|
String |
是 |
|
核销人账号 |
操作人登录账号 |
|
remark
|
|
Integer |
否 |
|
核销备注 |
|
|
tiktokCertificateList |
|
List |
否 |
|
抖音券指定核销列表 |
|
|
certificateId |
String |
是 |
|
抖音券id |
|
|
|
num |
Integer |
是 |
|
核销数量 |
仅次卡有该字段 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|||
|
msg |
String |
是 |
|
错误信息 |
|
|||
|
data |
tranNo
|
|
|
String |
是 |
|
流水号 |
|
|
couponNo
|
|
|
String |
是 |
|
券号 |
|
|
|
couponName
|
|
|
String |
否 |
|
券名称 |
|
|
|
couponValue |
|
|
Bigdecimal |
否 |
|
券市场价 |
单位:元 |
|
|
couponBuyPrice |
|
|
Bigdecimal |
否 |
|
券售价 |
单位:元 |
|
|
changeSource |
|
|
Integer |
是 |
|
核销来源 |
42-接口核销 |
|
|
remark
|
|
|
String |
否 |
|
核销备注 |
|
|
|
consumeTime
|
|
|
DateTime |
是 |
|
核销时间 |
yyyy-MM-dd HH:mm:ss |
|
|
mtdz |
|
List |
|
|
美团到店综券才返回 |
|
||
|
receiptCode |
|
String |
|
|
验证券码 |
|
||
|
platformAmount |
|
Bigdecimal |
|
|
补贴金额（平台分摊） |
单位:元 |
||
|
merchantAmount |
|
Bigdecimal |
|
|
补贴金额（商户分摊） |
单位:元 |
||
|
couponDetails |
couponNo |
|
|
|
|
|
|
|
|
templateId |
|
|
|
|
|
|
||
|
financeList |
accountNo |
String |
|
|
科目编码 |
|
||
|
accountTitle |
String |
|
|
科目名称 |
|
|||
|
accountPriority |
Integer |
|
|
科目优先级 |
|
|||
|
accountValue |
Bigdecimal |
|
|
科目值 |
单位:元 |
|||
|
apportSetId |
Integer |
|
|
科目ID |
|
|||
请求示例
{"type":"meituan","couponNo":"77012321150807","shopId":"147","orderId":"2023121901B","operUserId":"liangqi","remark":"我是备注"}
响应示例
{
"code": 0,
"data": {
"tranNo": "165416131313",
"couponNo":"77012321150807",
"couponName": "券名称",
"changeSource": "42",
"couponPrice": "0.1",
"couponBuyPrice": "0.1",
"remark":"我是备注",
"consumeTime":"2024-05-11 23:59:59"
}
}
3.2.30第三方核券流水查询接口
allinpay.shopoint.thirdCouponService.consumeHistory
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1 |
|
pageSize |
Integer |
否 |
|
每页大小 |
不填默认20,最小为1,最大为200 不在范围内则被重置为默认值 |
|
type
|
String |
是 |
|
类型 |
meituan tiktok dianping mtdz
|
|
searchStr |
String |
否 |
|
券号/券名称/交易流水号 |
|
|
shopId
|
Integer |
否 |
|
店铺id |
|
|
operUserId |
String |
否 |
|
核销人账号 |
核销人登录账号 |
|
createStartTime
|
String |
否 |
|
核券开始时间 |
格式：yyyy-MM-dd HH:mm:ss |
|
createEndTime
|
String |
否 |
|
核券结束时间 |
格式：yyyy-MM-dd HH:mm:ss |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
changeId
|
|
Integer |
是 |
|
核销id |
|
|
tranNo
|
|
String |
是 |
|
交易流水号
|
|
|
|
couponNo
|
|
String |
是 |
|
券码
|
|
|
|
remark
|
|
String |
否 |
|
核销备注
|
|
|
|
createUserId
|
|
Integer |
是 |
|
核销人id |
|
|
|
createUserName
|
|
String |
是 |
|
核销人名称 |
|
|
|
shopId
|
|
Integer |
否 |
|
核销店铺 |
|
|
|
shopName
|
|
String |
否 |
|
核销店铺名称 |
|
|
|
changeSource
|
|
Integer |
是 |
|
变动方式 |
34-POS直接核券 35-导购直接核券
|
|
|
sourceId
|
|
Integer |
是 |
|
变动方式 |
|
|
|
couponValue
|
|
Bigdecimal |
否 |
|
券市场价 |
单位:元 |
|
|
couponBuyPrice |
|
Bigdecimal |
否 |
|
券售价 |
单位:元 |
|
|
termNo |
|
String |
否 |
|
终端号 |
|
|
|
tranDateTime |
|
DateTime |
是 |
|
核销时间 |
yyyy-MM-dd HH:mm:ss |
|
|
userId |
|
String |
否 |
|
用户登录账号 |
|
|
|
couponDetails
|
templateId
|
Integer |
是 |
|
模板ID
|
0 |
|
|
couponType
|
Integer |
是 |
|
卡券类型
|
0 |
||
|
couponName
|
String |
是 |
|
卡券名称
|
|
||
|
couponNo
|
String |
是 |
|
券号
|
|
||
|
balanceChanged
|
Integer |
是 |
|
余额变动数量
|
单位:张 |
||
|
remark
|
String |
否 |
|
备注
|
|
||
请求示例
{"type":"meituan","searchStr":"77012321150807","shopId":"147","orderId":"2023121901B","operUserId":"liangqi"}
响应示例
{
"code": 0,
"data": {
"changeId": "meituan",
"tranNo": "165416131313",
"couponNo":"165416131313",
"remark": "备注",
"createUserId": "1584",
"createUserName":"baowei",
"createTime":"2023-05-11 23:59:59",
"shopId":"147",
"shopName":"星巴克光华店",
"changeSource":"34",
"sourceId":"56153",
"couponValue":"20.00",
"couponBuyPrice":"20.00",
"termNo":"00000001",
"tranDateTime":"2023-05-11 23:59:59",
"createTime":"2023-12-11 23:59:59",
"userId":"baowei"
"couponDetails":{
"templateId":"5582",
"couponType":"代金券",
"couponName":"名字很长的全名字很长的全名字的券",
"createTime":"2023-11-11 23:59:59",
"couponNo":"000000546246490337",
"balanceChanged":" -400,
"remark":"oooooo"
}
}
}
3.2.31第三方撤销核券接口
allinpay.shopoint.thirdCouponService.cancel
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
type
|
|
String |
是 |
|
类型 |
meituan tiktok dianping mtdz |
|
tranNo
|
|
String |
是 |
|
核销订单号
|
|
|
shopId
|
|
Integer |
否 |
|
店铺id |
|
|
operUserId |
|
String |
是 |
|
撤销人登录账号 |
撤销人登录账号 |
|
orderId
|
|
String |
是 |
|
外部订单号 |
|
|
remark
|
|
Integer |
否 |
|
撤销备注
|
|
|
couponNo |
|
String |
否 |
|
抖音/美团/点评券id |
仅在多张核销需要撤销某张时必传 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|||
|
msg |
String |
是 |
|
错误信息 |
|
|||
|
data |
tranNo
|
|
|
String |
是 |
|
原核销订单号
|
|
|
sysno
|
|
|
String |
是 |
|
撤销人id |
|
|
|
shopId
|
|
|
String |
是 |
|
原核销门店id |
|
|
|
changeSource
|
|
|
Integer |
是 |
|
变动方式 |
134-POS直接核券撤销 135-导购直接核券撤销 312-API接口撤销交易
|
|
|
remark
|
|
|
String |
是 |
|
撤销备注
|
|
|
|
createTime
|
|
|
DateTime
|
是 |
|
撤销时间
|
yyyy-MM-dd HH:mm:ss |
|
|
|
createUserName
|
|
|
String |
是 |
|
撤销人姓名 |
|
|
|
balanceChanged
|
|
|
Integer |
是 |
|
撤销数量
|
单位:张 |
|
|
couponName
|
|
|
String |
否 |
|
美团/抖音券名称
|
|
请求示例
{"type":"meituan","tranNo":"77012321150807","orderId":"2023121901B","operUserId":"liangqi"}
响应示例
{
"code": 0,
"data": {
"tranNo": "165416131313",
"sysno":"1584",
"shopId": "147",
"changeSource": "312",
"remark":"撤销备注",
"createTime":"2023-05-11 23:59:59",
"createUserName":"baowei",
"couponName":"美团券名称"
}
}
3.2.32第三方券码查询接口
allinpay.shopoint.thirdCouponService.queryById
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
type
|
|
String |
是 |
|
类型 |
meituan tiktok dianping mtdz |
|
couponNo
|
|
String |
是 |
|
券号 |
|
|
shopId
|
|
Integer |
是 |
|
店铺id |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|||
|
msg |
String |
是 |
|
错误信息 |
|
|||
|
data |
templateId
|
|
|
String |
是 |
|
券活动ID
|
|
|
couponName
|
|
|
String |
否 |
|
券名称
|
|
|
|
couponNo
|
|
|
String |
否 |
|
券号
|
|
|
|
initAmount
|
|
|
String
|
是 |
|
券面额 |
单位:分 |
|
|
couponType
|
|
|
String |
是 |
|
券类型
|
|
|
|
verifyType
|
|
|
String |
是 |
|
验券方式
|
|
|
|
|
couponStatus
|
|
|
String |
是 |
|
券状态
|
空=未使用 |
|
|
consumeTime
|
|
|
DateTime |
否 |
|
验券时间
|
yyyy-MM-dd HH:mm:ss |
请求示例
{"type":"meituan","couponNo":"77012321150807","shopId":"147"}
响应示例
{
"code": 0,
"data": {
"templateId": "1303",
"couponName":"满减测试",
"couponNo": "000000248531847767",
"initAmount": "20",
"couponType":"套餐券",
"couponStatus":"已核销",
"consumeTime":"2023-05-11 23:59:59"
}
}
3.2.34第三方门店验券历史接口
allinpay.shopoint.thirdCouponService.verifyHistory
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
shopId |
|
Integer |
是 |
|
店铺id |
|
|
date |
|
String |
是 |
|
日期 |
XXXX-XX-XX |
|
pageNo |
|
Integer |
否 |
|
页码 |
|
|
pageSize |
|
Integer |
否 |
|
查询条数 |
最大为200 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
|
Long |
是 |
|
|
|
|
couponVerifyHistoryList
|
couponBuyPrice
|
Double
|
是 |
|
团购券购买价格
|
|
|
|
couponCancelStatus
|
Long
|
是 |
|
团购券是否可撤销
|
1表示可撤销，0表示不可撤销
|
||
|
couponCode
|
String
|
是 |
|
团购券码
|
|
||
|
couponStatusDesc
|
String |
是 |
|
团购券状态
|
|
||
|
couponUseTime
|
String |
是 |
|
验券时间
|
|
||
|
dealBeginTime
|
String |
是 |
|
团购券对应项目开始售卖时间
|
|
||
|
dealTitle
|
String |
是 |
|
项目对应的标题
|
|
||
|
dealValue
|
Double
|
是 |
|
项目售卖价
|
|
||
|
verifyAcct
|
String |
是 |
|
验券帐号
|
|
||
|
|
|
verifyType
|
String |
是 |
|
验券方式
|
|
|
|
|
isVerifyPay
|
Long
|
是 |
|
|
|
|
|
|
isVoucher
|
Boolean
|
是 |
|
|
|
请求示例
{
"date": "2024-03-11",
"orgId": 100038,
"pageNo": 1,
"pageSize":100,
"shopId": 147
}
响应示例
{
"couponVerifyHistoryList": [
{
"couponBuyPrice": 0.1,
"couponCancelStatus": 1,
"couponCode": "013541450619",
"couponStatusDesc": "已使用",
"couponUseTime": "2024-03-22 00:01:47",
"dealBeginTime": "2018-03-18 11:35:20",
"dealTitle": "t_dV77HpVl2人餐",
"dealValue": 0.11,
"isVerifyPay": 2,
"isVoucher": false,
"verifyAcct": "账号：",
"verifyType": "美团技术服务合作中心api验证"
}
],
"total": 2
}
3.2.35券号查询该顾客同券模板下的券号列表
依据券号或券动态码该顾客同券模板下的券号列表详细信息
method: allinpay.shopoint.couponService.query
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
pageNo |
Integer |
否 |
|
页码 |
1-1000，默认1 |
|
pageSize |
Integer |
否 |
|
页大小 |
1-200，默认200 |
|
couponNo |
String |
是 |
|
券号或券动态码 |
|
|
queryMode |
String |
否 |
|
查询类型 |
single（默认）-查询输入的券号详细信息 |
|
status |
Integer |
否 |
|
券状态 |
与响应参数中和status相同 |
|
sortType |
Integer |
否 |
|
排序 |
-2代表金额倒序且创建时间倒序 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
templateId |
Integer |
是 |
|
模板ID |
|
|
couponNo |
String |
是 |
|
券号 |
|
|
|
couponName |
String |
是 |
|
券名称 |
|
|
|
couponType |
Integer |
是 |
|
券类型 |
0-金额券 2-计次券 3-满减券 |
|
|
balance |
BigDecimal |
是 |
|
余额 |
|
|
|
initAmount |
BigDecimal |
是 |
|
面额 |
|
|
|
unit |
String |
是 |
|
单位 |
计次券使用 |
|
|
validityType |
Integer |
是 |
|
有效期类型 |
0 - 指定日期范围 1 - 领用之日起n天内 |
|
|
validityBeginDate |
String |
是 |
|
有效期起始日期 |
null表示不限制 |
|
|
validityEndDate |
String |
是 |
|
有效期结束日期 |
|
|
|
status |
Integer |
是 |
|
券状态 |
0-有效 1-冻结 2-已作废 3-已核销 4-已挂失 5-转赠中 6-失效 7-待兑换 8-已兑换 9-退款中 |
|
|
unusableReason |
String |
否 |
|
不可使用的原因 |
Status不为0是有描述 |
|
|
hasPassword |
Boolean |
是 |
|
是否有密码 |
True或false |
|
|
usableAmount |
BigDecimal |
否 |
|
每满多少金额可以使用1张 |
couponType=3满减券时有效 |
|
|
usableMaxNum |
Integer |
否 |
|
每笔订单最多使用多少张 |
couponType=3满减券时有效 |
|
|
instruction |
String |
否 |
|
券使用须知 |
|
|
请求示例
{
"pageNo": "1",
"pageSize": "10",
"couponNo": "100152202011230002",
"queryMode":"single"
}
响应示例
{
"code":"0",
"data":{
"coupons":[
{
"couponName":"导购外部计次",
"couponNo":"100152202011230002",
"hasPassword":false,
"templateId":1504,
"validityEndDate":"2020-12-12 23:59:59",
"unusableReason":"",
"validityBeginDate":"2020-11-23 00:00:00",
"unit":"次",
"validityType":1,
"balance":6.00,
"couponType":2,
"instruction":"不限制",
"initAmount":6.00,
"status":0
}
],
"pageNo":10,
"pageSize":1
}
}
3.2.38美团到店综合预约数据
透传美团预约数据 美团文档链接
method: allinpay.shopoint.thirdDataService.meituanBooking
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
dataType |
Integer |
是 |
11 |
时间范围 |
1/7/30三选一 |
|
shopId |
Integer |
是 |
11 |
店铺ID |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
4 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
200 |
错误信息 |
|
||
|
data |
result |
List |
否 |
|
结果 |
|
|
|
|
totalBooking |
Integer |
否 |
11 |
全量预约数 |
|
|
|
midasBooking |
Integer |
否 |
11 |
推广通预约数 |
|
||
|
telephoneBooking |
Integer |
否 |
11 |
400电话预约数 |
|
||
|
platform |
Integer |
否 |
11 |
平台 |
0-全部，1-大众点评平台，2-美团平台 |
||
3.2.39美团到店综合消费数据
透传美团消费数据 美团文档链接
method: allinpay.shopoint.thirdDataService.meituanConsumption
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
dataType |
Integer |
是 |
11 |
时间范围 |
1/7/30三选一 |
|
shopId |
Integer |
是 |
11 |
店铺ID |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
4 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
200 |
错误信息 |
|
||
|
data |
result |
List |
否 |
|
结果 |
|
|
|
|
tgConsumeAmount |
Decimal |
否 |
11 |
团购消费额 |
单位:元 |
|
|
tgConsumeCount |
Integer |
否 |
11 |
团购消费验券数 |
|
||
|
mopayConsumeAmount |
Decimal |
否 |
11 |
买单（包含闪惠及线下扫码支付）消费额 |
单位:元 |
||
|
mopayConsumeCount |
Integer |
否 |
11 |
买单（包含闪惠及线下扫码支付）消费订单数 |
|
||
|
reservationConsumeAmount |
Decimal |
否 |
11 |
预订消费额 |
单位:元 |
||
|
reservationConsumeCount |
Integer |
否 |
11 |
预订消费订单数 |
|
||
|
platform |
Integer |
否 |
11 |
平台 |
0-全部，1-大众点评平台，2-美团平台
|
||
3.2.40美团到店综合团单消费详情数据
透传美团团单消费详情数据 美团文档链接
method: allinpay.shopoint.thirdDataService.meituanDealGroupsConsumption
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
dataType |
Integer |
是 |
11 |
时间范围 |
1/7/30三选一 |
|
shopId |
Integer |
是 |
11 |
店铺ID |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
4 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
200 |
错误信息 |
|
||
|
data |
result |
List |
否 |
|
结果 |
|
|
|
|
consumeAmt |
Decimal |
否 |
11 |
团购消费额 |
单位:元 |
|
|
consumeCnt |
Integer |
否 |
11 |
团购消费验券数 |
|
||
|
dealGroupId |
Integer |
否 |
11 |
团单Id |
|
||
|
dealGroupShortTitle |
String |
否 |
20 |
品牌名称 |
|
||
|
dealGroupTitle |
String |
否 |
50 |
团单名字 |
|
||
|
dealGroupPrice |
Decimal |
否 |
8 |
团单价格 |
单位:元 |
||
|
marketPrice |
Decimal |
否 |
16,2 |
市场价 |
单位:元 |
||
|
platform |
Integer |
否 |
11 |
平台 |
0-全部，1-大众点评平台，2-美团平台 |
||
3.2.41美团到店综合门店流量数据
透传美团门店流量数据 美团文档链接
method: allinpay.shopoint.thirdDataService.meituanPoiTraffic
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
startDate |
String |
是 |
10 |
开始交易日期 |
格式：yyyy-MM-dd |
|
endDate |
String |
是 |
10 |
截止交易日期 |
格式：yyyy-MM-dd, 查询时间长度不得超过30天，endDate >= startDate，且endDate最晚为两天前，如今日为13号，则endDate最晚为11号 |
|
shopId |
Integer |
是 |
11 |
店铺ID |
|
|
platform |
Integer |
是 |
11 |
平台 |
0-全部，1-大众点评平台，2-美团平台 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
4 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
200 |
错误信息 |
|
|
|
data |
viewUv |
Integer |
否 |
11 |
曝光人数 |
|
|
shopUv |
Integer |
否 |
11 |
商详页访问人数 |
|
|
|
buyUv |
Integer |
否 |
11 |
下单人数 |
|
|
|
consumeUv |
Integer |
否 |
11 |
到店核销人数 |
|
|
|
bookUv |
Integer |
否 |
11 |
预约人数(客资数) |
|
|
|
pageTime |
Integer |
否 |
11 |
页面停留时间(单位:秒) |
|
|
3.2.42美团餐饮门店套餐映射
透传美团餐饮门店套餐映射 美团文档链接
method: allinpay.shopoint.thirdDataService.meituanSetMealList
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
dealStatus |
Integer |
是 |
10 |
套餐状态 |
参见美团文档 |
|
shopId |
Integer |
是 |
11 |
店铺ID |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
4 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
200 |
错误信息 |
|
|
|
data |
|
List |
否 |
11 |
套餐列表 |
|
|
|
|
|
|
|
|
|
|
dealEndTime |
Long |
否 |
11 |
项目结束时间戳 |
单位是秒 |
|
|
dealId |
Integer |
否 |
11 |
项目ID |
|
|
|
dealValue |
Decimal |
否 |
11 |
市场价格 |
单位是元 |
|
|
dealStatus |
Integer |
否 |
11 |
套餐状态 |
|
|
|
beginTime |
Long |
否 |
11 |
项目开始时间戳 |
单位是秒 |
|
|
dealPrice |
Decimal |
否 |
11 |
售卖价格 |
单位是元 |
|
3.2.43美团到店综合门店商品信息
透传美团到店综合门店商品信息 美团文档链接
method: allinpay.shopoint.thirdDataService.meituanProductList
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
pageNo |
Integer |
是 |
10 |
页码 |
大于等于1 |
|
pageSize |
Integer |
是 |
10 |
单页大小 |
大于等于1且小于等于100 |
|
shopId |
Integer |
是 |
11 |
店铺ID |
|
|
type |
Integer |
是 |
11 |
商品类型 |
参见美团文档 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
4 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
200 |
错误信息 |
|
|
|
data |
|
List |
否 |
11 |
商品列表 |
|
|
|
|
|
|
|
|
|
|
productId |
Integer |
否 |
11 |
产品ID |
|
|
|
type |
Integer |
否 |
11 |
商品类型 |
见美团文档 |
|
|
productItemList |
List |
否 |
|
sku列表 |
|
|
|
|
|
|
|
|
|
|
|
productItemId |
Integer |
否 |
11 |
商品ID |
|
|
|
productId |
Integer |
否 |
11 |
产品ID |
|
|
|
name |
String |
否 |
11 |
商品名称 |
|
|
|
price |
String |
否 |
11 |
价格 |
|
|
|
marketPrice |
String |
否 |
11 |
市场价格 |
|
|
3.2.44抖音商品线上数据
透传抖音商品线上数据 抖音文档链接
method: allinpay.shopoint.thirdDataService.tiktokProductQuery
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
shopId |
Integer |
是 |
11 |
店铺ID |
|
|
status |
Integer |
是 |
11 |
筛选在线状态 |
1-在线 2-下线 3-封禁 |
|
goodsCreatorType |
Integer |
是 |
11 |
|
0 - 查询服务商/开发者创建的商品 1 - 查询商家（account_id）创建的商品 |
|
accountId |
String |
是 |
11 |
商家ID |
|
|
cursor |
String |
是 |
11 |
|
第一页不传，之后用前一次返回的next_cursor传入进行翻页 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
4 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
200 |
错误信息 |
|
|
|
data |
hasMore |
Boolean |
否 |
|
|
|
|
nextCursor |
String |
否 |
|
|
|
|
|
description |
String |
否 |
|
错误码描述 |
|
|
|
errorCode |
Integer |
否 |
11 |
错误码 |
|
|
|
products |
List |
否 |
11 |
线上数据列表 |
|
|
|
|
|
|
|
|
|
|
|
onlineStatus |
Integer |
否 |
11 |
在线状态 |
1-在线 2-下线 3-封禁 |
|
|
product |
Object |
否 |
|
商品 |
|
|
|
productId |
String |
否 |
|
商品Id |
|
|
|
productName |
String |
否 |
|
商品名 |
|
|
|
soldStartTime |
Integer |
|
|
售卖开始时间戳 |
|
|
|
soldEndTime |
Integer |
|
|
售卖结束时间戳 |
|
|