接口说明
接口英文名称:alipay.open.app.localitem.template.query
请求url:https://openapi.alipay.com/v3/alipay/open/app/localitem/template/query
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
通用场景
根据类目及商品类型获取本地商品模板信息。
公共请求参数
业务请求参数
body参数
category_id|类目id必选string(32)
【描述】平台类目,填写的类目必须在类目表列出,只填最后一级。商品类目 id 及信息可通过商品类目表获取。
【示例值】c000000001
item_type|商品类型必选string(32)
【描述】商品类型
【枚举值】
团购: 1
代金: 2
次卡: 3
【示例值】1
常见请求示例
默认示例
curl -x post \
"https://openapi.alipay.com/v3/alipay/open/app/localitem/template/query" \
-h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
-h "alipay-request-id: ${requestid}" \
-h "content-type: application/json" \
-d '{
"category_id":"c000000001",
"item_type":"1"
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
attr|属性必选itemattrgroupvo
【描述】属性分组
【注意事项】具体的属性值可以参考本地生活商品模板文档:
item_attr_list|商品属性可选attributevo[]
【描述】商品属性列表
name|属性名称必选string(128)
【描述】属性名称
【示例值】品牌
key|属性key必选string(32)
【描述】属性key
【示例值】key
type|属性组件类型必选string(32)
【描述】属性组件类型
【枚举值】
文本输入框: input
单选框: select_one
数值输入框: number_picker
【示例值】input
value|属性值可选string(1024)
【描述】属性值枚举,多值;分隔
【示例值】颜色
range|属性值范围区间可选string(64)
【描述】属性值范围区间,上下限,分隔,属性组件类型是number_picker时可用
【示例值】1,99999
length|属性值长度区间可选string(64)
【描述】属性值长度区间,上下限,分隔,属性组件类型是input时可用
【示例值】1,30
is_required|是否必填属性可选boolean(32)
【描述】是否必填属性
【示例值】true
sku_attr_list|sku属性可选attributevo[]
【描述】sku属性列表
name|属性名称必选string(128)
【描述】属性名称
【示例值】品牌
key|属性key必选string(32)
【描述】属性key
【示例值】key
type|属性组件类型必选string(32)
【描述】属性组件类型
【枚举值】
文本输入框: input
单选框: select_one
数值输入框: number_picker
【示例值】input
value|属性值可选string(1024)
【描述】属性值枚举,多值;分隔
【示例值】颜色
range|属性值范围区间可选string(64)
【描述】属性值范围区间,上下限,分隔,属性组件类型是number_picker时可用
【示例值】1,99999
length|属性值长度区间可选string(64)
【描述】属性值长度区间,上下限,分隔,属性组件类型是input时可用
【示例值】1,30
is_required|是否必填属性可选boolean(32)
【描述】是否必填属性
【示例值】true
spu_attr_list|标准属性可选attributevo[]
【描述】标品属性列表
name|属性名称必选string(128)
【描述】属性名称
【示例值】品牌
key|属性key必选string(32)
【描述】属性key
【示例值】key
type|属性组件类型必选string(32)
【描述】属性组件类型
【枚举值】
文本输入框: input
单选框: select_one
数值输入框: number_picker
【示例值】input
value|属性值可选string(1024)
【描述】属性值枚举,多值;分隔
【示例值】颜色
range|属性值范围区间可选string(64)
【描述】属性值范围区间,上下限,分隔,属性组件类型是number_picker时可用
【示例值】1,99999
length|属性值长度区间可选string(64)
【描述】属性值长度区间,上下限,分隔,属性组件类型是input时可用
【示例值】1,30
is_required|是否必填属性可选boolean(32)
【描述】是否必填属性
【示例值】true
category_id|类目id可选string(32)
【描述】商品类目id
【示例值】c000000001
category_name|类目名称可选string(32)
【描述】商品类目名称
【示例值】网络虚拟
item_type|商品类型可选string(32)
【描述】商品类型
【枚举值】
团购: 1
代金: 2
次卡: 3
【示例值】1
响应示例
正常示例
异常示例
{
"category_id":"c000000001",
"category_name":"网络虚拟",
"item_type":"1",
"attr":{
"item_attr_list":[
{
"name":"品牌",
"key":"key",
"type":"input",
"value":"颜色",
"range":"1,99999",
"length":"1,30",
"is_required":true
}
],
"sku_attr_list":[
{
"name":"品牌",
"key":"key",
"type":"input",
"value":"颜色",
"range":"1,99999",
"length":"1,30",
"is_required":true
}
],
"spu_attr_list":[
{
"name":"品牌",
"key":"key",
"type":"input",
"value":"颜色",
"range":"1,99999",
"length":"1,30",
"is_required":true
}
]
}
}
说明:本示例仅供参考。
公共错误码
业务错误码
状态码 | 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|---|
400 | system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
400 | invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
400 | cat_id_null | 类目不存在 | 检查类目是否符合支付宝商品类目准入规范 |
400 | cat_not_access | 该类目不支持入参的商品类型 | 请根据类目支持的商品类型进行选择查询 |
400 | item_template_not_exist | 商品模板不存在 | 检查类目是否配置商品模板 |