API 中心

数字工厂底座

地市云

查询商品详情

最近更新时间：11/9/2023, 4:18:45 PM作者：andrewren(任豪)

本页目录：

接口描述

接口请求域名：http://product-mgmt-api.{工业环境域名}

接口类型：OpenAPI

接口请求方式：POST

接口名：DescribeProduct

本接口用于查询商品详情。

输入参数

参数名称 必选 类型 描述
Action 是 String openapi公共参数，本接口取值：DescribeProduct
ProductUuid 是 String 商品uuid
IsPortal 是 Boolean 门户控制参数,前端无需传入

输出参数

Response

参数名称 类型 描述
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId
ProductInfo ProductInfo 门户详情返回数据

ProductInfo

参数名称 类型 描述
ProductUuid String 商品uuid
BaseInfo BaseInfo 商品基础信息
Category Category 商品分类
Categories Array of Categories（同上） 商品分类
IsvInfo IsvInfo 服务商信息
SpInfo SpInfo SP客服信息
State State 商品状态
TcState State 云市场商品状态
SaleNodeUuids Array of String SaleNodeUuids
DeleteFlag boolean 是否已删除
SpPriceFlag boolean 是否允许修改价格
NeedStock boolean 是否需要库存
SurplusStock Integer 剩余库存
StockCount Integer 总库存
Optional Optional(同上) 业务侧扩展信息

BaseInfo

参数名称 类型 描述
ProductName String 商品名
ProductType String 商品类型，取值: cvm: 云主机 cbs: 云硬盘 ip: 公网ip
ProductSource String 商品来源, 取值: yun: 腾讯云市场 sp: 地市运营商 iop_third: 第三方服务商
DeliverType String 交付方式：saas，manual
Summary String 概要
Logo String logo
SaleSpecs Array of SaleSpecs 售卖规格及价格
LocalSaleSpecs Array of LocalSaleSpecs 本地售卖规格及价格
Detail String 详情
ProtocolId String 用户协议id
Illustrations Array of String 商品多张图片
Documents Array of Documents 商品多张图片
TagSet Array of TagSet 商品多张图片

Documents

参数名称 类型 描述
Name String 文档名称
Url String 文档地址

TagSet

参数名称 类型 描述
MinPrice Integer 最低价格
OrderId Integer 商品权重
RecId Integer 列表推荐序号
RecTopOrder Integer 首页推荐序号

Category

参数名称 类型 描述
CategoryUuid String 类目uuid
CategoryName String 类目名称

IsvInfo

参数名称 类型 描述
OwnerUin Integer 服务商uin
Type String 服务商类型：yun, sp
Name String 服务商名称
Address String 联系地址
CustomerServicePhone String 客服电话
CustomerServiceEmail String 客服邮箱
CustomerServiceQQSet CustomerServiceQQSet 客服QQ
StoreId Integer 服务商id
CustomerServiceUrl String 企点接入组件链接
OpenQidian boolean 是否接入企点客服
QQServiceTime String 客服工作时间

CustomerServiceQQSet

参数名称 类型 描述
QQ String 客服QQ
Name String QQ昵称

SpInfo

参数名称 类型 描述
Name String 服务商名称
ContactAddress String 联系地址
ServicePhone String 客服电话
ServiceMail String 客服邮箱
WorkDay String 工作日的工作时间
ShowWorkDay boolean 是否展示工作日工作时间
Saturday String 周六的工作时间
ShowSaturday boolean 是否展示周六工作时间
Sunday String 周日的工作时间
ShowSunday boolean 是否展示周日工作时间
OpenQidian boolean 是否接入企点客服
QidianTermLink String 企点接入组件链接

State

参数名称 类型 描述
PublishState String 发布状态：上下架 default/published/publishing/offline
AuditState String 审核状态：default/auditing/approved/rejected
CreateTime Integer 创建时间戳(s)
VerifyTime Integer 商品审核时间戳
PublishTime Integer 最新发布时间戳
ModifyTime Integer 修改时间戳
AuditComment String 审核意见
LocalPublishState String 地市侧发布状态： 上下架 default/published/offline

示例

示例1 请求例子

输入示例

{
  "Action": "DescribeProduct",
  "ProductUuid": "xxxx"
}

输出示例

