# 促销接口

# 付费陈列方案新增

接口说明:仅支持付费陈列的活动方案写入。不支持关联预算的付费陈列活动,也不支持方案的自定义字段

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/addDisplayPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "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",
    "input_items":"货架,海报",
    "cash_mode":"2",
    "cash_pd_list":[
    {"code":"EA0000121","price":"10"},
    {"code":"EA0000122","price":"20"}]
}
说明: 本示例仅供参考。

请求说明

参数 类型 必填 说明
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
input_items varchar(100) 指定付费项目,多个时逗号分隔。付费项目在系统中不存在时,自动添加一个付费项目
cash_mode varchar(100) 兑付费用方式。支持传两种,“仅现金”和“仅商品”
cash_pd_list List 兑付商品列表
cash_pd_list.code varchar(100) 兑付商品编码(多个),兑付方式为“仅商品”时必须有值
cash_pd_list.price 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/addPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "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/addRegularPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "code": "CX202204281282",
    "name": "CX202204281282",
    "planTypeName": "xxx方案类型",
    "description": "这是方案说明",
    "startDate": "2022-04-01",
    "endDate": "2022-04-30",
    "recordFormName": "这是上报模板",
    "specificPds": "1001000268, 1001000269, 1001000270",
    "gifts": "1001000268, 1001000269, 1001000270",
    "applyRangeDeptCode": "120, agent",
    "applyRangeDeptName": "南京办, 上海办",
    "visitExeFlag": "0",
    "payTypeName": "现金",
    "applyStartDate": "2022-04-30",
    "applyEndDate": "2022-04-30",
    "verifyEndDate": "2022-04-30",
    "empCode": "njtest",
    "extColums": [{
        "ext_key": "",
        "ext_value": ""
    }]
}


说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
code VARCHAR(100) 方案编码
name VARCHAR(100) 方案名称
planTypeName VARCHAR(100) 方案类型
description VARCHAR(4000) 方案说明
startDate VARCHAR(32) 执行开始日期(格式:YYYY-MM-DD,开始日期不能大于结束日期)
endDate VARCHAR(32) 执行结束日期(格式:YYYY-MM-DD)
recordFormName VARCHAR(100) 上报模板(如果方案类型支持上报,上报模板为空时,读取方案类型上的默认模板,没有默认模板系统报错)
specificPds VARCHAR(4000) 活动商品(仅支持传具体商品编码,多个商品时英文逗号分隔)
gifts VARCHAR(4000) 活动赠品(仅支持传具体商品编码,多个商品时英文逗号分隔)
applyRangeDeptCode VARCHAR(4000) 申请范围部门编码(传系统中已存在的部门,多个部门时逗号分隔,申请范围部门编码非空,取编码,否则申请范围部门名称)
applyRangeDeptName VARCHAR(4000) 申请范围部门名称(传系统中已存在的部门,多个部门时逗号分隔,匹配到多个返回错误:部门名称重复)
visitExeFlag VARCHAR(32) 拜访执行要求(需要上报的方案类型,必须)0:每次拜访时不强制必须执行1: 每次拜访时都必须执行2:在执行期间第1次拜访时必须执行3:在执行期间前2次拜访时必须执行4:在执行期间前3次拜访时必须执行5:在执行期间前4次拜访时必须执行6:在执行期间前5次拜访时必须执行
payTypeName VARCHAR(100) 支付方式
applyStartDate VARCHAR(32) 申请开始日期(格式:YYYY-MM-DD)
applyEndDate VARCHAR(32) 申请截止日期(格式:YYYY-MM-DD)
verifyEndDate VARCHAR(32) 核销截止日期(格式:YYYY-MM-DD)
empCode VARCHAR(100) 员工账号(方案创建人)
extColums.ext_key VARCHAR(100) 自定义字段名称
extColums.ext_value VARCHAR(100) 自定义字段值

响应示例:

