查询品牌门店列表

更新时间:2025.12.08

查询品牌门店列表。

接口说明

支持商户:【品牌商户】

请求方式:【GET】/brand/store/brandstores

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

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

接口限频:900/分钟(品牌ID维度)

请求参数

Header  HTTP头参数

 Authorization  必填 string

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


 Accept  必填 string

请设置为application/json


 Wechatpay-Serial  必填 string

【微信支付公钥ID】  请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引


query  查询参数

 store_state  选填   string

【门店状态】 若不填,则查询所有门店。

可选取值

  • OPEN:  门店生效中。门店审核通过创建成功后即为生效中,后续更新门店信息只会影响审核状态,不会改变门店状态,如门店暂停营业可调用“暂停门店营业 API”,如门店关闭可调用“删除品牌门店 API”。门店营业时间不影响门店状态。

  • CREATING:  门店创建中。在创建门店后,门店资料正在审核。审核详情请查看审核状态。

  • CLOSED:  门店停业中。不可用于微信支付生态中的其他业务,可删除该门店,删除后将无法恢复,请谨慎操作。


 offset  选填   integer

【分页起始位置】 从第几条开始查询,默认从第0条开始查询。


 limit  选填   integer

【分页条数】 一次查询的最大门店条数,默认值为20,取值范围[1,200]。

请求示例

curl
Java
Go

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/store/brandstores?store_state=OPEN&offset=100&limit=20 \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  
6

应答参数
折叠全部参数

200 OK

 data  选填   array[object]

【品牌门店列表】 查询到的门店列表。

属性

 store_id  选填   string

【品牌门店ID】 创建品牌门店后,系统为该门店分配的唯一ID。


 store_state  选填   string

【门店状态】 用于描述门店当前状态

可选取值

  • OPEN:  门店生效中。门店审核通过创建成功后即为生效中,后续更新门店信息只会影响审核状态,不会改变门店状态,如门店暂停营业可调用“暂停门店营业 API”,如门店关闭可调用“删除品牌门店 API”。门店营业时间不影响门店状态。

  • CREATING:  门店创建中。在创建门店后,门店资料正在审核。审核详情请查看审核状态。

  • CLOSED:  门店停业中。不可用于微信支付生态中的其他业务,可删除该门店,删除后将无法恢复,请谨慎操作。


 audit_state  选填   string

【审核状态】 创建、修改门店时,通过此字段可得知当前审核状态

可选取值

  • SUCCESS:  门店资料审核通过。

  • PROCESSING:  门店资料审核中,请等待审核结果。

  • REJECTED:  门店资料被驳回,请根据驳回原因进行修改。


 review_reject_reason  选填   string

【审核失败原因】 门店资料审核失败的原因


 store_basics  选填   object

【门店基础信息】 用于描述门店编码,名称等基本情况。

属性

 store_reference_id  选填   string(32)

【商家门店编号】 商家内部的门店编号,最长32位字符;商家自行保证该编码在商家内部的唯一性。不允许有符号表情。

此字段为免审字段(仅修改免审字段时,将会直接更新门店,无需审核)。


 branch_name  选填   string(50)

【门店名称】 只需填写纯粹的分店名称,例如:"南山店"、"朝阳门店"、"天河城店"

  • 不要包含任何括号、破折号等辅助符号

  • 系统会自动将该名称与品牌名组合展示,最终呈现格式为:"品牌名(分店名)",例如:"麦当劳(南山店)"。


 store_address  选填   object

【门店地址信息】 用于描述门店地址,经纬度等地理位置相关情况。

属性

 address_code  必填   string(20)

【门店省市编码】 门店所在省市区编码,只能由数字组成;详细参见微信支付提供的省市对照表


 address_detail  必填   string(200)

【门店地址】 门店地址为核心重要信息,请准确填写并精确到门牌号,该信息涉及到地址核实、营销活动等业务,说明:不要重复填写省市区信息。


 address_complements  选填   string(50)

【门店地址辅助描述】 门店周围标志性建筑,用于辅助定位。


 longitude  选填   string(32)

