猫酷开放平台

# 退货

# 获取用户在某商户下的消费记录

TIP

根据手机号获取用户在某商户下的消费记录

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

# 接口调用参数

名称 数据类型 必填 说明
Mobile string 是 手机号
McShopID long 否 该商户在猫酷系统中的唯一编号（与CrmShopID、DevShopID任其选一必填）
CrmShopID string 否 该商户在商场CRM系统中的唯一编号（与McShopID、DevShopID任其选一必填）
DevShopID string 否 该商户在本开发者中的唯一编号，若使用此编号，则需提前将商户对应编号导入猫酷系统（与McShopID、CrmShopID任其选一必填）
TradeStartTime DateTime 否 消费时间（开始时间，格式：yyyy-MM-dd HH:mm:ss）
TradeEndTime DateTime 否 消费时间（结束时间，格式：yyyy-MM-dd HH:mm:ss）
Amount double 否 消费金额
PosID string 否 pos机编号
TradeSerialNo string 否 交易流水号
PageSize int 否 每页数量（默认10）
PagingID long 否 分页记录ID（现在只支持”下一页“分页形式，第一页传0，获取下一页时传入该值）

# 调用示例


{ 
	"Mobile": "15901996272",
	"McShopID": 1000053,
	"CrmShopID": "",
	"DevShopID": "",
	"TradeStartTime": null,
	"TradeEndTime": null,
	"Amount": null,
	"PosID": "",
	"TradeSerialNo": "",
	"PageSize": 10,
	"PagingID": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
ConsumeRecordList List<ConsumeRecordModel> 是 消费记录集合
Count long 是 总数（符合查询条件的数据）
PagingID long 是 分页记录ID（现在只支持”下一页“分页形式，第一页传0，获取下一页时传入该值）
# ConsumeRecordModel
名称 数据类型 必填 说明
TransID string 是 交易ID（即消费积分接口中的事物ID）
McShopID long 是 该商户在猫酷系统中的唯一编号
CrmShopID string 是 该商户在商场CRM系统中的唯一编号
TradeSerialNo string 否 交易流水号
PosID string 否 pos机编号
TradeTime DateTime 是 消费时间
Amount double 是 消费金额
Score double 否 消费积分
ReturnAmount double 否 当前可退金额
# 返回示例

 {
    "Code": 1,
    "Data": {
        "ConsumeRecordList": [
            {
                "TransID": "mallcoo_355",
                "McShopID": 1000035,
                "CrmShopID": "mydiycode",
                "TradeSerialNo": null,
                "PosID": null,
                "TradeTime": "2017/06/12 16:01:38",
                "Amount": 1000.0,
                "Score": 1000.0,
                "ReturnAmount": 1000.0
            },
            {
                "TransID": "mallcoo_354",
                "McShopID": 1000035,
                "CrmShopID": "mydiycode",
                "TradeSerialNo": null,
                "PosID": null,
                "TradeTime": "2017/06/12 11:16:47",
                "Amount": 1000.0,
                "Score": 1000.0,
                "ReturnAmount": 1000.0
            }
        ],
        "Count": 43,
        "PagingID": 1245
    },
    "Message": null
}
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



# 获取商户下的消费记录

TIP

获取某商户下的消费记录

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

# 接口调用参数

名称 数据类型 必填 说明
McShopID long 否 该商户在猫酷系统中的唯一编号（与CrmShopID、DevShopID任其选一必填）
CrmShopID string 否 该商户在商场CRM系统中的唯一编号（与McShopID、DevShopID任其选一必填）
DevShopID string 否 该商户在本开发者中的唯一编号，若使用此编号，则需提前将商户对应编号导入猫酷系统（与McShopID、CrmShopID任其选一必填）
TradeStartTime DateTime 否 消费时间（开始时间，格式：yyyy-MM-dd HH:mm:ss）
TradeEndTime DateTime 否 消费时间（结束时间，格式：yyyy-MM-dd HH:mm:ss）
Amount double 否 消费金额
PosID string 否 pos机编号
TradeSerialNo string 否 交易流水号
PageSize int 否 每页数量（默认10）
PagingID long 否 分页记录ID（现在只支持”下一页“分页形式，第一页传0，获取下一页时传入该值）

# 调用示例


{ 
	"McShopID": 1000053,
	"CrmShopID": "",
	"DevShopID": "",
	"TradeStartTime": null,
	"TradeEndTime": null,
	"Amount": null,
	"PosID": "",
	"TradeSerialNo": "",
	"PageSize": 10,
	"PagingID": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
ConsumeRecordList List<ConsumeRecordModel> 是 消费记录集合
Count long 是 总数（符合查询条件的数据）
PagingID long 是 分页记录ID（现在只支持”下一页“分页形式，第一页传0，获取下一页时传入该值）
# ConsumeRecordModel
名称 数据类型 必填 说明
TransID string 是 交易（事物）ID（即消费积分接口中的事物ID）
MallCardNo string 否 会员卡号
Mobile string 否 手机号
McShopID long 是 该商户在猫酷系统中的唯一编号
CrmShopID string 是 该商户在商场CRM系统中的唯一编号
TradeSerialNo string 否 交易流水号
PosID string 否 pos机编号
TradeTime DateTime 是 消费时间
Amount double 是 消费金额
Score double 否 消费积分
ReturnAmount double 否 当前可退金额
# 返回示例

 {
    "Code": 1,
    "Data": {
        "ConsumeRecordList": [
            {
                "TransID": "mallcoo_355",
                "MallCardNo": "1590455451996270",
                "Mobile": "15901996270",
                "McShopID": 1000035,
                "CrmShopID": "mydiycode",
                "TradeSerialNo": null,
                "PosID": null,
                "TradeTime": "2017/06/12 16:01:38",
                "Amount": 1000.0,
                "Score": 1000.0,
                "ReturnAmount": 1000.0
            },
            {
                "TransID": "mallcoo_354",
                "MallCardNo": "1590455451996270",
                "Mobile": "15901996270",
                "McShopID": 1000035,
                "CrmShopID": "mydiycode",
                "TradeSerialNo": null,
                "PosID": null,
                "TradeTime": "2017/06/12 11:16:47",
                "Amount": 1000.0,
                "Score": 1000.0,
                "ReturnAmount": 1000.0
            }
        ],
        "Count": 43,
        "PagingID": 1245
    },
    "Message": null
}
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



# 查询消费数据是否参与积分或满赠

TIP

查询消费数据是否参与消费积分或满赠

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

# 接口调用参数

名称 数据类型 必填 说明
TradeTime DateTime 是 消费时间（格式：yyyy-MM-dd HH:mm:ss）
Amount double 是 消费金额
McShopID long 否 该商户在猫酷系统中的唯一编号（与CrmShopID、DevShopID任其选一必填）
CrmShopID string 否 该商户在商场CRM系统中的唯一编号（与McShopID、DevShopID任其选一必填）
DevShopID string 否 该商户在本开发者中的唯一编号，若使用此编号，则需提前将商户对应编号导入猫酷系统（与McShopID、CrmShopID任其选一必填）
PosID string 否 pos机编号

# 调用示例


{ 
	"TradeTime": "2017-7-10 12:33:12",
	"Amount": 100.00,
	"McShopID": 1000053,
	"CrmShopID": "",
	"DevShopID": "",
	"PosID": ""
}
1
2
3
4
5
6
7
8
9
10

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
HasScore bool 是 是否进行消费积分
ConsumeScore ConsumeScoreModel 否 消费积分信息（当参与积分时才返回）
HasGift bool 是 是否领取赠品
# ConsumeScoreModel
名称 数据类型 必填 说明
MallCardNo string 是 会员卡号
Mobile string 是 手机号
McShopID long 否 该商户在猫酷系统中的唯一编号
CrmShopID string 否 该商户在CRM系统中的唯一编号
TradeTime DateTime 是 消费时间
Amount double 是 消费金额
Score double 是 消费积分
ReturnAmount double 是 当前可退金额
ReturnScore double 是 当前可退消费积分
# 返回示例

{
    "Code": 1,
    "Data": {
        "HasScore": true,
        "ConsumeScore": {
            "MallCardNo": "2016100003431",
            "Mobile": "15901996270",
            "McShopID": 1000035,
            "CrmShopID": "crm1000035",
            "TradeTime": "2017/07/17 17:06:23",
            "Score": 1000,
            "Amount": 1000,
            "ReturnAmount": 0,
            "ReturnScore": 0
        },
        "HasGift": false
    },
    "Message": "成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21



# 执行退货退积分

TIP

执行退货退积分

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

# 接口调用参数

名称 数据类型 必填 说明
TradeTime DateTime 是 消费时间（格式：yyyy-MM-dd HH:mm:ss）
Amount double 是 消费金额
McShopID long 否 该商户在猫酷系统中的唯一编号（与CrmShopID、DevShopID任其选一必填）
CrmShopID string 否 该商户在商场CRM系统中的唯一编号（与McShopID、DevShopID任其选一必填）
DevShopID string 否 该商户在本开发者中的唯一编号，若使用此编号，则需提前将商户对应编号导入猫酷系统（与McShopID、CrmShopID任其选一必填）
TradeSerialNo string 否 交易流水号,非必填，若商场消费积分判重时需要此字段，则必须传入
PosID string 否 pos机编号
ReturnTradeID string 是 外部退货单号
ReturnAmount double 是 退货金额

# 调用示例


{ 
	"TradeTime": "2017-7-10 12:33:12",
	"Amount": 100.00,
	"McShopID": 1000053,
	"CrmShopID": "",
	"DevShopID": "",
	"PosID": "",
	"ReturnTradeID": 1000053,
	"ReturnAmount": 100
}
1
2
3
4
5
6
7
8
9
10
11
12

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
ReturnScore double 否 扣除消费积分值（只有当前此消费小票处于可退状态且退消费积分成功时才返回对应的值）
# 返回示例

 {
    "Code": 1,
    "Data": {
                "ReturnScore":100
    },
    "Message": null
}
1
2
3
4
5
6
7
8
9



# 退货退积分预计算

TIP

退货退积分预计算

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

# 接口调用参数

名称 数据类型 必填 说明
TradeTime DateTime 是 消费时间（格式：yyyy-MM-dd HH:mm:ss）
Amount double 是 消费金额
McShopID long 否 该商户在猫酷系统中的唯一编号（与CrmShopID、DevShopID任其选一必填）
CrmShopID string 否 该商户在商场CRM系统中的唯一编号（与McShopID、DevShopID任其选一必填）
DevShopID string 否 该商户在本开发者中的唯一编号，若使用此编号，则需提前将商户对应编号导入猫酷系统（与McShopID、CrmShopID任其选一必填）
TradeSerialNo string 否 交易流水号,非必填，若商场消费积分判重时需要此字段，则必须传入
PosID string 否 pos机编号
ReturnTradeID string 是 外部退货单号
ReturnAmount double 是 退货金额

# 调用示例


{ 
	"TradeTime": "2017-7-10 12:33:12",
	"Amount": 100.00,
	"McShopID": 1000053,
	"CrmShopID": "",
	"DevShopID": "",
	"PosID": "",
	"ReturnTradeID": 1000053,
	"ReturnAmount": 100
}
1
2
3
4
5
6
7
8
9
10
11
12

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
ReturnScore double 否 扣除消费积分值（只有当前此消费小票处于可退状态且退消费积分成功时才返回对应的值）
# 返回示例

 {
    "Code": 1,
    "Data": {
                "ReturnScore":100
    },
    "Message": null
}
1
2
3
4
5
6
7
8
9



# 查询消费是否参与IMS满赠

TIP

查询消费是否参与IMS满赠

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

# 接口调用参数

名称 数据类型 必填 说明
TradeTime DateTime 是 消费时间（格式：yyyy-MM-dd HH:mm:ss）
Amount double 是 消费金额
McShopID long 否 该商户在猫酷系统中的唯一编号（与CrmShopID、DevShopID任其选一必填）
CrmShopID string 否 该商户在商场CRM系统中的唯一编号（与McShopID、DevShopID任其选一必填）
DevShopID string 否 该商户在本开发者中的唯一编号，若使用此编号，则需提前将商户对应编号导入猫酷系统（与McShopID、CrmShopID任其选一必填）
PosID string 否 pos机编号

# 调用示例


{ 
	"TradeTime": "2017-7-10 12:33:12",
	"Amount": 100.00,
	"McShopID": 1000053,
	"CrmShopID": "",
	"DevShopID": "",
	"PosID": ""
}
1
2
3
4
5
6
7
8
9
10

# 返回结果

名称 数据类型 必填 说明
Code int 是 状态码
Data Json 是 返回数据
Message string 是 返回状态描述
# Data
名称 数据类型 必填 说明
HasImsFullGift bool 是 是否参与过IMS消费满赠
ImsFullGiftData ImsFullGiftData 否 IMS消费满赠积分信息（当参与过IMS消费满赠时才返回）
# ImsFullGiftData
名称 数据类型 必填 说明
PlanId long 是 触发的营销计划id
PlanName string 是 触发的营销计划名称
EventType string 是 事件类型：消费满赠[Consume] 消费积分满赠[ConsumeBonus]
Bonus double 否 触发奖励的积分
Coupons List<ConsumeSendCoupon> 否 触发奖励的券信息
LotteryChance ConsumeSendLotteryChance 否 触发的抽奖机会
# ConsumeSendCoupon
名称 数据类型 必填 说明
CouponId long 否 券规则ID
RuleNo string 否 券规则编号
Name string 否 券规则名称
SuccessCount int 否 成功数量
FailureCount int 否 失败数量
TotalCount int 否 总数量
BatchID string 否 批次ID
# ConsumeSendLotteryChance
名称 数据类型 必填 说明
ID long 否 ID
Name string 否 名称
TypeName string 否 类型
DisplayTimeBegin DateTime 否 活动有效期开始时间
DisplayTimeEnd DateTime 否 活动有效期结束时间
Count int 否 数量
# 返回示例

{
	"Code": 1,
	"Data": {
		"HasImsFullGift": true,
		"ImsFullGiftData": [{
			"PlanId": 2214,
			"PlanName": "消费积分满赠122",
			"EventType": "ConsumeBonus",
			"Bonus": 3.0,
			"Coupons": [],
			"LotteryChance": null
		}, {
			"PlanId": 2206,
			"PlanName": "消费200元触发",
			"EventType": "Consume",
			"Bonus": 0.0,
			"Coupons": [{
				"CouponId": 2642,
				"RuleNo": "KQ10057201911070001",
				"Name": "新鸿基车场2元停车券",
				"SuccessCount": 1,
				"FailureCount": 0,
				"TotalCount": 1,
				"BatchID": "2206|0ac44da0-7a4e-4269-bff8-36aa6a358354"
			}],
			"LotteryChance": null
		}]
	},
	"Message": "成功",
	"Extension": []
}
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
Last Updated: 2021/4/21 下午11:52:25

← 销售数据 →