接口说明
接口名称:alipay.trade.product.query
支持第三方代理调用:本接口支持第三方开发者代用户发起调用。
适用场景
商品查询接口,用于查询单个或多个商品信息。
公共请求参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|
app_id | String | 必选 | 32 | 支付宝分配给开发者的应用 ID | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | alipay.trade.product.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 | 必选 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
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 | 必选 | - | 请求参数集合。除公共参数外,所有请求参数都必须放在该参数中传递 | - |
业务请求参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|
product_id | String | 可选 | 32 | 商品 ID,通过创建接口获取 | - | 202603230010000006783 |
query_options | String | 可选 | 255 | 查询选项,商户通过上送该参数来定制额外返回的信息字段,数组格式 | price:默认价格信息 | ["price"] |
常见请求示例
package com.java.sdk.demo;
import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.AlipayConfig;
import com.alipay.api.domain.AlipayTradeProductQueryModel;
import com.alipay.api.request.AlipayTradeProductQueryRequest;
import com.alipay.api.response.AlipayTradeProductQueryResponse;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayTradeProductQuery {
public static void main(String[] args) throws AlipayApiException {
// 初始化SDK
AlipayClient alipayClient = new DefaultAlipayClient(getAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeProductQueryRequest request = new AlipayTradeProductQueryRequest();
AlipayTradeProductQueryModel model = new AlipayTradeProductQueryModel();
// 设置商品id
model.setProductId("202603230010000006783");
// 设置查询选项
List<String> queryOptions = new ArrayList<String>();
queryOptions.add("price");
model.setQueryOptions(queryOptions);
request.setBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.putOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeProductQueryResponse response = alipayClient.execute(request);
System.out.println(response.getBody());
if (response.isSuccess()) {
System.out.println("调用成功");
} else {
System.out.println("调用失败");
// sdk版本是"4.38.0.ALL"及以上,可以参考下面的示例获取诊断链接
// String diagnosisUrl = DiagnosisUtils.getDiagnosisUrl(response);
// System.out.println(diagnosisUrl);
}
}
private static AlipayConfig getAlipayConfig() {
String privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
String alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com/gateway.do");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey(privateKey);
alipayConfig.setFormat("json");
alipayConfig.setAlipayPublicKey(alipayPublicKey);
alipayConfig.setCharset("UTF-8");
alipayConfig.setSignType("RSA2");
return alipayConfig;
}
}
using System;
using System.Collections.Generic;
using Aop.Api;
using Aop.Api.Request;
using Aop.Api.Response;
using Aop.Api.Domain;
using Aop.Api.Util;
namespace SdkDemoTest
{
public class AlipayTradeProductQuery
{
public static void Main(string[] args)
{
// 初始化SDK
IAopClient alipayClient = new DefaultAopClient(GetAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeProductQueryRequest request = new AlipayTradeProductQueryRequest();
AlipayTradeProductQueryModel model = new AlipayTradeProductQueryModel();
// 设置商品id
model.ProductId = "202603230010000006783";
// 设置查询选项
List<String> queryOptions = new List<String>();
queryOptions.Add("price");
model.QueryOptions = queryOptions;
request.SetBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.PutOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeProductQueryResponse response = alipayClient.Execute(request);
if(!response.IsError)
{
Console.WriteLine("调用成功");
}
else
{
Console.WriteLine("调用失败");
}
}
private static AlipayConfig GetAlipayConfig()
{
string privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
string alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.ServerUrl = "https://openapi.alipay.com/gateway.do";
alipayConfig.AppId = "<-- 请填写您的AppId,例如:2019091767145019 -->";
alipayConfig.PrivateKey = privateKey;
alipayConfig.Format = "json";
alipayConfig.AlipayPublicKey = alipayPublicKey;
alipayConfig.Charset = "UTF-8";
alipayConfig.SignType = "RSA2";
return alipayConfig;
}
}
}
<?php
require_once '../aop/AopClient.php';
require_once '../aop/AopCertClient.php';
require_once '../aop/AopCertification.php';
require_once '../aop/AlipayConfig.php';
require_once '../aop/request/AlipayTradeProductQueryRequest.php';
// 初始化SDK
$alipayClient = new AopClient(getAlipayConfig());
// 构造请求参数以调用接口
$request = new AlipayTradeProductQueryRequest();
$model = array();
// 设置商品id
$model['product_id'] = "202603230010000006783";
// 设置查询选项
$queryOptions = array();
$queryOptions[] = "price";
$model['query_options'] = $queryOptions;
$request->setBizContent(json_encode($model,JSON_UNESCAPED_UNICODE));
// 如果是第三方代调用模式,请设置app_auth_token(应用授权令牌)
$responseResult = $alipayClient->execute($request, null, "<-- 请填写应用授权令牌 -->", null);
$responseApiName = str_replace(".","_",$request->getApiMethodName())."_response";
$response = $responseResult->$responseApiName;
if(!empty($response->code)&&$response->code==10000){
echo("调用成功");
}
else{
echo("调用失败");
}
function getAlipayConfig()
{
$privateKey = '<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->';
$alipayPublicKey = '<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->';
$alipayConfig = new AlipayConfig();
$alipayConfig->setServerUrl('https://openapi.alipay.com/gateway.do');
$alipayConfig->setAppId('<-- 请填写您的AppId,例如:2019091767145019 -->');
$alipayConfig->setPrivateKey($privateKey);
$alipayConfig->setFormat('json');
$alipayConfig->setAlipayPublicKey($alipayPublicKey);
$alipayConfig->setCharset('UTF-8');
$alipayConfig->setSignType('RSA2');
return $alipayConfig;
}
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.trade.product.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'app_auth_token=${app_auth_token}' \
-F 'biz_content={
"product_id":"202603230010000006783",
"query_options":[
"price"
]
}'
公共响应参数
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|
| code | String | 必选 | 网关返回码,详见文档 | 40004 |
| msg | String | 必选 | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 可选 | 业务返回码,参见具体的 API 接口文档 | - |
| sub_msg | String | 可选 | 业务返回码描述,参见具体的 API 接口文档 | - |
| sign | String | 必选 | 签名,详见文档 | DZXh8eeTuAHoYE3w1J… |
业务响应参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|
product_list | NexusPayProduct | 必选 | - | 商品信息列表 | - | - |
product_list.id | String | 必选 | 32 | 商品 ID | - | 20260324001001 |
product_list.name | String | 必选 | 255 | 商品名称 | - | Gold 会员 |
product_list.description | String | 必选 | 255 | 商品描述 | - | 基础权益 |
product_list.active | Boolean | 必选 | 10 | 是否可用 | - | true |
product_list.default_price_id | String | 可选 | 32 | 商品的默认价格 ID | - | 20260324001001 |
product_list.default_price | NexusSimplePrice | 可选 | - | 默认价格信息 | - | - |
product_list.default_price.id | String | 必选 | 32 | 价格 ID | - | 20260324001001 |
product_list.default_price.active | Boolean | 必选 | 10 | 是否可用 | - | true |
product_list.default_price.type | String | 必选 | 32 | 价格类型 | recurring:订阅;one_time:单次支付 | recurring |
product_list.default_price.unit_amount | Number | 必选 | 32 | 单位金额,单位为分 | - | 1000 |
product_list.default_price.recurring | Recurring | 必选 | - | 订阅周期信息 | - | - |
product_list.default_price.recurring.interval | String | 可选 | 16 | 订阅周期类型,目前支持 DAY 和 MONTH | MONTH:月;DAY:天 | MONTH |
product_list.default_price.recurring.interval_count | Number | 可选 | 32 | 订阅周期数量,目前周期单位只支持月或日 | - | 1 |
product_list.default_price.recurring.usage_type | String | 可选 | 16 | 计费模式 | licensed:固定计费;metered:按量计费 | licensed |
product_list.default_price.recurring.trial_period_days | Number | 可选 | 32 | 试用期天数 | - | 10 |
product_list.default_price.metadata | String | 可选 | 2000 | 价格信息元数据 | - | {"key":"value"} |
product_list.default_price.custom_unit_amount | CustomUnitAmount | 可选 | - | 自定义单价 | 当 unit_amount 为空时必选 | - |
product_list.default_price.custom_unit_amount.enable | Boolean | 必选 | 10 | 是否启用灵活定价,启用后可设置 preset、maximum、minimum 字段 | - | true |
product_list.default_price.custom_unit_amount.preset | Number | 可选 | 32 | 预设的自定义价格,单位为分 | 灵活定价开启后可设置 | 88888 |
product_list.default_price.custom_unit_amount.maximum | Number | 可选 | 32 | 可自定义的最大金额,单位为分 | 灵活定价开启后可设置 | 1000000000 |
product_list.default_price.custom_unit_amount.minimum | Number | 可选 | 32 | 可自定义的最小金额,单位为分 | 灵活定价开启后可设置 | 100 |
product_list.metadata | String | 可选 | 2000 | 商品信息元数据,通过商品创建接口传入 | - | {"key":"value"} |
product_list.gmt_create | String | 必选 | 64 | 创建时间 | - | 2026-03-24 18:00:00 |
响应示例
{
"alipay_trade_product_query_response": {
"code": "10000",
"msg": "Success",
"product_list": [
{
"id": "20260324001001",
"name": "Gold 会员",
"description": "基础权益",
"active": true,
"default_price_id": "20260324001001",
"default_price": {
"id": "20260324001001",
"active": true,
"type": "recurring",
"unit_amount": 1000,
"recurring": {
"interval": "MONTH",
"interval_count": 1,
"usage_type": "licensed",
"trial_period_days": 10
},
"metadata": "{\"key\":\"value\"}",
"custom_unit_amount": {
"enable": true,
"preset": 88888,
"maximum": 1000000000,
"minimum": 100
}
},
"metadata": "{\"key\":\"value\"}",
"gmt_create": "2026-03-24 18:00:00"
}
]
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"alipay_trade_product_query_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
业务错误码
| 错误码 | 错误描述 | 解决方案 |
|---|
SYSTEM_ERROR | 系统繁忙 | 服务器异常。可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
INVALID_PARAMETER | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
APP_ID_NOT_MATCH | 应用 ID 与商品所属应用不匹配 | 请检查传入的商品 ID 是否正确 |
PRODUCT_NOT_EXIST | 商品不存在 | 请检查 product_id 是否正确,或检查账号下是否有商品存在 |