# 促销接口

# 活动方案新增

接口说明:仅支持增无需兑付方案类型并需要申请参加的活动方案

请求方式:** POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/addPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)

请求包体:

{
    "code": "CX201912196386",
    "name": "方案",
    "plan_type": "市场活动",
    "description": "方案描述",
    "start_date": "2019-12-01",
    "end_date": "2019-12-30",
    "form_define": "上报模板",
    "applied_range": "市场部,后勤部",
    "emp_code": "wym",
    "visit_execute_flag ":"0"
}

请求说明

参数 类型 必填 说明
code varchar(100) 方案编码
name varchar(100) 方案名称
plan_type varchar(100) 方案类型
description varchar(4000) 方案说明
start_date varchar(32) 方案执行开始日期(格式:YYYY-MM-DD)
end_date varchar(32) 方案执行结束日期(格式:YYYY-MM-DD)
form_define varchar(100) 上报模板名称(传系统中已存在的上报模板)
applied_range varchar(4000) 方案可见范围(传系统中已存在的部门,多个部门时逗号分隔)
emp_code varchar(100) 员工登录账号
visit_execute_flag varchar(100) 拜访执行要求 0-每次拜访时不强制必须执行 1-每次拜访时都必须执行 2-在执行期间第1次拜访时必须执行 3-在执行期间前2次拜访时必须执行 4-在执行期间前3次拜访时必须执行 5-在执行期间前4次拜访时必须执行 6-在执行期间前5次拜访时必须执行; 默认为1

响应信息

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data": null
}
参数 说明
return_code 响应编码
return_msg 响应信息
msg_id 消息ID

# 活动申请新增

接口说明:仅支持无需兑付方案类型的活动申请数据。第三方同步过来的为已审核的记录,没有启用流程审批的申请单才能写入。

请求方式:** POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/addActivityApply/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)

请求包体:

{
    "plan_code": "CX20191218873",
    "activity_code": "SQ201912180022",
    "activity_name": "双十一",
    "cm_list": [{ "cm_code": "CUS000001",  
                 "start_date": "2019-12-18",  
                 "end_date": "2019-12-20"   
                },
                { "cm_code": "CUS010122",  
                 "start_date": "2019-12-18",  
                 "end_date": "2019-12-20"   
                }],
    "emp_code": "wym"
}

参数说明

参数 类型 必填 说明
plan_code VARCHAR(100) 促销方案编码
activity_code VARCHAR(100) 活动申请编号
activity_name VARCHAR(100) 申请活动名称
cm_list[].cm_code VARCHAR(100) 客户编码
cm_list[].start_date VARCHAR(100) 执行开始日期(格式:YYYY-MM-DD)
cm_list[].end_date VARCHAR(100) 执行结束日期(格式:YYYY-MM-DD)
emp_code varchar100 员工登录账号

响应信息

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data": null
}
参数 说明
return_code 响应编码
return_msg 相应信息
msg_id 消息ID

# 活动方案启用

接口说明:活动方案启用。仅支持无需兑付的活动启用,当传入的方案编码为需要兑付的活动启用时返回错误。

请求方式:** POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/startPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)

请求包体:

{
    "code": "CX20191218873",
    "end_date": "2019-12-25"
}

参数说明

参数 类型 必填 说明
code VARCHAR(100) 方案编码
end_date VARCHAR(100) 活动结束日期

响应信息

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data": null
}
参数 说明
return_code 响应编码
return_msg 相应信息
msg_id 消息ID

# 活动方案终止

接口说明:活动方案终止

请求方式:** POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/stopPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)

请求包体:

{
    "code": "CX20191218873"
}

参数说明

参数 类型 必填 说明
code VARCHAR(100) 方案编码

响应信息

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data": null
}
参数 说明
return_code 响应编码
return_msg 相应信息
msg_id 消息ID

# 促销活动申请审批结果写入接口

接口说明:当活动申请单在第三方审核通过后,通过此接口写入审核结果 ,没有启用流程审批的单子才能写入,否则报错。

请求方式:** POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/auditActivityBy3rd/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)

请求包体:

{
   "activity_id":"7479273995003715336",
   "audit_status":"1",
   "audit_reason":"审核通过",
   "auditor_code":"zcl",
   "audit_time":"2019-12-01 18:00:00"
}

参数说明

参数 类型 必填 说明
activity_id VARCHAR(100) 活动ID
audit_status VARCHAR(100) 审核结果 1-审核通过/2-打回
audit_reason VARCHAR(100) 审核意见
auditor_code VARCHAR(100) 审核人 审核人在365中的登录账号中必须存在。
audit_time VARCHAR(100) 审核时间 (格式:YYYY-MM-DD HH:MM:SS)

响应信息

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data": null
}
参数 说明
return_code 响应编码
return_msg 相应信息
msg_id 消息ID

# 更新付费协议pdf接口

接口说明:当需要协议签署需要第三方落章时,通过此接口传入要签署的协议文件和甲方签署后的文件 请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/receiveThirdPdf/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)
请求包体:

