API开放平台

TIP

代金券扣减流水推送接口
代金券推送接口
赠品池推送接口
费用池增加流水推送
费用池扣减流水推送

# 代金券扣减流水推送接口

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
    "id": "",
    "card_no": "",
    "order_id": "",
    "reduce_amount": 0,
    "reduce_type": "",
    "remark": "",
    "deduct_time":"",
    "bill_no":""
}

参数说明：

参数	类型	必填	说明
id	INT8	是	id
card_no	VARCHAR(32)	是	卡号
reduce_amount	NUMERIC(20,2)	是	扣减金额
remark	VARCHAR(4000)	是	备注
reduce_type	VARCHAR(32)	是	扣减类型。1：手工扣减，2：下单扣减，3：接口扣减,4：过期扣减
deduct_time	VARCHAR(32)	是	扣减时间
bill_no	VARCHAR(32)	是	关联单号（发货单号）
order_id	INT8	是	订单ID（取发货单对应订单ID）

响应示例：

{
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
return_code	int	响应编码。0：成功，1：失败
return_msg	String	响应说明

# 代金券推送接口

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
	"card_id": "",
	"card_no": "",
	"cm_id": "",
	"cm_code": "",
	"cm_name": "",
	"amount": "",
	"used_amount": "",
	"leave_amount": "",
	"pd_range": "",
	"pd_range_name": "",
	"card_status": "",
	"card_status_name": "",
	"card_type_name": "",
	"can_applied": "",
	"add_type": "",
	"add_type_name": "",
	"remark": "",
	"period_date_end": "",
	"creator": "",
	"create_time": "",
	"modify_time": "",
	"period_date_start": ""
}

参数说明：

参数	类型	必填	说明
card_id	INT8	是	代金券id
card_no	VARCHAR(32)	是	代金券号
cm_id	INT8	是	客户id
cm_code	VARCHAR(32)	是	客户编码
cm_name	VARCHAR(100)	是	客户名称
amount	NUMERIC(20,2)	是	发放金额
used_amount	NUMERIC(20,2)	是	已用金额
leave_amount	NUMERIC(20,2)	是	剩余金额
remark	VARCHAR(4000)	是	备注
pd_range	VARCHAR(32)	是	商品范围：0：全部商品，1：指定商品
pd_range_name	VARCHAR(100)	是	商品范围：全部商品/指定商品
card_status	VARCHAR(32)	是	状态：0：待发放，1：已发放，2：使用中，3：已用完，4：已过期
card_status_name	VARCHAR(100)	是	状态：待发放/已发放/使用中/已用完/已过期
card_type_name	VARCHAR(100)	是	代金券类型
can_applied	VARCHAR(32)	是	是否允许核销。Y：可以，N：不可以
add_type	VARCHAR(32)	是	增加类型：1：手工录入，2：接口写入
add_type_name	VARCHAR(100)	是	增加类型：手工录入/接口写入
modify_time	VARCHAR(32)	是	更新时间。格式：yyyy-MM-dd HH:mm
period_date_end	VARCHAR(32)	是	使用截止日期。格式：yyyy-MM-dd
period_date_start	VARCHAR(32)	是	使用开始日期。格式：yyyy-MM-dd
creator	VARCHAR(32)	是	创建人
create_time	VARCHAR(32)	是	创建时间。格式：yyyy-MM-dd HH:mm
exts	List	代金券主数据自定义字段集合
exts.ext_key	VARCHAR(32)	代金券主数据自定义字段名称
exts.ext_value	VARCHAR(32)	代金券主数据自定义字段数值

响应示例：

{
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
return_code	int	响应编码。0：成功，1：失败
return_msg	String	响应说明

# 赠品池推送接口

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
    "flow_no": "",
    "cm_id": "",
    "cm_code": "",
    "cm_sourcecode": "",
    "pd_id": "",
    "pd_code": "",
    "unit_id": "",
    "unit_name": "",
    "total_num": "",
    "leave_num": "",
    "price": "",
    "remark": "",
    "period_start": "",
    "period_date": "",
    "pool_type": "",
    "gift_type_name": "",
    "sourcecode": "",
    "modify_time": "",
    "create_time": ""
}

参数说明：

参数	类型	必填	说明
flow_no	VARCHAR(32)	否	流水号
cm_id	VARCHAR(32)	否	客户id
cm_code	varchar(100)	否	客户编码
cm_sourcecode	varchar(100)	否	客户sourcecode
pd_id	VARCHAR(32)	否	赠品id
pd_code	varchar(100)	否	赠品编码
unit_id	VARCHAR(32)	否	赠品单位id
unit_name	varchar(100)	否	赠品单位名称
total_num	NUMERIC(20,2)	否	赠品总量
leave_num	NUMERIC(20,2)	否	可用数量
price	NUMERIC(20,2)	否	赠品单价
remark	VARCHAR(32)	否	备注
period_start	VARCHAR(32)	否	使用开始日期。格式：yyyy-MM-dd
period_date	VARCHAR(32)	否	使用截止日期。格式：yyyy-MM-dd
pool_type	VARCHAR(32)	否	赠品类型id
gift_type_name	VARCHAR(100)	否	赠品类型名称
sourcecode	VARCHAR(32)	否	sourcecode
modify_time	VARCHAR(32)	否	更新时间。格式：yyyy-MM-dd HH:mm:ss
create_time	VARCHAR(32)	否	创建时间。格式：yyyy-MM-dd HH:mm:ss