{
  "Response": {
    "RequestId": "string",
    "ProductInfo": {
      "ProductUuid": "string",
      "BaseInfo": {
        "ProductName": "string",
        "ProductType": "string",
        "ProductSource": "string",
        "DeliverType": "string",
        "Summary": "string",
        "Logo": "string",
        "SaleSpecs": [
          {
            "SpecUuid": "string",
            "Name": "string",
            "RenewMonthPrice": 3,
            "RenewYearPrice": 3,
            "OnTrial": true,
            "TrialDays": 3,
            "OnOffer": true,
            "MaxQuota": 3,
            "ExtendInfo": "string",
            "PriceCycles": [
              {
                "TimeSpan": 3,
                "TimeUnit": "string",
                "Price": 3,
                "Disprice": 3,
                "CustomSaleSpecs": [
                  {
                    "CustomUuid": "string",
                    "Name": "string",
                    "Value": "string",
                    "Type": "string",
                    "NameEn": "string",
                    "UintType": "string",
                    "Uint": "string",
                    "Disprice": 3,
                    "RenewMonthPrice": 3,
                    "RenewYearPrice": 3,
                    "RelatedProductUuids": [
                      "string"
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "LocalSaleSpecs": [
          {
            "SpecUuid": "string",
            "Name": "string",
            "RenewMonthPrice": 3,
            "RenewYearPrice": 3,
            "OnTrial": true,
            "TrialDays": 3,
            "OnOffer": true,
            "MaxQuota": 3,
            "ExtendInfo": "string",
            "PriceCycles": [
              {
                "TimeSpan": 3,
                "TimeUnit": "string",
                "Price": 3,
                "Disprice": 3,
                "CustomSaleSpecs": [
                  {
                    "CustomUuid": "string",
                    "Name": "string",
                    "Value": "string",
                    "Type": "string",
                    "NameEn": "string",
                    "UintType": "string",
                    "Uint": "string",
                    "Disprice": 3,
                    "RenewMonthPrice": 3,
                    "RenewYearPrice": 3,
                    "RelatedProductUuids": [
                      "string"
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "Detail": "string",
        "ProtocolId": 3,
        "Illustrations": [
          "string"
        ],
        "Documents": [
          {
            "Name": "string",
            "Url": "string"
          }
        ],
        "TagSet": [
          "string"
        ]
      },
      "Category": {
        "CategoryUuid": "string",
        "CategoryName": "string"
      },
      "Categories": [
        {
          "CategoryUuid": "string",
          "CategoryName": "string"
        }
      ],
      "IsvInfo": {
        "OwnerUin": 3,
        "Type": "string",
        "Name": "string",
        "Address": "string",
        "CustomerServicePhone": "string",
        "CustomerServiceEmail": "string",
        "CustomerServiceQQSet": {
          "QQ": "string",
          "Name": "string"
        },
        "StoreId": 3,
        "OpenQidian": true,
        "CustomerServiceUrl": "string",
        "QQServiceTime": "string"
      },
      "SpInfo": {
        "Name": "string",
        "ContactAddress": "string",
        "ServicePhone": "string",
        "ServiceMail": "string",
        "WorkDay": "string",
        "ShowWorkDay": true,
        "Saturday": "string",
        "ShowSaturday": true,
        "Sunday": "string",
        "ShowSunday": true,
        "OpenQidian": true,
        "QidianTermLink": "string"
      },
      "State": {
        "PublishState": "string",
        "AuditState": "string",
        "CreateTime": 3,
        "VerifyTime": 3,
        "PublishTime": 3,
        "ModifyTime": 3,
        "AuditComment": "string",
        "LocalPublishState": "string"
      },
      "TcState": {
        "PublishState": "string",
        "AuditState": "string",
        "CreateTime": 3,
        "VerifyTime": 3,
        "PublishTime": 3,
        "ModifyTime": 3,
        "AuditComment": "string",
        "LocalPublishState": "string"
      },
      "SaleNodeUuids": [
        "string"
      ],
      "DeleteFlag": true,
      "SpPriceFlag": true,
      "NeedStock": true,
      "StockCount": 3,
      "SurplusStock": 3,
      "Optional": {
        "Optional1": "string",
        "Optional2": [
          "string"
        ]
      }
    }
  }
}

错误码

以下仅列出了接口业务逻辑相关的错误码

错误码 描述