支付宝

查询活动可用门店

开发环境

http://dev-cn.your-api-server.com

GET

/v3/alipay/marketing/activity/{activity_id}/shop/batchquery

alipay.marketing.activity.shop

通过此接口可查询活动的可用门店，判断券是否在某门店可用，来决定是否展示。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/v3/alipay/marketing/activity//shop/batchquery?merchant_id&page_num&page_size&product_version&merchant_access_mode'

响应示例

200 - 示例 1

{
  "activity_id": "2016042700826004508401111111",
  "page_num": 1,
  "page_size": 20,
  "shop_infos": [
    {
      "latitude": "60.270001",
      "longitude": "120.760001",
      "shop_id": "2018011900502000000005124744",
      "shop_name": "肯德基中关村店",
      "shop_type": "PAYMENT_SHOP"
    }
  ],
  "total_size": 200
}

请求参数

Path 参数

activity_id

string

活动id

必需

Query 参数

merchant_id

string

可选

商户PID,默认为当前接口调用商户。

page_num

integer

可选

分页查询页码。限制: 必须为大于0的整数

page_size

integer

可选

分页查询单页数据条数。限制: 1.必须为大于0的整数 2.每页最大值为20

product_version

string

可选

版本号枚举值: 2.0.0

merchant_access_mode

string

商户接入模式

可选

返回响应

🟢200common response

application/json

Body

activity_id

string

活动id

可选

示例值:

2016042700826004508401111111

page_num

integer

分页查询页码。

可选

示例值:

page_size

integer

可选

分页查询单页数据条数。

示例值:

shop_infos

array[object (ActivityShopInfo) {5}]

可用门店列表

可选

latitude

string

可选

纬度，浮点型,小数点后最多保留6位

示例值:

60.270001

longitude

string

可选

经度，浮点型, 小数点后最多保留6位。

示例值:

120.760001

shop_id

string

可选

支付宝侧蚂蚁店铺 id。

示例值:

2018011900502000000005124744

shop_name

string

店铺名称。

可选

示例值:

肯德基中关村店

shop_type

string

可选

门店类型 PAYMENT_SHOP 支付门店 REAL_SHOP 代运营商业关系门店

示例值:

PAYMENT_SHOP

total_size

integer

可用门店总数量

可选

示例值:

200

🔴500请求失败

查询活动可用小程序

查询活动适用商品