猫酷开放平台

# CRM

# 会员信息变更通知

TIP

此接口用于线下CRM中会员信息发生变更时，把变更事件通知到猫酷MP系统，MP系统去与线下CRM同步相关信息。目前支持根据此接口完成同步的信息包括等级、会员资料、可用积分值、状态。

接口地址：https://openapi10.mallcoo.cn/User/AdvancedInfo/v1/Update/Notice/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
ThirdPartyCardID string 是 第三方会员ID（crm会员ID，与手机号二选一）
Mobile string 是 手机号（与第三方会员ID二选一）
# 调用示例
{
    "ThirdPartyCardID": "201610000343",
    "Mobile":"15155145475"
}
1
2
3
4

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例
{
  "Code": 1,
  "Message": "成功"
}
1
2
3
4



# 会员等级变更通知

TIP

线下CRM在发生了会员等级变更后，需要根据此接口通知MallCoo系统

接口地址：https://openapi10.mallcoo.cn/User/AdvancedInfo/v1/UpdateGrade/Inform/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
ThirdPartyCardID string 是 第三方会员ID（crm会员ID）
BeforeCardCode string 是 变更前卡等级（卡代码），若使用中文命名，需UTF8编码
AfterCardCode string 是 变更后卡等级（卡代码），若使用中文命名，需UTF8编码
ChangeType int 是 变更类型（0为升级，1为降级）
ChangeTime DateTime 是 变更时间（年-月-日 时：分：秒）
Remark string 否 变更备注，UTF8编码
GradeChangeRuleID long 否 升降级规则ID
GradeChangeType GradeChangeType 否 升降级变更类型：1代表自动升降级，2代表手工调整
GradeChangeID string 否 等级变更记录ID

# 调用示例


{ 
  "ThirdPartyCardID": "201710000001",
  "BeforeCardCode": "Vip123",
  "AfterCardCode": "Vip456",
  "ChangeType": 0,
  "ChangeTime": "2018-09-10 12:13:34",
  "Remark": "变更备注",
  "GradeChangeRuleID": null,
  "GradeChangeType": null,
  "GradeChangeID": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
	"Code": 1,
	"Message": "成功"
}
1
2
3
4
5
6



# 消费积分变更通知

TIP

用于第三方CRM在发生消费积分变动和退货退积分时 ，将相关数据推送给猫酷平台，以保证会员能够正常使用消费数据参与活动等。

接口地址：https://openapi10.mallcoo.cn/Score/v1/Change/Inform/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSONyh

# 接口调用参数

名称 数据类型 必填 说明
TransID string 是 交易ID（消费时传入消费单号，退货时传入退货单号，需保证唯一性）
ThirdPartyCardID string 是 会员卡号ID（CRM会员卡ID）
ScoreEvent enum 是 积分事件，只能传入【1：消费积分；2101：退货退积分】（详情看枚举字典）
TradeTime DateTime 是 消费时间（格式：yyyy-MM-dd HH:mm:ss）
TradeAmount double 是 消费金额
CrmShopID string 是 消费商户，该商户在商场CRM系统中的唯一编号
TradeSerialNo string 否 交易流水号（根据商场是否要求必填儿传入此字段，若退货退积分，则此字段传入为消费时的交易单号）
PosID string 否 pos机编号（根据商场是否要求必填儿传入此字段）
ReturnTime DateTime 否 退货时间（当积分类型为退货退积分时必填，格式：yyyy-MM-dd HH:mm:ss）
ReturnAmount double 否 退货金额 （当积分类型为退货退积分时必填）
Score double 是 积分值（积分事件为消费积分时传正值；退货退积分传负值）
PayType enum 否 支付方式（详见支付方式枚举字典）
# 调用示例

