接口说明
接口名称:alipay.trade.product.create
支持第三方代理调用:本接口支持第三方开发者代用户发起调用。
适用场景
商品创建接口。
公共请求参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|
app_id | String | 必选 | 32 | 支付宝分配给开发者的应用 ID | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | alipay.trade.product.create |
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 | 必选 | - | 请求参数集合。除公共参数外,所有请求参数都必须放在该参数中传递 | - |
业务请求参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|
name | String | 必选 | 255 | 商品名称 | - | Gold 会员 |
description | String | 必选 | 255 | 商品描述 | - | 基础权益 |
metadata | String | 可选 | 2000 | 商户需要保存在商品模型中的元数据 | - | {"key":"value"} |
images | String | 可选 | 4000 | 图片地址 | 支持传入不超过 5 个地址 | ["https://antgroup.com"] |
marketing_features | String | 可选 | 4000 | 营销信息 | 支持传入不超过 5 个营销信息 | ["16000积分"] |
unit_label | String | 可选 | 100 | 单位别名 | - | 积分 |
url | String | 可选 | 500 | 可用于跳转商户网址地址 | - | https://antgroup.com |
常见请求示例
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.response.AlipayTradeProductCreateResponse;
import com.alipay.api.domain.AlipayTradeProductCreateModel;
import com.alipay.api.request.AlipayTradeProductCreateRequest;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayTradeProductCreate {
public static void main(String[] args) throws AlipayApiException {
// 初始化SDK
AlipayClient alipayClient = new DefaultAlipayClient(getAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeProductCreateRequest request = new AlipayTradeProductCreateRequest();
AlipayTradeProductCreateModel model = new AlipayTradeProductCreateModel();
// 设置商品名称
model.setName("Gold 会员");
// 设置商品描述
model.setDescription("基础权益");
// 设置商品模型元数据
model.setMetadata("{\"key\":\"value\"}");
// 设置图片地址
model.setImages("[\"https://antgroup.com\"]");
// 设置营销信息
model.setMarketingFeatures("[\"16000积分\"]");
// 设置单位别名
model.setUnitLabel("积分");
// 设置跳转地址
model.setUrl("https://antgroup.com");
request.setBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.putOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeProductCreateResponse 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 AlipayTradeProductCreate
{
public static void Main(string[] args)
{
// 初始化SDK
IAopClient alipayClient = new DefaultAopClient(GetAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeProductCreateRequest request = new AlipayTradeProductCreateRequest();
AlipayTradeProductCreateModel model = new AlipayTradeProductCreateModel();
// 设置商品名称
model.Name = "Gold 会员";
// 设置商品描述
model.Description = "基础权益";
// 设置商品模型元数据
model.Metadata = "{\"key\":\"value\"}";
// 设置图片地址
model.Images = "[\"https://antgroup.com\"]";
// 设置营销信息
model.MarketingFeatures = "[\"16000积分\"]";
// 设置单位别名
model.UnitLabel = "积分";
// 设置跳转地址
model.Url = "https://antgroup.com";
request.SetBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.PutOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeProductCreateResponse 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/AlipayTradeProductCreateRequest.php';
// 初始化SDK
$alipayClient = new AopClient(getAlipayConfig());
// 构造请求参数以调用接口
$request = new AlipayTradeProductCreateRequest();
$model = array();
// 设置商品名称
$model['name'] = "Gold 会员";
// 设置商品描述
$model['description'] = "基础权益";
// 设置商品模型元数据
$model['metadata'] = "{\"key\":\"value\"}";
// 设置图片地址
$model['images'] = "[\"https://antgroup.com\"]";
// 设置营销信息
$model['marketing_features'] = "[\"16000积分\"]";
// 设置单位别名
$model['unit_label'] = "积分";
// 设置跳转地址
$model['url'] = "https://antgroup.com";
$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.create&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={
"name":"Gold 会员",
"description":"基础权益",
"metadata":"{\"key\":\"value\"}",
"images":"[\"https://antgroup.com\"]",
"marketing_features":"[\"16000积分\"]",
"unit_label":"积分",
"url":"https://antgroup.com"
}'
公共响应参数
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|
| code | String | 必选 | 网关返回码,详见文档 | 40004 |
| msg | String | 必选 | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 可选 | 业务返回码,参见具体的 API 接口文档 | - |
| sub_msg | String | 可选 | 业务返回码描述,参见具体的 API 接口文档 | - |
| sign | String | 必选 | 签名,详见文档 | DZXh8eeTuAHoYE3w1J… |
业务响应参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|
product_id | String | 必选 | 32 | 商品 ID | - | 202603230010000000000 |
响应示例
{
"alipay_trade_product_create_response": {
"code": "10000",
"msg": "Success",
"product_id": "202603230010000000000"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"alipay_trade_product_create_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
业务错误码
| 错误码 | 错误描述 | 解决方案 |
|---|
SYSTEM_ERROR | 系统繁忙 | 服务器异常。可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
INVALID_PARAMETER | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |