会员促销

查询会员详情

openAPI收到终端会员信息查询的请求，即向第三方查询，并将结果返回给终端。

接口名称

cmd = "GetMemInfo"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	GetMemInfo	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
memcode	string	是	18673180000	会员号

请求示例

{
  "cmd": "GetMemInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "18673180000"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	object	否		会员信息列表，详见下表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
memtypename	string	是	普通会员	会员类型
memcode	string	是	18673180000	会员号
name	string	否	张三	会员名称
mobile	string	否	18673180000	手机号
points	BigDecimal	否	800.00	可用积分
balance	BigDecimal	否	200.00	可用储值
discount	BigDecimal	否	100	会员折扣率，默认100
uptime	string	是	2016-10-10 15:12:45	更新时间，格式yyyy-mm-dd hh24:mi:ss
cards	json list	否	[{“mcarduid”:”1867300”,”status”:0}]	会员拥有的卡列表，一个会员可能存在多张会员卡

上面表格中的字段 cards 参数对应的值是个json数据，类型是列表，字段描述如下

参数名	类型	是否必须	示例值	描述
mcarduid	string	是	18673180000	会员卡ID
status	int	是	0	状态（-1删除，0在用，1注销，2挂失）

注解

一个会员可能存在多张会员卡

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": {
    "memtypename": "普通会员",
    "memcode": "18673180000",
    "name": "张三",
    "mobile": "18673180000",
    "points": 800.00,
    "balance": 200.00,
    "discount": 100,
    "uptime": " 2016-10-10 15:12:45",
    "cards": [
      {
        "mcarduid": "1867300",
        "status": 0
      }
    ]
  }
}

查询卡券信息

openAPI收到终端券信息查询的请求，即向第三方查询，并将结果返回给终端。

接口名称

cmd = "GetCouponInfo"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	GetCouponI	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
couponcode	string	是	18673180000	券编码

请求示例

{
  "cmd": "GetCouponInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "couponcode": "18673180000"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	josn list	否		券信息列表，详见下表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
couponcode	string	是	18673180000	券码
couponname	string	是	5元	券名称
coupontype	int	是	1	券类型：1:代金券 2:折扣券 3:抵用券
couponval	BigDecimal	是	5	券值

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": {
    "couponcode": "18673180000",
    "couponname": "5元",
    "coupontype": 1,
    "couponval": 5
  }
}

查询储值卡信息

openAPI收到终端储值卡信息查询的请求，即向第三方查询，并将结果返回给终端。

接口名称

cmd = "GetChargeCardInfo"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	GetCouponI	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
cardcode	string	是	18673180000	卡编号

请求示例

{
  "cmd": "GetChargeCardInfo",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "cardcode": "18673180000"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	josn list	否		储值卡信息列表，详见下表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
cardcode	string	是	18673180000	卡号
cardval	BigDecimal	否	5元	卡余额
flows	josn list	否		卡消费流水，详见下表

上面表格中的字段 flows 参数对应的值是个json数据，类型是列表，字段描述如下

参数名	类型	是否必须	示例值	描述
rdate	string	是	2018-01-01	日期
opttype	int	是	1	卡操作类型 1:充值 2:消费
storename	string	是	友阿店	门店
val	BigDecimal	是	10	金额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": {
    "cardcode": "18673180000",
    "cardval": "5元",
    "flows": {
      "rdate": "2018-01-01",
      "opttype": 1,
      "storename": "友阿店",
      "val": 20
    }
  }
}

核销卡券

openAPI收到门店终端核销券的请求后，即时向第三方平台请求。

接口名称

cmd = "GetVerificationCoupon"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	VerificationSaleOrder	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
items	josn list	是		详见下表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
couponcode	string	是	20161010001	券码
couponval	BigDecimal	是	5	券值
storeuid	int	是	1	门店ID
storecode	string	是	101	门店编码
storename	string	是	友阿店	门店
optname	string	是	张三	营业员

请求示例

{
  "cmd": "GetVerificationCoupon",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": {
    "couponcode": "XS20161010001",
    "couponval": 5,
    "storeuid": 1,
    "storecode": "101",
    "storename": "友阿店",
    "optname": "张三"
  }
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
    "code":"0",
    "msg":"",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c"
}

核销储值卡

openAPI收到门店终端核销储值卡的请求后，即时向第三方平台请求。

接口名称

