查询合作关系列表

更新时间:2024.09.02

为商户提供合作关系列表的查询能力。

接口说明

支持商户:【普通商户】

请求方式:【GET】/v3/marketing/partnerships

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数
折叠全部参数

Header  HTTP头参数

 Authorization  必填 string

请参考签名认证生成认证信息


 Accept  必填 string

请设置为application/json


query  查询参数

 limit  选填   integer

【分页大小】分页大小,最大50。 不传默认为20


 offset  选填   integer

【分页页码】分页页码,页码从0开始


 partner  选填   object

【合作方信息】合作方信息

属性

 type  必填   string

【合作方类别】合作方类别,枚举值见文档

可选取值:

  • APPID: 合作方为Appid

  • MERCHANT: 合作方为商户


 appid  选填   string(32)

【合作方Appid】合作方Appid,合作方类别为APPID时必填


 merchant_id  选填   string(15)

【合作方商户ID】合作方商户ID,合作方类别为MERCHANT时必填


 authorized_data  必填   object

【被授权数据】被授权数据

属性

 business_type  必填   string

【授权业务类别】授权业务类别,枚举值见文档

可选取值:

  • FAVOR_STOCK: 授权业务类型-代金券批次

  • BUSIFAVOR_STOCK: 授权业务类型-商家券批次


 stock_id  选填   string(20)

【授权批次ID】授权批次ID,授权业务类别为券批次时必填

请求示例

curl
Java
Go

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/partnerships?limit=5&offset=10&authorized_data=%7B%22business_type%22%3A%22FAVOR_STOCK%22%2C%22stock_id%22%3A%222433405%22%7D&partner=%7B%22type%22%3A%22APPID%22%2C%22appid%22%3A%22wx4e1916a585d1f4e9%22%2C%22merchant_id%22%3A%222480029552%22%7D \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数
折叠全部参数

200 OK

 data  选填   array[object]

【合作关系结果集】合作关系查询结果集。如查询结果为0,将在控制流返回错误

属性

 partner  必填   object

【合作方信息】合作方信息

属性

 type  必填   string

【合作方类别】合作方类别,枚举值见文档

可选取值:

  • APPID: 合作方为Appid

  • MERCHANT: 合作方为商户


 appid  选填   string(32)

【合作方Appid】合作方Appid,合作方类别为APPID时必填


 merchant_id  选填   string(15)

【合作方商户ID】合作方商户ID,合作方类别为MERCHANT时必填


 authorized_data  必填   object

【被授权数据】被授权数据

属性

 business_type  必填   string

【授权业务类别】授权业务类别,枚举值见文档

可选取值:

  • FAVOR_STOCK: 授权业务类型-代金券批次

  • BUSIFAVOR_STOCK: 授权业务类型-商家券批次


 stock_id  选填   string(20)

【授权批次ID】授权批次ID,授权业务类别为券批次时必填


 build_time  必填   string(32)

【建立合作关系时间】建立合作关系时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。


 terminate_time  选填   string(32)

【终止合作关系时间】终止合作关系时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。


 create_time  必填   string(32)

【创建时间】创建时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。


 update_time  必填   string(32)

【更新时间】更新时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日 13点29分35秒。


 offset  必填   integer

【分页页码】分页页码


 limit  必填   integer

【分页大小】分页大小


 total_count  选填   integer

【总数量】总数量,当offset=0或者当前查询为空时返回

应答示例

200 OK

1{
2  "data" : [
3    {
4      "partner" : {
5        "type" : "APPID",
6        "appid" : "wx4e1916a585d1f4e9",
7        "merchant_id" : "2480029552"
8      },
9      "authorized_data" : {
10        "business_type" : "FAVOR_STOCK",
11        "stock_id" : "2433405"
12      },
13      "build_time" : "2015-05-20T13:29:35.120+08:00",
14      "terminate_time" : "2015-05-20T13:29:35.120+08:00",
15      "create_time" : "2015-05-20T13:29:35.120+08:00",
16      "update_time" : "2015-05-20T13:29:35.120+08:00"
17    }
18  ],
19  "offset" : 10,
20  "limit" : 5,
21  "total_count" : 1234
22}
23

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

APPID_MCHID_NOT_MATCH

appid与mchid不匹配

请确认appid是否正确填写

400

INVALID_REQUEST

请求参数符合参数格式,但不符合业务规则

根据错误提示,传入符合业务规则的参数

400

INVALID_REQUEST

委托营销合作关系不存在

请确认合作方信息是否正确

400

MCH_NOT_EXISTS

商户号不存在

请确认发券商户号信息是否有误

403

NO_AUTH

商户未被授权

登录商户平台核对,传入正确信息

404

RESOURCE_NOT_EXISTS

资源不存在或无可用

请确认资源均存在且可用

429

FREQUENCY_LIMITED

频率超限

请求量不要超过接口调用频率限制

 

 

元宝AI
反馈
目录
置顶