响应示例：

{
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
return_code	int	响应编码。0：成功，1：失败
return_msg	String	响应说明

###赠品池扣减流水推送 请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
    "id": "",
    "flow_no": "",
    "pd_id": "",
    "pd_code": "",
    "unit_id": "",
    "unit_name": "",
    "minus_num": "",
    "minus_remark": "",
    "bill_no": "",
    "create_time": "",
    "creator_code": ""
}

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	扣减流水ID
flow_no	VARCHAR(32)	是	赠品池流水号
pd_id	VARCHAR(32)	否	赠品id（赠品id和赠品编码不能同时为空）
pd_code	VARCHAR(32)	否	赠品编码（赠品id和赠品编码不能同时为空）
unit_id	VARCHAR(32)	否	赠品单位id，必须为商品对应单位（单位id和单位名称不能同时为空）
unit_name	VARCHAR(32)	否	赠品单位名称，必须为商品对应单位（单位id和单位名称不能同时为空）
minus_num	NUMERIC(20,2)	是	扣减数量，≥0
minus_remark	VARCHAR(100)	否	扣减备注
bill_no	VARCHAR(32)	否	关联单据
create_time	VARCHAR(32)	否	创建时间
creator_code	VARCHAR(32)	否	创建人账号

响应示例：

{
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
return_code	int	响应编码。0：成功，1：失败
return_msg	String	响应说明

# 费用池增加流水推送

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
     "flow_no":"SR20200918000009",
     "cm_id":5950706195173244407,
     "cm_code":"",
     "cm_source_code":"",
     "rebate_account_id":7097038094955291930,
     "rebate_account_code":7097038094955291930,
     "rebate_amount_in":0.30,
     "rebate_leave_amount":0.10,
     "bill_id": "",
     "date": "",
     "rebate_type":999,
     "rebate_type_name":"外部接口写入",
     "remark":"",
     "rebate_period":"2020-10-16 00:00:00",
     "sourcecode":"",
     "create_time":"2020-09-18 13:34:18",
     "creator_id":998,
     "modify_time":"2020-09-18 13:34:18",
     "modifyier_id":998
}

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	增加流水id
flow_no	VARCHAR(32)	是	增加流水号
cm_id	VARCHAR(32)	否	客户id
cm_code	VARCHER(32)	否	客户编码
cm_source_code	VARCHER(32)	否	客户sourcecode
rebate_account_id	VARCHAR(32)	否	账户id
rebate_account_code	VARCHAR(32)	否	账户编码
rebate_amount_in	NUMERIC(20,2)	否	增加金额
rebate_leave_amount	NUMERIC(20,2)	否	剩余金额
bill_id	VARCHAR(32)	否	关联单据
date	VARCHAR(32)	否	业务时间[格式:yyyy-mm-dd hh24:mi:ss]
rebate_type	VARCHAR(32)	否	增加类型id
rebate_type_name	VARCHAR(100)	否	增加类型名称
remark	VARCHAR(32)	否	备注
rebate_period	VARCHAR(32)	否	使用有效期截止[格式:yyyy-mm-dd]
source_code	VARCHAR(32)	否	增加流水sourcecode
create_time	VARCHAR(32)	否	创建时间[格式:yyyy-mm-dd hh24:mi:ss.us]
creator_id	VARCHAR(32)	否	创建人
modify_time	VARCHAR(32)	否	变更时间[格式:yyyy-mm-dd hh24:mi:ss.us]
modifyier_id	VARCHAR(32)	否	变更人

响应示例：

{
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
return_code	int	响应编码。0：成功，1：失败
return_msg	String	响应说明

# 费用池扣减流水推送

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
     "oflow_no":"SR20200918000009",
     "cm_id":5950706195173244407,
     "rebate_account_out":7097038094955291930,
     "reduce_amount":0.30,
     "rebate_type":999,
     "rebate_type_name":"外部接口写入",
     "remark":"",
     "iflow_no":"SR20200918000019",
     "create_time":"2020-09-18 13:34:18",
     "creator_id":998
}

参数说明：

参数	类型	必填	说明
oflow_no	VARCHAR(32)	是	减少流水号
cm_id	VARCHAR(32)	否	客户id
cm_code	VARCHER(32)	否	客户编码
cm_source_code	VARCHER(32)	否	客户sourcecode
rebate_account_id	VARCHAR(32)	否	账户id
rebate_account_code	VARCHAR(32)	否	账户编码
reduce_amount_out	NUMERIC(20,2)	否	扣减金额
bill_id	VARCHAR(32)	否	关联单据
date	VARCHAR(32)	否	业务时间[格式:yyyy-mm-dd hh24:mi:ss]
rebate_type	VARCHAR(32)	否	扣减类型id
rebate_type_name	VARCHAR(100)	否	扣减类型名称
remark	VARCHAR(32)	否	备注[扣减原因]
iflow_no	VARCHAR(32)	否	对应增加流水号
create_time	VARCHAR(32)	否	创建时间[格式:yyyy-mm-dd hh24:mi:ss.us]
creator_id	VARCHAR(32)	否	创建人

响应示例：

{
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
return_code	int	响应编码。0：成功，1：失败
return_msg	String	响应说明

← 费用池/赠品池/代金券优惠券相关接口 →