cmd = "GetVerificationChargeCard"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	VerificationSaleOrder	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
items	josn list	是		详见下表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
cardcode	string	是	100101	储值卡号
cardval	BigDecimal	是	5	核销金额
storeuid	int	是	1	门店ID
storecode	string	是	101	门店编码
storename	string	是	友阿店	门店名称
optname	string	是	张三	营业员

请求示例

{
  "cmd": "GetVerificationChargeCard",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": {
    "cardcode": "100101",
    "cardval": 5,
    "storeuid": 1,
    "storecode": "101",
    "storename": "友阿店",
    "optname": "张三"
  }
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
    "code":"0",
    "msg":"",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c"
}

推送会员销售单

向第三方平台即时推送会员销售单

接口名称

cmd = "PushMemSaleBill"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	AddSaleOrderBill	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
items	Object	是		单据信息结构，详见下表

上面表格中的字段items对应的值是个 单据信息 结构数据，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	xs20180101001	销售单号
rdate	string	是	2018-01-02	发生日期
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
amounttotal	BigDecimal	是	9.9	商品总数量
dealtotal	BigDecimal	是	1.00	总金额
tbillno	string	否	XS20161010001	第三方单据号订单号
tshowno	string	是	#1	第三方订单显示号
tscustsource	string	否	美团	第三方商户来源
isbooklist	int	是	0	是否预定单 1:是 0:否
isverification	int	是	0	是否核销单 1:是 0:否
storeuid	int	否	1	门店ID
storecode	string	是	001	门店编码
storename	string	否	湘阴一店	门店名称
memid	string	否	10101	会员卡号
vcno	string	否	1001	会员号
mopenid	string	否	afjaajfd111	微信openid
reamrks	string	否		单据备注
state	int	是		订单状态
billitems	json list	是		单据明细信息，详见下表
payitems	json list	否		单据支付信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
produid	integer	否	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
amount	BigDecimal	是	1.0	数量
dealpri	BigDecimal	是	9.9	单价
trademoney	BigDecimal	是	9.9	金额
attributes	string	否	少油	商品属性：多个属性,号分隔
remark	string	否		备注

上面表格中的字段 payitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
paycode	string	是	1	支付编码
payname	string	是	现金	支付名称
paymoney	BigDecimal	是	9.9	支付金额

请求示例

{
  "cmd": "PushMemSaleBill",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": {
    "billno": "xs20180101001",
    "rdate": "2018-01-02",
    "billingdate": "2016-02-01 12:02:34",
    "refertime": "2016-02-01 12:02:35",
    "amounttotal": 9.9,
    "dealtotal": 1.00,
    "tbillno": "XS20161010001",
    "tshowno": "#1",
    "tscustsource": "美团",
    "isbooklist": 0,
    "isverification": 0,
    "storeuid": 1,
    "storecode": "001",
    "storename": "湘阴一店",
    "memid": "10101",
    "vcno": "1001",
    "mopenid": "afjaajfd111",
    "reamrks": "",
    "state": 0,
    "billitems": [
      {
        "produid": 1,
        "prodcode": "001",
        "prodname": "BooK",
        "unit": "本",
        "amount": 1.0,
        "dealpri": 9.9,
        "trademoney": 9.9,
        "attributes": "少油",
        "remark": ""
      }
    ],
    "payitems": [
      {
        "paycode": "1",
        "payname": "现金",
        "paymoney": 9.9
      }
    ]
  }
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
    "code":"0",
    "msg":"",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c"
}

下载会员销售单

指定时间点，下载会员销售单

接口名称

cmd = "DownloadMemSaleBill"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	string	是	DownloadStoreDeclareGoods	请求的命令，即接口名称
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
uptime	string	是	2016-01-01 21:02:08	更新起点时间，格式yyyy-mm-dd hh24:mi:ss

注解

• 每次请求返回提交时间大于条件时间三天内的单据
• 如果条件时间小于系统中最小单据提交时间，则返回最小提交时间之后三天内的所有单据

请求示例