【门店经度】 经度,取值在[-180,180]之间的数字,经度长度不能超过32个字符,腾讯地图经纬度查询:https://lbs.qq.com/tool/getpoint/index.html


 latitude  选填   string(32)

【门店纬度】 纬度,取值在[-90,90]之间的数字,纬度长度不能超过32个字符,腾讯地图经纬度查询:https://lbs.qq.com/tool/getpoint/index.html


 store_business  选填   object

【门店经营信息】 用于描述门店联系电话,经营时间等经营状况。

属性

 service_phone  选填   string(32)

【门店服务电话】 支持座机和手机,只支持数字和“-”符号,最多支持两个电话,两个电话间用英文竖线“|”区隔。

此字段为免审字段(仅修改免审字段时,将会直接更新门店,无需审核)。


 business_hours  选填   string(256)

【门店经营时间】 经营时间需要使用指定格式,如下:

  • 最多支持 7 个时间段,时间段间用英文竖线"|"分隔,严格按 “周一至周五 09:00-20:00|周六至周日 10:00-22:00” 的格式进行填写;

  • 支持填写跨日经营时间,需在终止时间前添加“次日”,严格参照“周一至周五 09:00-次日2:00” 格式填写,跨日周期不得超过 24 小时;

  • 此字段为免审字段(仅修改免审字段时,将会直接更新门店,无需审核)。


 store_recipient  选填   array[object]

【门店收款信息】 门店收款商户列表。

属性

 mchid  选填   string(16)

【门店收款商户号】 门店的收款商户号,仅支持绑定品牌已关联的商户号。


 company_name  选填   string(256)

【门店收款主体】 门店收款的主体信息,支持企业,个体户,小微。


 recipient_state  选填   string

【收款绑定状态】 门店收款商户号的绑定状态

可选取值

  • CONFIRMED:  门店已绑定此收款商户号

  • ADMIN_REJECTED:  商户管理员已拒绝

  • CONFIRMING:  商户号管理员确认中

  • TIMEOUT_REJECTED:  由于商户管理员确认超时,系统自动拒绝此绑定


 offset  选填   integer

【分页起始位置】 默认从0开始查询。


 limit  选填   integer

【分页条数】 查询的门店数量。


 total_count  选填   integer

【门店总数】 符合条件的门店总数。

应答示例

200 OK

1{
2  "data" : [
3    {
4      "store_id" : "1234567890123456",
5      "store_state" : "OPEN",
6      "audit_state" : "SUCCESS",
7      "review_reject_reason" : "通过核实,您提交的电话错误,请核实手机号码或座机号码是否正确",
8      "store_basics" : {
9        "store_reference_id" : "MDL001",
10        "branch_name" : "海岸城店"
11      },
12      "store_address" : {
13        "address_code" : "440305",
14        "address_detail" : "深南大道10000号腾讯大厦1楼",
15        "address_complements" : "地铁A口右侧100米",
16        "longitude" : "112.63484",
17        "latitude" : "37.75464"
18      },
19      "store_business" : {
20        "service_phone" : "0755-86013388|0755-86013399",
21        "business_hours" : "周一至周五 09:00-20:00|周六至周日 10:00-次日22:00"
22      },
23      "store_recipient" : [
24        {
25          "mchid" : "1230000109",
26          "company_name" : "腾讯科技(深圳)有限公司",
27          "recipient_state" : "CONFIRMED"
28        }
29      ]
30    }
31  ],
32  "offset" : 100,
33  "limit" : 20,
34  "total_count" : 230
35}
36

 

错误码

以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

400

PARAM_ERROR

分店名称不合法

请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足

400

PARAM_ERROR

门店地址编码不合法

请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足

400

PARAM_ERROR

服务电话不合法

请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足

400

PARAM_ERROR

参数错误

请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足

429

RATELIMIT_EXCEEDED

请求超过频率限制

请稍后使用原参数重试

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后使用原参数重试

 

元宝AI
反馈
目录
置顶