{ 
	"TransID":"4545454515",
	"ThirdPartyCardID":"455154545551",
	"ScoreEvent":1,
	"TradeTime": "2017-06-16 12:45:23",
	"TradeAmount": 100,
	"CrmShopID": "455665",
	"TradeSerialNo": "",
	"PosID": "",
	"ReturnTime": "",
	"ReturnAmount": null,
	"Score":100
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

 {
    "Code": 1,
    "Message": "成功"
}
1
2
3
4
5
6



# 消费积分变更通知V2

TIP

用于第三方CRM在发生消费积分变动和退货退积分时 ，将相关数据推送给猫酷平台，以保证会员能够正常使用消费数据参与活动等。V2版本增加了优惠及支付相关字段，用于线上数据分析及营销

接口地址：https://openapi10.mallcoo.cn/Score/v2/Change/Inform/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
TransID string 是 交易ID（消费时传入消费单号，退货时传入退货单号，需保证唯一性）
ThirdPartyCardID string 是 会员卡号ID（CRM会员卡ID）
ScoreEvent enum 是 积分事件，只能传入【1：消费积分；2101：退货退积分】（详情看枚举字典）
TradeTime DateTime 是 消费时间（格式：yyyy-MM-dd HH:mm:ss）
PayAmount double 是 支付金额（参与积分的部分）
CrmShopID string 是 消费商户，该商户在商场CRM系统中的唯一编号
TradeSerialNo string 否 交易流水号（根据商场是否要求必填儿传入此字段，若退货退积分，则此字段传入为消费时的交易单号）
PosID string 否 pos机编号（根据商场是否要求必填儿传入此字段）
ReturnTime DateTime 否 退货时间（当积分类型为退货退积分时必填，格式：yyyy-MM-dd HH:mm:ss）
ReturnAmount double 否 退货金额 （当积分类型为退货退积分时必填）
Score double 是 积分值（积分事件为消费积分时传正值；退货退积分传负值）
TotalAmount double 是 订单总金额=支付金额+优惠金额
PromotionAmount double 否 优惠金额，默认为0
ConsumePromotionList List<ConsumePromotion> 否 优惠明细列表
ConsumePayList List<ConsumePay> 否 支付明细列表
# ConsumePromotion
名称 数据类型 必填 说明
PromotionType enum 是 优惠类型 （详见优惠类型枚举字典）
RuleNo string 否 优惠规则编号
No double 否 优惠码
Amount double 是 优惠金额
Desc string 否 优惠说明
# ConsumePay
名称 数据类型 必填 说明
PayType enum 是 支付方式（详见支付方式枚举字典）
PayNo string 否 支付单号
Amount double 是 支付金额
# 调用示例

{
    "TransID":"20190121173950",
    "ThirdPartyCardID":"454554554",
    "ScoreEvent":1,
    "TradeTime":"2019-01-21 17:39:50",
    "PayAmount":100,
    "CrmShopID":"mydiycode",
    "TradeSerialNo":null,
    "PosID":null,
    "ReturnTime":null,
    "ReturnAmount":null,
    "Score":100,
    "TotalAmount":1000,
    "PromotionAmount":500,
    "ConsumePromotionList":[
        {
            "PromotionType":6,
            "RuleNo":"RNO123",
            "No":"No123456",
            "Desc":"Desc",
            "Amount":200
        },
        {
            "PromotionType":1,
            "RuleNo":"RNO123123",
            "No":"No123456789",
            "Desc":"Desc",
            "Amount":300
        }
    ],
    "ConsumePayList":[
        {
            "PayType":12,
            "Amount":200,
            "PayNo":"PNO123456"
        },
        {
            "PayType":6,
            "Amount":300,
            "PayNo":"PNO123456987"
        },
        {
            "PayType":1,
            "Amount":500,
            "PayNo":"PNO1234569874546"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

 {
    "Code": 1,
    "Message": "成功"
}
1
2
3
4
5
6



# 积分超上限事件通知

TIP

当线下CRM会员积分超过积分上限时，可以通过此接口将这个事件发布Mallcoo线上系统

接口地址：https://openapi10.mallcoo.cn/Score/v1/OverLimit/Inform/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
RefID string 是 第三方CRM关联ID
ShopCode string 否 第三方CRM商户ID
Value string 否 本次触发值(积分Or次数)
RuleValue string 否 规则值(积分Or次数)
BonusAction enum 否 触发积分上限类型(0:全部，1:消费积分，4:积分调整，10:新用户奖励积分，7:签到奖励积分，12:完善个人资料奖励，6:抽奖发放积分等)积分动作枚举（详情看枚举字典-BonusAction 积分操作行为）
CurBonusAction enum 否 当前积分类型(本笔)积分动作枚举 （详情看枚举字典-BonusAction 积分操作行为）
BonusLimitSceneType int 否 积分上限场景类型(1:商场，2:商户)
BonusLimitObjType int 否 积分上限对象类型(1:商场Or商户，2:个人)
BonusLimitActionType int 否 积分上限动作类型(1:积分，2:次数)
BonusLimitTimeType int 否 时间类型(1:每天，2:每月)
Desc string 否 描述(超上线原因)（注：中文需编码，编码格式为：UTF-8 (UrlEncode)）

# 调用示例


{ 
  "RefID": "201610000095"
}
1
2
3
4
5

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
	"Code": 1,
	"Message": "成功",
	"Extension": []
}
1
2
3
4
5
6
7



# CRM积分变更事件

TIP

线下CRM会员发生积分变更后，通过此接口把会员积分变更事件传入。

接口地址：https://openapi10.mallcoo.cn/Score/v1/VipBonus/Change/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
ThirdPartyCardID string 是 会员卡号ID（CRM会员卡ID）
BonusAction enum 是 积分事件（详情看枚举字典）
GetBonus double 是 变更积分
AfterBonus double 是 变更后积分
RefID string 是 业务单号
CreateTime DateTime 是 积分变动时间
Desc string 否 积分变更备注（注：中文需编码，编码格式为：UTF-8 (UrlEncode)）

# 调用示例


{ 
  "ThirdPartyCardID": "201610000095",
  "BonusAction":4,
  "GetBonus":20,
  "AfterBonus":220,
  "RefID":"12ddd3",
  "CreateTime":"2020-06-24 15:16:45",
  "Desc":"%e6%b5%8b%e8%af%95%e5%a4%87%e6%b3%a8"

}
1
2
3
4
5
6
7
8
9
10
11
12

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
	"Code": 1,
	"Message": "成功",
	"Extension": []
}
1
2
3
4
5
6
7



# 积分处理结果通知

TIP

线下CRM审核积分处理后，通过此接口把审核结果传入。

接口地址：https://openapi10.mallcoo.cn/Score/v1/Verify/Inform/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
RefID string 是 积分申请单号
BonusAction enum 是 积分类型（详情看枚举字典）
Bonus double 是 最终获得积分值
CurrentBonus double 是 会员当前可用积分
BonusVerifyStatus string 是 积分审核处理结果(传1或-1，详情看枚举)
BonusVerifyTime DateTime 是 积分审核时间
Desc string 否 处理备注（注：中文需编码，编码格式为：UTF-8 (UrlEncode)）

# 调用示例


{ 
  "RefID":"12ddd3",
  "BonusAction":4,
  "Bonus":20,
  "CurrentBonus":220,
  "BonusVerifyStatus":1,
  "BonusVerifyTime":"2020-06-24 15:16:45",
  "Desc":"%e6%b5%8b%e8%af%95%e5%a4%87%e6%b3%a8"

}
1
2
3
4
5
6
7
8
9
10
11
12

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
	"Code": 1,
	"Message": "成功",
	"Extension": []
}
1
2
3
4
5
6
7

# 积分作废回调通知

TIP

线下积分作废回调通知

接口地址：https://openapi10.mallcoo.cn/Score/v1/Invalid/Inform/ (opens new window)
请求类型：POST
数据格式：application/json; charset=utf-8
参数类型：JSON

# 接口调用参数

名称 数据类型 必填 说明
RefID string 是 积分申请单号
BonusAction enum 是 积分类型（详情看枚举字典）
Desc string 否 作废原因（注：中文需编码，编码格式为：UTF-8 (UrlEncode)）

# 调用示例


{ 
  "RefID":"12ddd3",
  "BonusAction":4,
  "Desc":"%e6%b5%8b%e8%af%95%e5%a4%87%e6%b3%a8"

}
1
2
3
4
5
6
7
8

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Message string 是 返回状态描述
# 返回示例

{
	"Code": 1,
	"Message": "成功",
	"Extension": []
}
1
2
3
4
5
6
7
Last Updated: 2021/5/6 下午2:58:52

← 电商 →