{
    "cmd":"DownloadMemSaleBill",
    "seq":"eb46ce74-dffa-4108-87bc-4809144ca33c",
    "uptime":"2016-01-01 21:02:08"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是	eb46ce74-dffa-4108-87bc-4809144ca33c	序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
billno	string	是	xs20180101001	销售单号
rdate	string	是	2018-01-02	发生日期
billingdate	string	是	2016-02-01 12:02:34	制单时间，格式： yyyy-mm-dd HH:mi:ss
refertime	string	是	2016-02-01 12:02:35	提交时间，格式： yyyy-mm-dd HH:mi:ss
amounttotal	BigDecimal	是	9.9	商品总数量
dealtotal	BigDecimal	是	1.00	总金额
tbillno	string	否	XS20161010001	第三方单据号订单号
tshowno	string	是	#1	第三方订单显示号
tscustsource	string	否	美团	第三方商户来源
isbooklist	int	是	0	是否预定单 1:是 0:否
isverification	int	是	0	是否核销单 1:是 0:否
storeuid	int	否	1	门店ID
storecode	string	是	001	门店编码
storename	string	否	湘阴一店	门店名称
memid	string	否	10101	会员卡号
vcno	string	否	1001	会员号
mopenid	string	否	afjaajfd111	微信openid
reamrks	string	否		单据备注
state	int	是		订单状态
billitems	json list	是		单据明细信息，详见下表
payitems	json list	否		单据支付信息，详见下表

上面表格中的字段 billitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
produid	integer	否	1	商品ID
prodcode	string	是	001	商品编码
prodname	string	是	BooK	商品名称
unit	string	是	本	单位
amount	BigDecimal	是	1.0	数量
dealpri	BigDecimal	是	9.9	单价
trademoney	BigDecimal	是	9.9	金额
attributes	string	否	少油	商品属性：多个属性,号分隔
remark	string	否		备注

上面表格中的字段 payitems 参数对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
paycode	string	是	1	支付编码
payname	string	是	现金	支付名称
paymoney	BigDecimal	是	9.9	支付金额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [{
    "billno": "xs20180101001",
    "rdate": "2018-01-02",
    "billingdate": "2016-02-01 12:02:34",
    "refertime": "2016-02-01 12:02:35",
    "amounttotal": 9.9,
    "dealtotal": 1.00,
    "tbillno": "XS20161010001",
    "tshowno": "#1",
    "tscustsource": "美团",
    "isbooklist": 0,
    "isverification": 0,
    "storeuid": 1,
    "storecode": "001",
    "storename": "湘阴一店",
    "memid": "10101",
    "vcno": "1001",
    "mopenid": "afjaajfd111",
    "reamrks": "",
    "state": 0,
    "billitems": [
      {
        "produid": 1,
        "prodcode": "001",
        "prodname": "BooK",
        "unit": "本",
        "amount": 1.0,
        "dealpri": 9.9,
        "trademoney": 9.9,
        "attributes": "少油",
        "remark": ""
      }
    ],
    "payitems": [
      {
        "paycode": "1",
        "payname": "现金",
        "paymoney": 9.9
      }
    ]
  }]
}

查询会员优惠券

openAPI收到终端优惠券查询的请求，即向第三方查询，并将结果返回给终端。

接口名称

cmd = "QueryCoupon"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	QueryCoupon	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
memcode	String	是		会员号
prodItems	json list	是

上面表格中的字段 prodItems 对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
prodcode	String	是		商品编码
prodname	String	是		商品名称
amount	BigDecimal	是		数量
trademoney	BigDecimal	是		金额

请求示例

{
  "cmd": "QueryConpon",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "5416",
  "prodItems": [
    {
      "prodcode": "001",
      "prodname": "农夫山泉",
      "amount": 1,
      "trademoney": 2
    }
  ]
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
memcode	String	是		会员号
qtype	Int	是		券类型：1代金券、2折扣券、3兑换券
couponcode	String	是		券码
couponname	String	是		券名称
couponval	BigDecimal	是		券面额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "memcode": "5416",
      "qtype": 1,
      "couponcode": "001",
      "couponname": "20元代金券",
      "couponval": 20
    }
  ]
}

会员优惠券核销

openAPI收到终端优惠券核销的请求，即向第三方查询，并将结果返回给终端。

接口名称

cmd = "VerCoupon"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是		请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
memcode	String	是		会员号
couponcode	String	是		券编码

请求示例

{
  "cmd": "VerConpon",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144",
  "couponcode": "001"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c"
}

会员优惠券核销查证

终端未收到第三方的核销返回信息，向第三方查证该券优惠券是否已核消的请求，避免重复核消，即向第三方查询，并将结果返回给终端。

接口名称

cmd = "VerCouponCheck"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	VerCouponCheck	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
memcode	String	是		会员号
org_seq	String	是		会员优惠券核销原请求seq

请求示例

