TIP
- 付费陈列方案新增
- 市场活动方案新增
- 万能促销活动方案新增
- 活动方案修改
- 付费陈列和市场活动方案启用
- 付费陈列和市场活动方案终止
- 付费陈列活动申请新增
- 市场活动申请新增
- 万能促销活动活动申请新增
- 万能促销活动活动申请移除客户
- 促销活动申请审批结果写入接口
- 更新付费协议pdf接口
- 活动申请移除客户
- 兑付执行新增
- 活动申请明细执行周期修改
- 宴席活动申请新增
- 宴席申请移除
- 宴席方案新增
- 宴席方案修改
- 宴席扫码新增
- 审批额度写入
- 销售明细数据写入
- 万能促销申请审批接口
- 万能申请单头行自定义字段更新修改
- 供应商新增
- 供应商修改
- 供应商删除
- 万能促销活动(AP/CP)申请新增
- 万能促销活动(AP/CP)申请第三方修改审批状态
- 万能促销活动(AP/CP)申请自定义字段修改
# 促销接口
# 付费陈列方案新增
接口说明:仅支持付费陈列的活动方案写入。不支持关联预算的付费陈列活动,也不支持方案的自定义字段
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/addDisplayPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
请求说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
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 |
cus_apply_type | varchar(32) | 否 | 客户多次申请。1-不允许;2-允许,执行周期不能交叉;3-允许,执行周期可以交叉;4-允许,同付费项目执行周期不能交叉。不填默认为3 |
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) | 否 | 兑付商品成本价(多个),可以为空,兑付方式为“仅商品”时可写入 |
ext_data | List | 自定义字段数据 | |
ext_data.ext_key | varchar(100) | 否 | 自定义字段key |
ext_data.ext_value | 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 | 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 |
cus_apply_type | varchar(32) | 否 | 客户多次申请。1-不允许;2-允许,执行周期不能交叉;3-允许,执行周期可以交叉。不填默认为3 |
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 | 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次拜访时必须执行 |
itemNames | VARCHAR(4000) | 否 | 付费项目名称,多个时英文逗号分隔。仅支持传付费项目的范围,付费项目在系统中不存在时,自动添加一个付费项目 |
payTypeName | VARCHAR(100) | 否 | 支付方式 |
planBudgetAmount | NUMERIC(20,2) | 否 | 方案总金额 |
predictEffectiveRatio | NUMERIC(20,2) | 否 | 预计费效比 |
predictSaleAmount | NUMERIC(20,2) | 否 | 预计销售额 |
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) | 否 | 自定义字段值 |
applyRangeEmpCode | VARCHAR(32) | 否 | 申请范围人员编码(传系统中已存在的员工账号,多个时逗号分隔) |
reportRangeDeptCode | VARCHAR(32) | 否 | 上报可见范围部门编码。部门编码(传系统中已存在的部门,多个部门时逗号分隔,部门编码非空取编码,否则取上报可见范围部门名称) |
reportRangeEmpCode | VARCHAR(32) | 否 | 上报可见范围人员编码(传系统中已存在的员工账号,多个时逗号分隔) |
reportRangeDeptName | 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 }
在线调试
请求示例:
请求说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
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 |
exts | List | 列表 | |
exts.ext_key | varchar(100) | 是 | 扩展字段名称 |
exts.ext_value | 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/startPlan/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
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 | 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 | VARCHAR(100) | 是 | 促销方案编码 |
activity_code | VARCHAR(100) | 是 | 活动申请编号 |
activity_name | VARCHAR(100) | 否 | 申请活动名称 |
activity_desc | VARCHAR(4000) | 否 | 陈列要求 |
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.activity_goods_range | VARCHAR(100) | 否 | 活动商品范围:3-和方案的活动商品一致;2-指定具体商品;1-指定商品范围(品牌、类型) |
cm_list.activity_goods_brand | VARCHAR(100) | 否 | 活动商品品牌;指定商品范围时,品牌和类型不能同时为空 |
cm_list.activity_goods_type | VARCHAR(100) | 否 | 活动商品类型;指定商品范围时,品牌和类型不能同时为空 |
cm_list.activity_pd_codes | 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) | 是 | 兑付数量/现金。当兑付方式为“仅商品”时,传数量,当兑付方式为“仅现金”时传现金 |
cm_list.item_list.ext_data | List | 自定义字段数据 | |
cm_list.item_list.ext_data.ext_key | varchar(100) | 否 | 自定义字段key |
cm_list.item_list.ext_data.ext_value | varchar(100) | 否 | 自定义字段值,当为多选时,用#分隔 |
cm_list.remark | VARCHAR(4000) | 否 | 客户申请行备注 |
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 | 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 | VARCHAR(100) | 是 | 方案编码 |
projectApplyCode | VARCHAR(32) | 否 | 申请批号 |
activityCode | VARCHAR(100) | 是 | 申请单号 |
applicantCode | VARCHAR(100) | 是 | 申请人登录账号 |
applyName | VARCHAR(100) | 否 | 申请名称 |
parentApplyCode | VARCHAR(32) | 否 | 父申请单号 |
subList | List | 列表 | |
subList.cusCode | VARCHAR(32) | 是 | 客户编码 |
subList.dealerCode | VARCHAR(32) | 否 | 费用代垫经销商编码 |
subList.cmManagerCode | 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.cmReceiveCode | 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 | 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 | 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 | 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 | 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 | 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 }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
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 | 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) | 否 | 必填与否根据申请单字段配置判断,备注 |
lonLat | VARCHAR(100) | 否 | 举办地经纬度,坐标格式为"纬度,经度" |
operator_address | VARCHAR(100) | 否 | 举办地经纬度对应地址(如果lonLat不为空,则operator_address为必填) |
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) | 是 | 商品单位 |
province | VARCHAR(32) | 否 | 举办地行政区域-省份名称 |
city | VARCHAR(32) | 否 | 举办地行政区域-城市名称 |
area | 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/cuxiao/v1/removeFeastActivity/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
请求说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
activityCode | varchar(32) | 是 | 申请单号 |
参数说明:
{
"return_code": 0,
"return_msg": "",
"msg_id": "{ msg_id }",
"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 | 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-是 默认为否 |
allow_area | List | 否 | 宴席开展区域(支持多组) |
allow_area.province | VARCHAR(100) | 否 | 宴席开展区域省份名称 |
allow_area.city | VARCHAR(100) | 否 | 宴席开展区域城市名称 |
allow_area.district | VARCHAR(100) | 否 | 宴席开展区域区县名称 |
apply_start_date | VARCHAR(32) | 否 | 申请开始日期 |
apply_end_date | VARCHAR(32) | 否 | 申请截止日期 |
creator_code | VARCHAR(100) | 是 | 员工账号(方案创建人) |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
# 宴席方案修改
接口说明:根据方案编码修改。地区:传空数组,会更新成[],不传就不更新;其他字段:不传或者传了空字符串,都不更新。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoPlan/v1/feastUpdate/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
code | VARCHAR(100) | 是 | 方案编码。唯一,不能重复 |
name | VARCHAR(100) | 否 | 方案名称 |
description | VARCHAR(4000) | 否 | 方案说明 |
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-是 默认为否 |
allow_area | List | 否 | 宴席开展区域(支持多组) |
allow_area.province | VARCHAR(100) | 否 | 宴席开展区域省份名称 |
allow_area.city | VARCHAR(100) | 否 | 宴席开展区域城市名称 |
allow_area.district | VARCHAR(100) | 否 | 宴席开展区域区县名称 |
apply_start_date | VARCHAR(32) | 否 | 申请开始日期 |
apply_end_date | VARCHAR(32) | 否 | 申请截止日期 |
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 | 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>>"
}
# 审批额度写入
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiao/audit/v1/syncAuditAmount/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
emp_code | VARCHAR(100) | 是 | 员工登录账号,唯一值 |
ext_cols[].ext_key | VARCHAR(100) | 是 | 审批额度字段名,中文名 |
ext_cols[].ext_value | VARCHAR(100) | 是 | 审批额度字段值 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
# 销售明细数据写入
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoSale/v1/addSaleInfo/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
bizDate | VARCHAR(32) | 是 | 业务日期,格式:yyyy-MM-dd |
empCode | VARCHAR(32) | 是 | 员工编码,该条记录的创建人 |
receiptCode | VARCHAR(100) | 是 | 单据编号 |
cmCode | VARCHAR(32) | 是 | 客户编码 |
vendorCode | VARCHAR(32) | 否 | 供货商编码 |
managerCode | VARCHAR(32) | 是 | 客户经理编码 |
pdCode | VARCHAR(32) | 是 | 商品编码 |
unitName | VARCHAR(32) | 是 | 商品单位名称 |
pdNum | VARCHAR(100) | 是 | 商品数量,不可以为0,可以是小数 |
price | VARCHAR(100) | 否 | 价格,不可以为负数,可以是小数 |
saleAmount | VARCHAR(100) | 是 | 订单金额,可以是小数 |
saleType | VARCHAR(32) | 是 | 直营/分销:ZY-直营、FX-分销 |
receiptType | VARCHAR(32) | 是 | 单据类型:ZY_SENT-直营发货单、FX_SENT-分销发货单、CAR_DISTRIBUTE-车铺销售单、CAR_SALE-分销车销单、TH-退货单、OTHER-其他 |
remark | VARCHAR(4000) | 否 | 备注 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
# 万能促销申请审批接口
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoAudit/v1/auditRegularActivity/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
applyId | VARCHAR(32) | 否 | 申请单id,申请单ID和申请单号必须传一个 |
applyCode | VARCHAR(200) | 否 | 申请单号,申请单ID和申请单号必须传一个 |
approverId | VARCHAR(32) | 否 | 审批人账号id,审批人id和编码必须传一个 |
approverCode | VARCHAR(100) | 否 | 审批人账号编码,审批人id和编码必须传一个 |
verifyType | VARCHAR(32) | 是 | 审批状态:1-通过 0-打回 |
reason | VARCHAR(4000) | 否 | 审批意见 |
updateSubs | List | 否 | |
updateSubs.subId | VARCHAR(100) | 是 | 申请明细ID。修改申请金额时需要传这个参数,修改哪一行就传哪一行 |
updateSubs.applyAmount | NUMERIC(20,2) | 是 | 申请金额。修改申请金额时需要传这个参数 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
# 万能申请单头行自定义字段更新修改
接口说明:支持申请单头行自定义字段的更新。传哪个字段就更新哪个字段,必须有一个有效的自定义字段的更新。申请单号必填。当仅更新申请单的自定义字段时,申请明细列表可以不传。当仅更新申请明细行的自定义字段时,申请单的自定义字段列表可以不传。附件、图片不支持写入。字段类型:客户、商品、人员、下拉框、单选框、多选框需要做合法性校验、必填项为空不允许修改。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoRegular/v1/updateRegularExt/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
activityCode | VARCHAR(200) | 是 | 申请单号 |
exts | List | 申请单自定义字段集合 | |
exts.ext_key | VARCHAR(100) | 否 | 申请单主数据扩展字段名称 |
exts.ext_value | VARCHAR(100) | 否 | 申请单主数据扩展字段数据值 |
subList | List | 申请行集合 | |
subList.id | VARCHAR(32) | 否 | 申请明细行ID |
subList.exts | List | 申请行明细数据扩展字段列表 | |
subList.exts.ext_key | VARCHAR(100) | 否 | 申请行明细数据扩展字段名称 |
subList.exts.ext_value | VARCHAR(100) | 否 | 申请行明细数据扩展字段数据值 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
# 供应商新增
接口说明:供应商数据录入
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiao/field/v1/addSupplier/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
sourceCode | VARCHAR(32) | 是 | 来源第三方系统的唯一ID |
code | VARCHAR(32) | 是 | 供应商编码 |
name | VARCHAR(100) | 是 | 供应商名称 |
address | VARCHAR(100) | 是 | 详细地址 |
concatName | VARCHAR(100) | 是 | 联系人姓名 |
concatPhone | VARCHAR(32) | 是 | 联系人手机号 |
remark | VARCHAR(32) | 否 | 备注 |
enable | VARCHAR(32) | 否 | 停用状态 0-停用 1-启用 不传值时为启用状态 |
extColumns | List | 否 | 自定义字段列表 |
extColumns.ext_key | VARCHAR(100) | 否 | 自定义字段名称 |
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/field/v1/modifySupplier/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
sourceCode | VARCHAR(32) | 否 | 来源第三方系统的唯一ID,来源第三方系统的唯一ID和勤策系统ID必须有一个有值,两个同时有值时,优先取在的,优先取来源第三方系统的唯一ID |
id | VARCHAR(32) | 否 | 勤策系统ID,来源第三方系统的唯一ID和勤策系统ID必须有一个有值,两个同时有值时,优先取在的,优先取来源第三方系统的唯一ID |
code | VARCHAR(32) | 否 | 供应商编码 |
name | VARCHAR(100) | 否 | 供应商名称 |
address | VARCHAR(100) | 否 | 详细地址 |
concatName | VARCHAR(100) | 否 | 联系人姓名 |
concatPhone | VARCHAR(32) | 是 | 联系人手机号 |
remark | VARCHAR(32) | 否 | 备注 |
enable | VARCHAR(32) | 否 | 停用状态 0-停用 1-启用 不传值时为启用状态 |
extColumns | List | 否 | 自定义字段列表 |
extColumns.ext_key | VARCHAR(100) | 否 | 自定义字段名称 |
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/field/v1/deleteSupplier/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
sourceCode | VARCHAR(32) | 否 | 来源第三方系统的唯一ID,来源第三方系统的唯一ID和勤策系统ID必须有一个有值,两个同时有值时,优先取在的,优先取来源第三方系统的唯一ID |
id | VARCHAR(32) | 否 | 勤策系统ID,来源第三方系统的唯一ID和勤策系统ID必须有一个有值,两个同时有值时,优先取在的,优先取来源第三方系统的唯一ID |
参数说明:
{
"return_code": 0,
"return_msg": "",
"msg_id": "X0001",
"response_data": null
}
参数 | 说明 |
---|---|
return_code | 响应编码 |
return_msg | 响应信息 |
msg_id | 消息ID |
# 万能促销活动(AP/CP)申请新增
接口说明:万能促销活动(AP/CP)申请新增接口
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiao/v1/addApCpActivity/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
applyFormName | VARCHAR(100) | 是 | 申请单模板名称 |
activityCode | VARCHAR(32) | 是 | 申请单号 |
applicantCode | VARCHAR(100) | 是 | 申请人登录账号 |
applyName | VARCHAR(100) | 是 | 申请名称 |
managerCode | VARCHAR(100) | 是 | 负责人登录账号 |
cmCode | VARCHAR(32) | 否 | 客户编码 |
dealerCode | VARCHAR(32) | 否 | 费用代垫经销商编码 |
areaCode | VARCHAR(32) | 否 | 活动场地编码 |
supplierCode | VARCHAR(32) | 否 | 供应商编码 |
startDate | VARCHAR(100) | 否 | 执行开始日期。格式:YYYY-MM-DD |
endDate | VARCHAR(100) | 否 | 执行结束日期。格式:YYYY-MM-DD |
expectArriveNum | VARCHAR(32) | 否 | 预计到场人数 |
pdCodes | VARCHAR(100) | 否 | 活动商品编码多选用,分隔 |
pdUnitName | VARCHAR(100) | 否 | 商品单位名称 |
activityPrice | VARCHAR(32) | 否 | 活动价 |
pdSalesAmount | VARCHAR(32) | 否 | 预计销售额 |
pdSalesVolume | VARCHAR(32) | 否 | 预计销量 |
extColumns | List | 否 | 申请单自定义字段列表 |
extColumns.ext_key | VARCHAR(100) | 否 | 自定义字段名称 |
extColumns.ext_value | VARCHAR(4000) | 否 | 自定义字段值,当为多选时,用#分隔 |
subList | List | 申请明细列表 | |
subList.cmCode | VARCHAR(32) | 否 | 客户编码 |
subList.dealerCode | VARCHAR(32) | 否 | 费用代垫经销商编码 |
subList.areaCode | VARCHAR(32) | 否 | 活动场地编码 |
subList.supplierCode | VARCHAR(32) | 否 | 供应商编码 |
subList.startDate | VARCHAR(100) | 否 | 执行开始日期。格式:YYYY-MM-DD |
subList.endDate | VARCHAR(100) | 否 | 执行结束日期。格式:YYYY-MM-DD |
subList.payMode | VARCHAR(32) | 否 | 支付方式 |
subList.remark | VARCHAR(4000) | 否 | 申请备注 |
subList.subjectCode | VARCHAR(100) | 否 | 预算科目编码,申请单模板关联预算时,预算科目编码和预算科目名称至少有一个要填 |
subList.subjectName | VARCHAR(100) | 否 | 预算科目名称,申请单模板关联预算时,预算科目编码和预算科目名称至少有一个要填 |
subList.period | VARCHAR(32) | 否 | 预算期间,申请单模板关联预算时必填 |
subList.dimColumns | List | 否 | 预算期间动态维度列表,申请单模板关联预算且有动态维度时必填 |
subList.extColumns.dimName | VARCHAR(100) | 否 | 动态维度名称 |
subList.extColumns.dimValue | VARCHAR(4000) | 否 | 维度维度值 |
subList.applyAmount | VARCHAR(32) | 是 | 申请金额 |
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 |
# 万能促销活动(AP/CP)申请第三方修改审批状态
接口说明:根据申请单ID/申请单号进行审批,审批时调用平台的审批流,如果传的审批人和当前这张单子的审批人不一致,审批失败。当前节点手工指定下一审批人时,下一审批人默认是当前审批人。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoAudit/v1/auditRegularAPCPActivity/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
applyId | VARCHAR(32) | 否 | 申请单id,申请单ID和申请单号必须传一个 |
applyCode | VARCHAR(200) | 否 | 申请单号,申请单ID和申请单号必须传一个 |
approverId | VARCHAR(32) | 否 | 审批人账号id,审批人id和编码必须传一个 |
approverCode | VARCHAR(100) | 否 | 审批人账号编码,审批人id和编码必须传一个 |
verifyType | VARCHAR(32) | 是 | 审批状态:1-通过 0-打回 |
reason | VARCHAR(4000) | 否 | 审批意见 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
# 万能促销活动(AP/CP)申请自定义字段修改
接口说明:支持申请单头行自定义字段的更新。传哪个字段就更新哪个字段,必须有一个有效的自定义字段的更新。申请单号必填。当仅更新申请单的自定义字段时,申请明细列表可以不传。当仅更新申请明细的自定义字段时,申请单的自定义字段列表可以不传。附件、图片不支持写入。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoRegularAPCP/v1/updateRegularAPCPExt/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
activityCode | VARCHAR(200) | 是 | 申请单号 |
exts | List | 申请单自定义字段集合 | |
exts.ext_key | VARCHAR(100) | 否 | 申请单主数据扩展字段名称 |
exts.ext_value | VARCHAR(100) | 否 | 申请单主数据扩展字段数据值 |
subList | List | 申请行集合 | |
subList.id | VARCHAR(32) | 否 | 申请明细行ID |
subList.exts | List | 申请行明细数据扩展字段列表 | |
subList.exts.ext_key | VARCHAR(100) | 否 | 申请行明细数据扩展字段名称 |
subList.exts.ext_value | VARCHAR(100) | 否 | 申请行明细数据扩展字段数据值 |
响应示例:
{
"return_code": "0",
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}