GetFootprintList - 获取产品碳足迹列表_能耗宝(Energy Expert)-阿里云帮助中心

获取产品碳足迹列表。

接口说明

用户指定企业编码、页码、页长等参数，本接口返回符合条件的产品碳足迹（或者供应链碳足迹）列表，其中包括了产品名称和产品 id 等信息，产品 id 在其他接口中会作为入参，以便获取对应的产品的结果信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/carbon/footprint/product/list HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求参数
code	string	是	企业编码	C-20080808-1
currentPage	long	是	分页参数，页码，从 1 开始。	1
pageSize	long	是	分页大小。	10
productType	long	是	产品类型：1 表示请求产品碳足迹，5 表示请求供应链碳足迹。	1

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 id，每次请求都是唯一值，便于后续排查问题。	06DA2909-7736-5738-AA31-ACD617D828F1
data	object	返回数据
currentPage	long	当前页码。	1
pageSize	long	分页大小。	10
records	array<object>	产品详情列表
record	object	产品信息结构体
id	long	产品 id	1024
name	string	产品名称	演示产品
authStatus	long	认证状态枚举值，参考附录。	1
amount	double	产品数量	100.0000000000000000000000000
checkStartTime	string	计算开始时间	2024/01/01
checkEndTime	string	计算结束时间	2024/01/31
createdBy	string	创建者	Energy Expert
code	string	所属企业编码	C-20080808-1
isDemoModel	long	是否是展示模型，1 为真值，0 为假值，真值表示系统内置的演示模型	1
lifeCycle	string	与 lifeCycleType 对应的文字表述，`从摇篮到大门`或者`从摇篮到坟墓`。	从摇篮到大门
lifeCycleType	long	1 是从摇篮到大门，2 是从摇篮到坟墓。	1
type	string	产品分类枚举值，参考附录。	158-159
unit	string	单位枚举值，参考附录。	1-4
total	long	总记录数。	21
totalPage	long	总页数	3

示例

正常返回示例

JSON格式

{
  "requestId": "06DA2909-7736-5738-AA31-ACD617D828F1",
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "records": [
      {
        "id": 1024,
        "name": "演示产品",
        "authStatus": 1,
        "amount": 100,
        "checkStartTime": "2024/01/01",
        "checkEndTime": "2024/01/31",
        "createdBy": "Energy Expert",
        "code": "C-20080808-1",
        "isDemoModel": 1,
        "lifeCycle": "从摇篮到大门",
        "lifeCycleType": 1,
        "type": "158-159",
        "unit": "1-4"
      }
    ],
    "total": 21,
    "totalPage": 3
  }
}

错误码

访问错误中心查看更多错误码。