{
    "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 } 在线调试
请求示例:

{
    "scene": "1",
    "code": "CX201912196386",
    "name": "方案",
    "description": "方案描述",
    "start_date": "2019-12-01",
    "end_date": "2019-12-30",
    "applied_range": "市场部,后勤部",
    "input_items":"货架,海报",
    "emp_code": "wym",
    "visit_execute_flag":"0"
}
说明: 本示例仅供参考。

请求说明

参数 类型 必填 说明
scene varchar(100) 活动场景,支持传0-市场活动、1-付费陈列、9-万能促销活动
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) 申请可见范围(传系统中已存在的部门,多个部门时逗号分隔)
input_items varchar(100) 付费项目,多个付费项目逗号分隔。仅支持追加付费项目。付费项目在系统中不存在时,自动添加。仅付费陈列场景生效
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/startPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "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 } 在线调试
请求示例:

{
    "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/addDisplayActivity/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "plan_code": "CX202106081712",
    "activity_code": "SQ202106082026",
    "activity_name": "活动1712",
    "cm_list": [{ "cm_code": "CUS017269",  
		 "uper_dealer":"",
                 "start_date": "2021-06-01",  
                 "end_date": "2021-06-30",
                 "target_sale_quota":"500",
                 "item_list":[{
                 	"name":"端架",
                 	"desc":"股东大会",
                 	"pd_list":[{"code":"0","value":"10"}]
                 },{
                 	"name":"海报",
                 	"desc":"恢复健康",
                 	"pd_list":[{"code":"0","value":"12"}]
                 }]
                }],
    "emp_code": "zhouchunlin"
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
plan_code VARCHAR(100) 促销方案编码
activity_code VARCHAR(100) 活动申请编号
activity_name VARCHAR(100) 申请活动名称
cm_list List 列表
cm_list.cm_code VARCHAR(32) 客户编码
cm_list.uper_dealer VARCHAR(32) 费用代垫经销商编码。必须是系统中已存在的经销商
cm_list.start_date VARCHAR(100) 执行开始日期。格式:YYYY-MM-DD
cm_list.end_date VARCHAR(100) 执行结束日期。格式:YYYY-MM-DD
cm_list.target_sale_quota VARCHAR(100) 目标销额
cm_list.item_list List 列表
cm_list.item_list.name VARCHAR(100) 付费项目,一个客户支持多个付费项目,当付费陈列的申请必须传付费项目
cm_list.item_list.desc VARCHAR(1000) 执行要求。付费项目的执行要求有自定义字段时不支持导入,用中文分号作为换行符
cm_list.item_list.pd_list.code VARCHAR(32) 兑付商品编码,一个付费项目支持多个商品,商品编码必须在系统中存在。当方案的兑付费用方式为“仅现金”时,则code为0
cm_list.item_list.pd_list.unit VARCHAR(100) 兑付商品单位。单位必须在系统中存在,当方案的兑付费用方式为“仅商品”时,必传
cm_list.item_list.pd_list.value VARCHAR(100) 兑付数量/现金。当兑付方式为“仅商品”时,传数量,当兑付方式为“仅现金”时传现金
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/addActivityApply/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "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 List 列表
cm_list.cm_code VARCHAR(32) 客户编码
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/addRegularActivity/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "planCode": "CX202106081712",
    "activityCode": "SQ202106082026",
    "applicantCode": "hy",
  	"applyName": "",
  	"parentApplyCode": "",
    "subList": [{ "cusCode": "CUS017269",  
		 						 "dealerCode":"",
                 "startDate": "2021-06-01",  
                 "endDate": "2021-06-30",
                 "pdRangeType":"1",
                 "pdTypes":"",
                 "pdBrands":"",
                 "payerCode": "",
                 "pdCodes":"500",
                 "pdUnitName":"",
                 "pdSale":"",
                 "unitDiscount":"",
                 "discountPrice":"",
                 "pdSalesVolume":"",
                 "expectedSalesNum":"",
                 "pdSalesAmount":"",
                 "giftCode":"",
                 "giftUnitName":"",
                 "giftPrice":"",
                 "giftNum":"",
                 "budgetAmount":"",
                 "payMode":"",
                 "remark":"",
                 "extColumns":[{
                     "ext_key":"",
                     "ext_value":""
                 }]
        }]
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
planCode VARCHAR(100) 促销方案编码
activityCode VARCHAR(100) 活动申请编号
applicantCode VARCHAR(100) 申请人登录账号
applyName VARCHAR(100) 申请名称
parentApplyCode VARCHAR(32) 父申请单号
subList List 列表
subList.cusCode VARCHAR(32) 客户编码
subList.dealerCode VARCHAR(32) 费用代垫经销商编码
subList.startDate VARCHAR(100) 执行开始日期。格式:YYYY-MM-DD
subList.endDate VARCHAR(100) 执行结束日期。格式:YYYY-MM-DD
subList.pdRangeType VARCHAR(4000) 活动商品范围(0-和方案的活动商品一致;1-指定商品类型或品牌;2-指定具体商品)
subList.pdTypes VARCHAR(32) 活动商品类型(多个用英文下逗号分隔)
subList.pdBrands VARCHAR(4000) 活动品牌(多个用英文下逗号分隔)
subList.payerCode VARCHAR(32) 结算单位编码
subList.pdCodes VARCHAR(1000) 活动商品编码(支持多个,用英文逗号分隔)
subList.pdUnitName VARCHAR(32) 商品单位名称
subList.pdSale VARCHAR(32) 商品售价
subList.unitDiscount VARCHAR(32) 单位折让
subList.discountPrice VARCHAR(32) 折后价
subList.pdSalesVolume VARCHAR(32) 预计销量
subList.expectedSalesNum VARCHAR(32) 预计销量(标箱)
subList.pdSalesAmount VARCHAR(32) 预计销额
subList.giftCode VARCHAR(32) 赠品编码
subList.giftUnitName VARCHAR(32) 赠品单位
subList.giftPrice VARCHAR(32) 赠品价格
subList.giftNum VARCHAR(32) 赠品数量
subList.budgetAmount VARCHAR(32) 申请金额
subList.payMode VARCHAR(100) 支付方式
subList.remark VARCHAR(4000) 备注
subList.extColumns List 列表
subList.extColumns.ext_key VARCHAR(100) 自定义字段名称
subList.extColumns.ext_value VARCHAR(4000) 自定义字段值,当为多选时,用#分隔

参数说明:

{
    "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/removeRegularCus/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试

请求示例:

{
    "activityCode": "SQ202011160001",
    "cusCode": "CUS010119",
    "empCode": "zcl"
}
说明: 本示例仅供参考。
参数 类型 必填 说明
activityCode varchar(100) 申请单编号
cusCode varchar(32) 客户编码
empCode 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 } 在线调试
请求示例:

{
   "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 } 在线调试
请求示例:

{
    "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 List 乙方签署坐标位置。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/removeCus/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "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

# 兑付执行新增

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

{
    "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 List 列表
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/modifyExeCycle/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "scene": "display",
    "id":"6916424039566956578",
    "start_date": "2021-11-02",
    "end_date": "2021-11-04"
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 活动申请明细ID
scene VARCHAR(32) 活动场景:display-付费陈列,market-市场活动,regular-万能促销活动,entrance-进场费
start_date VARCHAR(32) 执行周期开始日期
end_date VARCHAR(32) 执行周期结束日期

响应示例:

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

# 宴席活动申请新增

接口说明:仅支持宴席活动的活动申请数据写入。如果方案对应的申请单模板支持流程审批,则根据员工账号走审批流;没有设置审批流时报错,如果不需要审批,企业可以提前设置自动审批流程

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/addFeastActivity/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "planCode": "CX202106081712",
    "activityCode": "SQ202106082026",
    "applicantCode": "lih",
  	"feastType":"婚宴",
  	"startDate":"2022-08-01",
  	"endDate":"2022-08-05",
  	"hostTime":"上午",
  	"host":"张三",
 		"contact":"13511111111",
  	"address":"江苏南京",
  	"predictTables":"10",
  	"executor":"lih",
  	"cmCode":"CUS00001",
  	"upperDealerCode":"",
  	"remark":"",
  	"extColumns":[{
                     "ext_key":"",
                     "ext_value":""
                 }],
    "pds": [{ 	
      	"useType": "公司赞助",  
		 		"pdCode":"lgdw002",
        "pdNum": "10",  
        "unit": "箱"
     }]
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
planCode VARCHAR(100) 促销方案编码
activityCode VARCHAR(100) 活动申请编号
applicantCode VARCHAR(100) 申请人登录账号
feastType VARCHAR(100) 宴席类型
startDate VARCHAR(100) 必填与否根据申请单字段配置判断,宴席开始日期。格式:YYYY-MM-DD
endDate VARCHAR(100) 必填与否根据申请单字段配置判断,宴席结束日期。格式:YYYY-MM-DD
hostTime VARCHAR(32) 必填与否根据申请单字段配置判断,举办时段:上午、中午、下午、晚上
host VARCHAR(100) 举办人姓名
contact VARCHAR(100) 举办人联系电话
address VARCHAR(1000) 必填与否根据申请单字段配置判断,举办人地址
predictTables VARCHAR(32) 预计开展桌数
executor VARCHAR(100) 执行人登录账号
cmCode VARCHAR(32) 供货方编码(编码必须在客户编码中存在)
upperDealerCode VARCHAR(32) 必填与否根据申请单字段配置判断,费用代垫经销商编码
remark VARCHAR(4000) 必填与否根据申请单字段配置判断,备注
extColumns List 列表
extColumns.ext_key VARCHAR(100) 自定义字段名称
extColumns.ext_value VARCHAR(4000) 自定义字段值,当为多选时,用#分隔
pds List 列表
pds.useType VARCHAR(32) 用酒类型
pds.pdCode VARCHAR(32) 商品编码
pds.pdNum VARCHAR(32) 预计数量
pds.unit VARCHAR(32) 商品单位

参数说明:

{
    "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/cuxiaoPlan/v1/feastAdd/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "code": "YX0826151302",
    "name":"API-宴席-02",
    "description": "API",
    "type_name": "701-宴席-加签",
    "report_form_name": "手动点击",
    "evaluate_form_name": "",
    "start_date": "2022-08-26",
    "end_date": "2022-08-26",
    "dept_codes": "BM21111601,XK081801",
    "feast_type_name": "生日宴,庆功宴",
    "brand_name": "",
    "pd_codes": "SP202201190002,SP202201270002",
    "allow_wine_back": "",
    "creator_code": "ht01"
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
code VARCHAR(100) 方案编码。唯一,不能重复
name VARCHAR(100) 方案名称
description VARCHAR(4000) 方案说明
type_name VARCHAR(100) 方案类型。方案类型必须在系统中存在,并且必须有对应的申请单模板
report_form_name VARCHAR(100) 上报模板名称,为空时取方案类型上的默认上报模板,默认上报模板为空时则必填
evaluate_form_name VARCHAR(100) 上报评价模板名称,为空时取方案类型上的默认上报评价模板
start_date VARCHAR(32) 方案执行开始日期(开始日期不能大于结束日期)。格式“yyyy-MM-dd”
end_date VARCHAR(32) 方案执行结束日期。格式“yyyy-MM-dd”
dept_codes VARCHAR(4000) 申请范围部门编码(传系统中已存在的部门,多个部门时英文逗号分隔)
feast_type_name VARCHAR(4000) 宴席类型名称,多个逗号分隔
brand_name VARCHAR(200) 活动品牌
pd_codes VARCHAR(4000) 活动商品编码,多个英文逗号分隔。商品编码必须在商品信息中存在,如果品牌非空,必须是活动品牌下的商品
allow_wine_back VARCHAR(32) 允许用酒退码 0-否 1-是 默认为否
creator_code VARCHAR(100) 员工账号(方案创建人)

响应示例:

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

# 宴席扫码新增

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiaoScancode/v1/addFeastRecord/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "activity_code": "SQ202208250001",
    "creator_code":"ht01",
    "biz_id": "X08231704",
    "scan_type": "1",
    "rows": [
        {
            "wine_type_name": "公司赞助",
            "pd_code": "SP202109150005",
            "scan_code": "08260001",
            "unit_name": "瓶"
        }
    ]
}
说明: 本示例仅供参考。

参数说明:

参数 类型 必填 说明
activity_code VARCHAR(100) 申请单号,必须是系统中存在的宴席单号
creator_code VARCHAR(100) 员工账号(创建人)
biz_id VARCHAR(100) 外部唯一ID
scan_type VARCHAR(100) 扫码类型 1-用酒登记 2-用酒退码
rows[].wine_type_name VARCHAR(100) 用酒类型
rows[].pd_code VARCHAR(100) 商品编码
rows[].scan_code VARCHAR(100)
rows[].unit_name VARCHAR(100) 码单位,必须在当前商品存在

响应示例:

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