开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
开发文档(v3版) 
支付
私域
小程序产品
权限集列表
搜索关键词
搜索直达
收藏
消息
小程序码
小程序服务
订单中心
小程序开发管理
生物核身
交易组件
小程序商品
接入指南
api 列表
普通商品
本地生活商品
商品管理
凭证管理
酒店日历房
租房
支付宝文件
商品变更相关
商品营销相关
相关资料
支付有礼
小游戏
公域
营销
资金
会员
信用
安全
广告
小程序云
其他
api文档 >  >  >  >  >  >  >  > 获取本地商品模板信息接口
收藏
订阅更新
我的文档
设置

接口说明

接口英文名称:alipay.open.app.localitem.template.query
请求url:https://openapi.alipay.com/v3/alipay/open/app/localitem/template/query
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
根据类目及商品类型获取本地商品模板信息。

公共请求参数

参数类型是否必选最大长度描述示例值
authorizationstring必选1024
请求身份信息,参考。在header参数中传递
content-typestring可选32
报文内容格式,默认需要使用application/json,加密请求使用text/plain,参考。在header参数中传递
application/json
x-http-method-overridestring可选16
http方法,对于部分不支持put、patch、delete等操作的情况,可以使用post发送请求,并通过该参数传输实际需要使用的http method,参考。在header参数中传递
put
alipay-request-idstring可选32
调用方的requestid,用于定位一次请求,需要每次请求保持唯一。排查问题时可以提供该字段,参考。在header参数中传递。
0ba7cddb1665744697169391253118
alipay-encrypt-typestring可选16
加密算法,请求使用加密能力时,需要指定加密算法,参考。在header参数中传递
aes
alipay-root-cert-snstring可选128
支付宝根证书序列号。证书模式时,可传入该参数,支付宝服务端会校验序列号,确保调用方的证书未被篡改,参考。在header参数中传递
687b59193f3f462dd5336e5abf83c5d8_02941eef3187dddf3d3b83462e1dfcf6
alipay-app-auth-tokenstring可选128
应用授权令牌,参考代调用规则。在header参数中传递
201509bbeff9351ad1874306903e96b91d248a36

业务请求参数

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"
}'
说明:本示例仅供参考。

公共响应参数

参数中文名参数英文名类型是否必选最大长度描述示例值
支付宝响应时间戳alipay-timestampstring可选32
unix时间戳,用于验签及问题排查,参考。在header参数中传递
1666004496123
支付宝响应签名alipay-signaturestring可选512
支付宝响应报文签名,参考。在header中返回
支付宝traceidalipay-traceidstring可选64
支付宝traceid ,用于排查问题使用,参考。在header中返回
0ba7cddb1665744697169391253118
支付宝随机串alipay-noncestring可选64
支付宝nonce标记,每次请求会生成不同的nonce,可用于防重放判断,参考。在header中返回
515cf24c2f78b13564e94c2a495695ab

业务响应参数

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官方网站的解决方案
400system_error系统繁忙
服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试
400invalid_parameter参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
400cat_id_null类目不存在
检查类目是否符合支付宝商品类目准入规范
400cat_not_access该类目不支持入参的商品类型
请根据类目支持的商品类型进行选择查询
400item_template_not_exist商品模板不存在
检查类目是否配置商品模板
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图