{
  "cmd": "VerConponCheck",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144",
  "org_seq": "eb46ce74-dffa-4108-87bc-4809144ca44c"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表。如成功（code：0），应返回

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
memcode	String	是		会员号
couponcode	String	是		券编码
couponname	String	是		券名称
couponval	BigDecimal	是		券面额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "memcode": "45825",
      "couponcode": "001",
      "couponname": "20元代金券",
      "couponval": 20.00
    }
  ]
}

查询会员可抵现积分

openAPI收到终端查询会员可抵现积分的请求，即向第三方查询，并将结果返回给终端。

接口名称

cmd = "QueryMemOffsetPoints"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	QueryMemOffsetPoints	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
memcode	String	是		会员号

请求示例

{
  "cmd": "QueryMemOffsetPoints",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表。如成功（code：0），应返回

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
memcode	String	是		会员号
points	String	是		会员积分
usefulpoints	BigDecimal	是		可抵用积分
offsetamount	BigDecimal	是		可抵用金额

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "memcode": "5415",
      "points": 200,
      "usefulpoints": 200,
      "offsetamount": 200
    }
  ]
}

积分抵现

openAPI收到终端积分抵现的请求，即向第三方查询，并将结果返回给终端。

接口名称

cmd = "PointsOffset"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	PointsOffset	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
memcode	String	是		会员号
offsetamount	BigDecimal	是		抵现金额

请求示例

{
  "cmd": "PointsOffset",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144",
  "offsetamount": 100
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c"
}

积分抵现查证

终端未收到第三方的积分抵现返回信息，向第三方查证积分抵现是否已处理的请求，避免重复抵扣。即向第三方查询，并将结果返回给终端。

接口名称

cmd = "PointsOffsetCheck"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	PointsOffsetCheck	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
memcode	String	是		会员号
org_seq	String	是		积分抵现原请求seq

请求示例

{
  "cmd": "PointsOffsetCheck",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144",
  "org_seq": "eb46ce74-dffa-4108-87bc-4809144ca44c"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表。如成功（code：0），应返回

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
memcode	String			会员号
offsetamount	BigDecimal			抵现金额
points	BigDecimal			消耗积分

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "memcode": "5412",
      "offsetamount": 20,
      "points": 20
    }
  ]
}

促销活动查询匹配

接口名称

cmd = "PromoteSaleResult "

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	PromoteSaleResult	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
items	Josn List	是		单据信息

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
memcode	String	是	01	会员号
areacode	String	是	43	区域编号
storecode	String	是	001	门店编码
amounttotal	BigDecimal	是	2	商品总数量
dealtotal	BigDecimal	是	20	总金额
billitems	Josn List	是		单据明细信息

上面表格中的字段billitems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
produid	integer	是	101	商品ID
extproduid	integer	是	201	线上商品ID
prodcode	String	是	10101	商品编码
prodname	String	是	咪咪	商品名称
unit	String	是	包	单位
amount	BigDecimal	是	2	数量
dealpri	BigDecimal	是	10	单价
trademoney	BigDecimal	是	20	金额
attributes	String	否		商品属性 属性：多个属性,号分隔
remark	String	否		备注

请求示例

{
  "cmd": "PointsOffsetCheck",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144",
  "org_seq": "eb46ce74-dffa-4108-87bc-4809144ca44c"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表。如成功（code：0），应返回

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
memcode	String	是	01	会员号
areacode	String	是	43	区域编号
storecode	String	是	001	门店编码
amounttotal	BigDecimal	是	2	商品总数量
dealtotal	BigDecimal	是	20	总金额
offermoney	BigDecimal	否	5	优惠金额
Offernum	BigDecimal	否	0	赠送商品数量
offerremarks	BigDecimal	否	减价	促销名称、备注
promotionid	String	否	11	促销id
billitems	Josn List	否		单据明细信息

上面表格中的字段billitems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
produid	integer	是	101	商品ID
extproduid	integer	是	201	线上商品ID
prodcode	String	是	10101	商品编码
prodname	String	是	咪咪	商品名称
unit	String	是	包	单位
amount	BigDecimal	是	2	数量
dealpri	BigDecimal	是	10	单价
trademoney	BigDecimal	是	20	金额
attributes	String	否		商品属性 属性：多个属性,号分隔
remark	String	否		备注

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "memcode": "5412",
      "offsetamount": 20,
      "points": 20
    }
  ]
}

会员活动单据结据核销

接口名称

