alipay.offline.market.shop.category.query (门店类目配置查询接口)

用于查询可用于开店的类目,以及类目上的配置约束信息

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.offline.market.shop.category.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 256 商户请求参数的签名串,详见签名 详见示例
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
category_id String 可选 16 类目ID,如果为空则查询全部类目。 2015050700000000
op_role String 可选 16 表示接口业务的调用方身份,默认不填标识为ISV。 ISV

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
shop_category_config_infos ShopCategoryConfigInfo [] 选填 - 门店类目配置信息,包括能够开店的叶子节点类目信息,以及类目约束配置信息。
  • └ id
  • String
  • 必填
  • 16
  • 类目ID
  • 2016031800159500
  • └ nm
  • String
  • 必填
  • 256
  • 类目名称
  • 淮扬菜
  • └ level
  • String
  • 必填
  • 10
  • 类目层级
  • 3
  • └ link
  • String
  • 必填
  • 1000
  • 类目层级路径
  • 美食-中餐-淮扬菜
  • └ is_leaf
  • String
  • 必填
  • 10
  • 是否是叶子节点
  • true

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOfflineMarketShopCategoryQueryRequest request = new AlipayOfflineMarketShopCategoryQueryRequest();
request.setBizContent("{" +
"\"category_id\":\"2015050700000000\"," +
"\"op_role\":\"ISV\"" +
"  }");
AlipayOfflineMarketShopCategoryQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_offline_market_shop_category_query_response":{
		"msg":"Success",
		"shop_category_config_infos":[
			{
				"level":"3",
				"link":"美食-中餐-淮扬菜",
				"id":"2016031800159500",
				"is_leaf":"true",
				"nm":"淮扬菜"
			}
		],
		"code":"10000"
	}
}

异常示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_offline_market_shop_category_query_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 重试调用查询接口
INVALID_PARAMETER 参数有误。 对照接口文档以及请求参数用例,修改请求参数

公共错误码

返回
顶部