促销数据同步

活动申请单推送

接口说明:用户在外勤365新建活动保存时候,外勤365会按照此接口调用第三方URl将该促销活动的信息同步过去。在活动申请提交、修改申请单提交、作废申请单、申请单审批流程完成(已审核)时都会调用,所以对同一个活动(活动ID相同),该接口可能会调用多次。

请求方式:** POST(HTTPS
请求地址: 第三方服务接口URL

请求参数:

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本,如:001
dataFormat 数据格式:json
dataSource 数据来源:biz 业务功能产生 api 开放接口产生
timestamp 请求时间戳,如:1503276678552
status 数据同步状态,0-数据首次同步 2-数据失败同步
statusTime 上次同步失败时间,格式:yyyy-MM-dd HH:mm:ss
tenantId 企业ID,各注册企业在外勤365中对应的唯一ID
digest 数据签名,md5(data
dataType cuxiao_activity
data <<请求数据体>> , 说明:格式为JSON格式数据

请求包体:

{
    "end_date":"2020-05-15",
    "activity_name":"SQ202004130035",
    "plan_type":"表单-字段组合",
    "create_time":"2020-04-13 15:12:25",
    "modify_time":"2020-04-16 11:19:59",
    "plan_code":"CX202004099284",
    "cm":[
        {
            "end_date":"2020-05-15",
            "code":"CUS010251",
            "protocol_id":"",
            "target_sale_quota":"",
            "linkman_mobile":"",
            "linkman":"",
            "inputList":[
                {
                    "protocol_pay_money":2000,
                    "item_describe":"SKU数:123;排面数:213123",
                    "name":"0147-new",
                    "item_desc_array":[
                        {
                            "label_name":"SKU数",
                            "label_val_show":"10"
                        },
                        {
                            "label_name":"排面数",
                            "label_val_show":"10"
                        }
                    ],
                    "pd_data":[
                        {
                            "pd_id":"5239771055067925102",
                            "pd_name":"NEW-多个价格-基本单位+辅助单位",
                            "pd_code":"NEW",
                            "pro_unit_name":"",
                            "item_value":"",
                            "pd_spec":"规格1",
                            "pd_sales_price":"11.00",
                            "item_type":"商品"
                        },
                        {
                            "pd_id":"0",
                            "pd_name":"",
                            "pd_code":"",
                            "pro_unit_name":"",
                            "item_value":"2000.00",
                            "pd_spec":"",
                            "pd_sales_price":"",
                            "item_type":"现金"
                        }
                    ]
                }
            ],
            "show_content":"电子签章-高级版-使用范围:QQ1下级--柠云",
            "name":"111111",
            "id":"5893917317653168258",
            "addr":"",
            "protocol_code":"XY20200413000042",
            "start_date":"2020-04-13",
            "status":"1"
        }
    ],
    "form_data_id":8232510941689130139,
    "plan_name":"Android系统校验-6.5.2",
    "audit_time":"2020-04-13 18:42:43",
    "audit_id":"-10000",
    "assign_form":7507485083472022385,
    "has_activity":"1",
    "modifyier_id":"7592966989935850147",
    "creator_id":"7592966989935850147",
    "name":"Android系统校验-6.5.2",
    "id":"7837369179309678060",
    "audit_reason":"04-13-测试",
    "districtIds":[

    ],
    "plan_id":"7570251468539066775",
    "activity_status":"0",
    "status":"1",
    "start_date":"2020-04-09"
}

请求说明

参数 类型 必填 说明
id int8 活动id
status char1 状态1正常 0删除
creator_id int8 创建人
create_time 日期(时间) 创建时间
modifyier_id int8 修改人
modify_time 日期(时间) 修改时间
plan_id int8 促销方案ID
plan_code varchar100 促销方案编码
plan_name varchar100 促销方案名称
plan_type varchar100 促销方案类型
start_date 日期 开始日期yyyy-MM-dd
end_date 日期 结束日期yyyy-MM-dd
activity_name varchar100 活动申请名称
activity_code varchar100 活动申请编码
activity_status char1 活动状态 9待提交、0处理中、1已批准、2已打回、3审批中 、4-作废
audit_id int8 审核人
audit_time 日期(时间) 审核时间
audit_reason varchar1000 拒绝原因
has_activity varchar1 是否需要申请 1-需要申请 2-不需要申请
assign_form int8 申请单叠加表单模板ID
form_data_id int8 申请叠加表单数据ID
cm[].id int8 参与门店的Id
cm[].code varchar100 参与门店的编码
cm[].name varchar100 参与门店的名称
cm[].show_content varchar100 甲方配置中的公司名称
cm[].linkman varchar100 客户主联系人姓名
cm[].linkman_mobile varchar100 客户主联系人手机号
cm[].addr varchar100 客户详细地址
cm[].target_sale_quota varchar100 销售目标金额
cm[].start_date varchar100 活动申请执行开始日期 格式:yyyy-MM-dd
cm[].end_date varchar100 活动申请执行结束日期 格式:yyyy-MM-dd
cm[].protocol_id varchar100 协议ID
cm[].protocol_code varchar100 协议编号
cm[].status varchar1 活动明细删除状态
cm[].inputList[].name varchar100 付费项目名称
cm[].inputList[].item_describe varchar100 付费项目执行要求
cm[].inputList[].item_desc_array[].label_name varchar100 执行要求字段名称
cm[].inputList[].item_desc_array[].label_val_show varchar100 执行要求字段显示值
cm[].inputList[].protocol_pay_money varchar100 协议兑付金额,当兑付商品时,是按数量*商品售价的合计
cm[].inputList[].pd_data[].item_type varchar1 兑付方式(( 1.现金/2.商品)
cm[].inputList[].pd_data[].pd_id varchar100 兑付商品ID
cm[].inputList[].pd_data[].pd_code varchar100 商品编码
cm[].inputList[].pd_data[].pd_name varchar100 商品名称
cm[].inputList[].pd_data[].pd_spec varchar100 规格属性
cm[].inputList[].pd_data[].pro_unit_name varchar100 协议兑付商品单位
cm[].inputList[].pd_data[].item_value varchar100 协议兑付金额/数量
cm[].inputList[].pd_data[].pd_sales_price varchar100 商品售价

响应信息

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

促销记录上报

接口说明:用户在手机端上报促销记录的时候,外勤365会调用此接口发送数据到第三方URL

请求方式:** POST(HTTPS
请求地址: 第三方服务接口URL

请求参数:

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本,如:001
dataFormat 数据格式:json
dataSource 数据来源:biz 业务功能产生 api 开放接口产生
timestamp 请求时间戳,如:1503276678552
status 数据同步状态,0-数据首次同步 2-数据失败同步
statusTime 上次同步失败时间,格式:yyyy-MM-dd HH:mm:ss
tenantId 企业ID,各注册企业在外勤365中对应的唯一ID
digest 数据签名,md5(data
dataType cuxiao_record
data <<请求数据体>> , 说明:格式为JSON格式数据

请求包体:

{
    "plan_id": "7226626906295451231",
    "plan_code": "11.11",
    "plan _name ": "双十一大促",
    "activity_id ": "5277027684278203306",
    "activity_name ": "江苏区决战双十一",
    "activity_code ": "code_12323",
    "record_id": "5232948793149090911",
    "record_status ": "1",
    "create_time": "2015-11-15 13:50:18",
    "emp_id": " 5277027684278203306",
    "emp_name": "张三",
    "cm_id": " 5277027684278203306",
    "cm_name": "大润发龙江店",
    "data_id":"5277027684278203306",
    "form_define_id":"form_define_id",
    "data": [
        {
            "label": "舒眠沐浴露300ml是否分销",
            "value": "否",
            "type": "radioType"
        }
    ]
}

参数说明

参数 类型 必填 说明
plan_id VARCHAR(32) 促销方案ID
plan_code VARCHAR(100) 促销方案编码
plan_name VARCHAR(100) 促销方案名称
activity_id VARCHAR(32) 活动ID
activity_name VARCHAR(100) 活动名称
activity_code VARCHAR(100) 活动申请编号
record_id VARCHAR(32) 上报记录的ID
record_status CHAR(1) 核准状态0合格 1不合格
data[].label VARCHAR(100) 填报项目名称
data[].type VARCHAR(100) 填报项的控件类型
"radioType":单选框
"checkType ":多选框
"descType ":多行文本框
"photoType ":图片
data[].value VARCHAR(100) 填报项目值
create_time VARCHAR(32) 创建时间,格式: 'yyyy-MM-dd HH:mm:ss'
emp_id VARCHAR(32) 上报人ID(外勤365的ID)
emp_source_code VARCHAR(100) 上报人唯一标识(source_code)
emp_name VARCHAR(32) 上报人姓名
cm_id VARCHAR(32) 客户(门店)ID(外勤365的ID)
cm_source_code VARCHAR(100) 客户(门店)唯一标识(source_code)
cm_name VARCHAR(100) 客户(门店)名称
visit_implement_id VARCHAR(32) 拜访记录ID
data_id VARCHAR(32) 表单数据id
form_define_id VARCHAR(32) 表单id

响应信息

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

促销检核记录同步

接口说明:用户在手机端活动检核的时候,外勤365会调用此接口发送数据到第三方URL

请求方式:** POST(HTTPS
请求地址: 第三方服务接口URL

请求参数:

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本,如:001
dataFormat 数据格式:json
dataSource 数据来源:biz 业务功能产生 api 开放接口产生
timestamp 请求时间戳,如:1503276678552
status 数据同步状态,0-数据首次同步 2-数据失败同步
statusTime 上次同步失败时间,格式:yyyy-MM-dd HH:mm:ss
tenantId 企业ID,各注册企业在外勤365中对应的唯一ID
digest 数据签名,md5(data
dataType cuxiao_check
data <<请求数据体>> , 说明:格式为JSON格式数据

请求包体:

{
    "plan_id": "7226626906295451231",
    "plan_code": "11.11",
    "plan _name ": "双十一大促",
    "activity_id ": "5277027684278203306",
    "activity_name ": "江苏区决战双十一",
    "record_id": "5232948793149090911",
    "record_status ": "1",
    "create_time": "2015-11-15 13:50:18",
    "emp_id": " 5277027684278203306",
    "emp_name": "张三",
    "cm_id": " 5277027684278203306",
    "cm_name": "大润发龙江店",
    "data_id": " 5277027684278203306",
    "check_define_id": " 5277027684278203306",
    "data": [
        {
            "label": "舒眠沐浴露300ml是否分销",
            "value": "否",
            "type": "radioType"
        }
    ]
}

参数说明

参数 类型 必填 说明
plan_id VARCHAR(32) 促销方案ID
plan_code VARCHAR(100) 促销方案编码
plan_name VARCHAR(100) 促销方案名称
activity_id VARCHAR(32) 活动ID
activity_name VARCHAR(100) 活动名称
record_id VARCHAR(32) 检核记录的ID
record_status CHAR(1) 检核状态0合格 1不合格
data[].label VARCHAR(100) 填报项目名称
data[].type VARCHAR(100) 填报项的控件类型
"radioType":单选框
"checkType ":多选框
"descType ":多行文本框
"photoType ":图片
data[].value VARCHAR(100) 填报项目值
create_time VARCHAR(32) 创建时间,格式: 'yyyy-MM-dd HH:mm:ss'
emp_id VARCHAR(32) 上报人ID(外勤365的ID)
emp_source_code VARCHAR(100) 上报人唯一标识(source_code)
emp_name VARCHAR(32) 上报人姓名
cm_id VARCHAR(32) 客户(门店)ID(外勤365的ID)
cm_source_code VARCHAR(100) 客户(门店)唯一标识(source_code)
cm_name VARCHAR(100) 客户(门店)名称
visit_implement_id VARCHAR(32) 拜访记录ID
data_id VARCHAR(32) 表单数据id
check_define_id VARCHAR(32) 表单id

响应信息

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

促销门店移除

接口说明:用户在365中移除促销活动的参与门店时,会调用此接口。

请求方式:** POST(HTTPS
请求地址: 第三方服务接口URL

请求参数:

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本,如:001
dataFormat 数据格式:json
dataSource 数据来源:biz 业务功能产生 api 开放接口产生
timestamp 请求时间戳,如:1503276678552
status 数据同步状态,0-数据首次同步 2-数据失败同步
statusTime 上次同步失败时间,格式:yyyy-MM-dd HH:mm:ss
tenantId 企业ID,各注册企业在外勤365中对应的唯一ID
digest 数据签名,md5(data
dataType cuxiao_cm_remove
data <<请求数据体>> , 说明:格式为JSON格式数据

请求包体:

{
    "plan_id": "5232948793149090911",
    "remove_cm": [
        {
            "id": "9034357183552766140",
            "activity_id": "6288027684278203306"
        }
    ],
    "reason": "这些门店检查过了",
    "remove_time": "2015-11-1613: 50: 18",
    "user_id": "6288027684278203306",
    "user_name": "王五"
}

参数说明

参数 类型 必填 说明
plan_id Int8 方案ID
remove_cm[].activity_id Int8 活动ID
remove_cm[].id Int8 门店ID
reason VARCHAR(4096) 移除理由
remove_time VARCHAR(32) 操作时间
user_id Int8 操作人ID
user_name VARCHAR(32) 操作人姓名

响应信息

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

促销删除活动

接口说明:用户在365中删除活动时,会调用此接口。 请求方式:** POST(HTTPS
请求地址: 第三方服务接口URL

请求参数:

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本,如:001
dataFormat 数据格式:json
dataSource 数据来源:biz 业务功能产生 api 开放接口产生
timestamp 请求时间戳,如:1503276678552
status 数据同步状态,0-数据首次同步 2-数据失败同步
statusTime 上次同步失败时间,格式:yyyy-MM-dd HH:mm:ss
tenantId 企业ID,各注册企业在外勤365中对应的唯一ID
digest 数据签名,md5(data
dataType cuxiao_activity_delete
data <<请求数据体>> , 说明:格式为JSON格式数据

请求包体:

{
    "activity_id": "5232948793149090911"
}

参数说明

参数 类型 必填 说明
activity_id Int8 活动ID

响应信息

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

活动上报记录评价

接口说明:上级主管在活动上报记录评价时,外勤365会按照此接口调用第三方url将评价的结果发送过去。 请求方式:** POST(HTTPS
请求地址: 第三方服务接口URL

请求参数:

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本,如:001
dataFormat 数据格式:json
dataSource 数据来源:biz 业务功能产生 api 开放接口产生
timestamp 请求时间戳,如:1503276678552
status 数据同步状态,0-数据首次同步 2-数据失败同步
statusTime 上次同步失败时间,格式:yyyy-MM-dd HH:mm:ss
tenantId 企业ID,各注册企业在外勤365中对应的唯一ID
digest 数据签名,md5(data
dataType cuxiao_record_examine
data <<请求数据体>> , 说明:格式为JSON格式数据

请求包体:

{
    
	"id": 7901803402635456979,
	"audit_form_data": 6442960492716362645,
	"comment_user_name": "boss",
	"comment_user": 6427485500721322085,
	"examine_date": "2019-10-17",
	"comment_text": "",
	"comment_status": "0",
	"record_audit_form_id": 8970563588807467141,
	"comment_step": "1"
	
}

参数说明

参数 类型 必填 说明
id Int8 上报记录的ID
comment_step VARCHAR 初评/复评标识(1- 初评 2-复评)
comment_status VARCHAR 评价状态 (0-合格 1-不合格)
comment_text VARCHAR 评价批注
comment_user VARCHAR 评价人ID
comment_user_name VARCHAR 评价人姓名
examine_date VARCHAR 评价时间 (格式yyyy-MM-dd hh:mm:ss)
record_audit_form_id Int8 评价模板ID
audit_form_data Int8 评价表单记录ID

响应信息

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

乙方签署文件推送

接口说明:在三方落章参数开启、乙方签署完电子协议后,外勤365会按照此接口将乙方签署的文件发送出去 请求方式:** POST(HTTPS
请求地址: 第三方服务接口URL

请求参数:

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本,如:001
dataFormat 数据格式:json
dataSource 数据来源:biz 业务功能产生 api 开放接口产生
timestamp 请求时间戳,如:1503276678552
status 数据同步状态,0-数据首次同步 2-数据失败同步
statusTime 上次同步失败时间,格式:yyyy-MM-dd HH:mm:ss
tenantId 企业ID,各注册企业在外勤365中对应的唯一ID
digest 数据签名,md5(data
dataType cuxiao_sign_b
data <<请求数据体>> , 说明:格式为JSON格式数据

请求包体:

{
    
    "protocol_id": 5959303241377469352,
    "b_sign_url": "https://contract.waiqin365.com/7320333869003283336/cuxiao_contract/202002/origin/5487947973756444218.pdf?Expires=1586855291&OSSAccessKeyId=LTAIgEPwnBa8n2Q6&Signature=sh47%2FIVShnRL9XmMzad%2F8wvmbFE%3D"
    
}

参数说明

参数 类型 必填 说明
protocol_id Int8 协议ID
b_sign_url VARCHAR 乙方签署后的协议URL

响应信息

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