招商门店分页查询接口
公共参数
公共请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | koubei.marketing.campaign.recruit.shop.query |
format | String | 否 | 40 | 仅支持JSON | JSON |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
biz_content | String | 是 | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
请求参数
参数 | 类型 | 是否必填 | 最 大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
camp_id | String | 必选 | 32 | 活动id | 1232433452 |
page_size | String | 必选 | 10 | 每页大小 | 100 |
page_num | String | 必选 | 10 | 页码 | 1 |
invitee | String | 可选 | 28 | 参与的商户Id | 20888 |
operator_id | String | 可选 | 32 | 操作人id | 208843244324 |
operator_type | String | 可选 | 32 | 操作人类型 | MER |
公共响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,参见具体的API接口文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
shop_count | String | 选填 | 10 | 总量 | 100 |
plan_id | String | 选填 | 32 | 招商活动id | 4325234 |
shop_info | RecruitShopInfo | 选填 | 招商门店确认详情 |
请求示例
响应示例
{
"koubei_marketing_campaign_recruit_shop_query_response": {
"code": "10000",
"msg": "Success",
"shop_count": "100",
"plan_id": "4325234",
"shop_info": [
{
"shop_id": "432453434",
"shop_name": "星巴克(证大五道口广场店)",
"shop_category": "餐饮-中餐",
"confirm_status": "PENDING"
}
]
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
异常示例
{
"koubei_marketing_campaign_recruit_shop_query_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
INVALID_PARAMETER | 参数有误。参数有误,比如页码小于1,每页数量大于100,操作员ID为空,操作员类型为空 | 符合入参的规范 |
NO_DATA_PERMISSION | 无该数据访问权限 | 检查商户是否有访问数据权限 |
SYSTEM_EXCEPTION_ERROR | 系统异常 | 稍后重试 |
OPERATOR_RELATION_INVALID | 待运营关系校验错误 | 检查服务商和商户是否有代运营关系 |
INVALID_PARAMETER | 参数有误。 | 参数错误,需要调用方检查参数 |
CAMPAIGN_NOT_EXIST | 活动不存在 | 活动不存在,需要重新创建活动 |