cmd = "PromoteSaleResultSet "

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	PromoteSaleResultSet	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
items	Josn List	是		单据信息

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
storecode	integer	是		门店编码
memcode	String	是		会员号
couponcode	String	否		券编码
sysopertime	String	否		时间戳(格式：yyyyMMddHHmmssSSS)
opttype	integer	否		核销类型 1积分调整 ；2销售单 ；3销售退单； 4积分清零；5储值卡充值 ；6积分兑换
pointsType	integer	否		操作类型 1：增加积分2：减少积分
offsetamount	BigDecimal	否		抵现金额
promotionid	String	否		促销id
offermoney	BigDecimal	否		优惠金额
Offernum	BigDecimal	否		赠送商品数量
offerremarks	String	否		促销名称、备注
billitems	Josn List	是		单据明细信息

上面表格中的字段billitems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
produid	integer	是	101	商品ID
extproduid	integer	是	201	线上商品ID
prodcode	String	是	10101	商品编码
prodname	String	是	咪咪	商品名称
unit	String	是	包	单位
amount	BigDecimal	是	2	数量
dealpri	BigDecimal	是	10	单价
trademoney	BigDecimal	是	20	金额
attributes	String	否		商品属性 属性：多个属性,号分隔
remark	String	否		备注

请求示例

{
  "cmd": "PointsOffsetCheck",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144",
  "org_seq": "eb46ce74-dffa-4108-87bc-4809144ca44c"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息

返回示例

{
  "code": "0",
  "msg": "",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "items": [
    {
      "memcode": "5412",
      "offsetamount": 20,
      "points": 20
    }
  ]
}

会员活动单据结据查证

接口名称

cmd = "PromoteSaleResultCheck"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	PromoteSaleResultCheck	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
org_seq	String	是		原会员活动单据结据核请求seq
memcode	String	是	01	会员号
couponcode	String	否		券编码
sysopertime	String	是		时间戳(格式：yyyyMMddHHmmssSSS) 原会员活动单据结据核销时间

请求示例

{
  "cmd": "PointsOffsetCheck",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144",
  "org_seq": "eb46ce74-dffa-4108-87bc-4809144ca44c"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息
items	json list	否		返回的单据数据列表。如成功（code：0），应返回

上面表格中的字段items对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
memcode	String	是		会员号
couponcode	String	否		券编码
sysopertime	String	是		时间戳(格式：yyyyMMddHHmmssSSS)
opttype	integer	否		核销类型 1积分调整 ；2销售单 ；3销售退单； 4积分清零；5储值卡充值 ；6积分兑换
pointsType	integer	否		操作类型 1：增加积分2：减少积分
offsetamount	BigDecimal	否		抵现金额
promotionid	String	否		促销id
offermoney	BigDecimal	否		优惠金额
Offernum	BigDecimal	否		赠送商品数量
offerremarks	String	否		促销名称、备注
billitems	Josn List	是		单据明细信息

上面表格中的字段billitems对应的值是个json数据，类型是列表，字段如下

参数名	类型	是否必须	示例值	描述
produid	integer	是	101	商品ID
extproduid	integer	是	201	线上商品ID
prodcode	String	是	10101	商品编码
prodname	String	是	咪咪	商品名称
unit	String	是	包	单位
amount	BigDecimal	是	2	数量
dealpri	BigDecimal	是	10	单价
trademoney	BigDecimal	是	20	金额
attributes	String	否		商品属性 属性：多个属性,号分隔
remark	String	否		备注

会员活动单据结据取消

接口名称

cmd = "PromoteSaleResultCancel"

请求参数

参数名	类型	是否必须	示例值	描述
cmd	String	是	PromoteSaleResultCheck	请求的命令，即接口名称
seq	String	是		序列号,采用全局唯一标识符，简称GUID
org_seq	String	是		原会员活动单据结据核请求seq
memcode	String	是	01	会员号
couponcode	String	否		券编码
sysopertime	String	是		时间戳(格式：yyyyMMddHHmmssSSS) 原会员活动单据结据核销时间

请求示例

{
  "cmd": "PointsOffsetCheck",
  "seq": "eb46ce74-dffa-4108-87bc-4809144ca33c",
  "memcode": "54144",
  "org_seq": "eb46ce74-dffa-4108-87bc-4809144ca44c"
}

返回参数

参数名	类型	是否必须	示例值	描述
code	int	是	0	返回状态码，详见 业务错误码说明
seq	string	是		eb46ce74-dffa-4108-87bc-4809144ca33c 序列号,采用全局唯一标识符，简称GUID
msg	string	否		返回状态解释，错误为错误提示信息