{
    "dealid": "4915670982873944872",
    "file_url": "http://image-test.waiqin365.com/third_party/customer_contract_pdf/2019-11/26bb3ebe2b624a4ca788525c35f61724.pdf",
    "file_type": "0",
    "sign_b_postions":[ {
    "page_num":"2",
    "pos_x":"300",
    "pos_y":"600"
    }]
}

参数说明:

参数 类型 必填 说明
dealid VARCHAR(32) 活动申请明细ID
file_url VARCHAR(4000) 签署文件URL
file_type VARCHAR(1) 协议类型(0-新生成的PDF 1-甲方落章的PDF)
sign_b_key VARCHAR(255) 乙方签署关键字 file_type=0时,sogn_b_key和sign_b_position至少一个非空
sign_b_postions 乙方签署坐标位置 file_type=0时,sogn_b_key和sign_b_position至少一个非空
sign_b_postions[].page_num VARCHAR(32) 乙方签署页码
sign_b_postions[].pos_x VARCHAR(32) 乙方签署横坐标
sign_b_postions[].pos_y VARCHAR(32) 乙方签署纵坐标

返回结果:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

# 兑付执行新增

接口说明:接收第三方系统的兑付执行数据 请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/savePayExecution/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)
请求包体:

{
    "activityId": "5641319548657049388",
    "cmId": "7475146111689843554",
    "cmCode": "",
    "cmName": "",
    "firstPayDate":"2020-11-17 20:55:00",
    "reportType": "端架陈列",
   "linkmanMobile":"",
   "signType":"0",
    "executionType": "2",
    "userCode": "sj",
    "execution_re": [
        {
            "itemName":"海报DM",
            "pdCode": "",
            "unitName": "",
           "actualItemValue":"10"
        }
    ]
}

参数说明:

参数 类型 必填 说明
activityId VARCHAR(32) 申请单ID
cmId VARCHAR(32) 客户ID (客户id和客户编码、名称必须传一个 )
cmCode VARCHAR(32) 客户编码 (客户id和客户编码、名称必须传一个 )
cmName VARCHAR(200) 客户名称 (客户id和客户编码、名称必须传一个 )
firstPayDate VARCHAR(32) 兑付时间 格式:"YYY-MM-DD hh:mm:ss"
reportType VARCHAR(1) 录入终端(1.手机端 2.电脑端)
signType VARCHAR(1) 签收方式( 0. (空) 1.短信验证码 2.手写签字 3.手写签字+短信验证码)
linkmanMobile VARCHAR(32) 接收短信验证码的手机号
executionType VARCHAR(1) 兑付状态(1.全部兑付完成 2.兑付未完成)
userCode VARCHAR(100) 创建人(传系统中存在的登录账号)
execution_re[].itemName VARCHAR(100) 付费项目名称(必须和申请时的付费项目一致)
execution_re[].pdCode VARCHAR(32) 兑付商品编码 (现金时不传 商品时必传)
execution_re[].unitName VARCHAR (32) 兑付商品单位 (现金时不传 商品时必传)
execution_re[].actualItemValue VARCHAR (32) 兑付金额/数量

返回结果:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

# 活动方案修改

接口说明:仅支持修改无需兑付方案类型并需要申请参加的活动方案,非必填项传空时,不更新

请求方式:** POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/modifyPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)

请求包体:

{
    "code": "CX201912196386",
    "name": "方案",
    "description": "方案描述",
    "start_date": "2019-12-01",
    "end_date": "2019-12-30",
    "applied_range": "市场部,后勤部",
    "emp_code": "wym",
    "visit_execute_flag ":"0"
}

请求说明

参数 类型 必填 说明
code varchar(100) 方案编码
name varchar(100) 方案名称
description varchar(4000) 方案说明
start_date varchar(32) 方案执行开始日期(格式:YYYY-MM-DD)
end_date varchar(32) 方案执行结束日期(格式:YYYY-MM-DD)
applied_range varchar(4000) 方案可见范围(传系统中已存在的部门,多个部门时逗号分隔)
emp_code varchar(100) 员工登录账号
visit_execute_flag varchar(100) 拜访执行要求 0-每次拜访时不强制必须执行 1-每次拜访时都必须执行 2-在执行期间第1次拜访时必须执行 3-在执行期间前2次拜访时必须执行 4-在执行期间前3次拜访时必须执行 5-在执行期间前4次拜访时必须执行 6-在执行期间前5次拜访时必须执行; 默认为1

响应信息

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data": null
}
参数 说明
return_code 响应编码
return_msg 响应信息
msg_id 消息ID

# 活动申请移除客户

接口说明:移除无需兑付的活动申请明细。不判断客户的执行周期,无论当前客户的执行周期是未开始、执行中还是已结束都可以移除,移除时把客户申请数据和活动上报记录都一起删除,并记录客户移除日志

请求方式:** POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/removeCus/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)

请求包体:

{
    "apply_code": "SQ202011160001",
    "cus_code": "CUS010119",
    "emp_code": "zcl"
}

请求说明

参数 类型 必填 说明
apply_code varchar(32) 申请单号
cus_code varchar(32) 客户编码
emp_code varchar(100) 员工登录账号

响应信息

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data": null
}
参数 说明
return_code 响应编码
return_msg 响应信息
msg_id 消息ID