Lingxing
切换旧版

利润报表 - 列表配置查询

POST/basicOpen/finance/profitReport/config

接口信息

API Path请求协议请求方式令牌桶容量
/basicOpen/finance/profitReport/configHTTPSPOST1

请求参数

无需传入请求参数

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/finance/profitReport/config?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{

}'

返回结果

Json Object

codeinteger必填
状态码,0:成功
示例 0
messagestring必填
消息提示
示例 success
error_detailsarray<any>必填
数据校验失败时的错误详情
request_idstring必填
请求链路id
示例 b2ba3388cbee49a7bb4c7add1f1948fa
response_timestring必填
响应时间
示例 2026-04-09 12:00:00
dataobject必填
响应数据
隐藏子属性
profitGrouparray<object>必填
利润报表配置分组列表
隐藏子属性
itemTypeinteger必填
类型:1=收入,2=税费,3=费用,4=成本,5=利润
示例 1
itemTypeNamestring必填
类型名称
示例 收入
namestring必填
一级利润项目名称
示例 平台收入
itemsarray<object>必填
该一级项目下的所有二级配置项
隐藏子属性
itemTypeinteger必填
类型:1=收入,2=税费,3=费用,4=成本,5=利润
示例 1
itemTypeNamestring必填
类型名称
示例 收入
itemFieldstring必填
二级利润项目字段名
示例 salesAmount
itemNamestring必填
二级利润项目
示例 销售额
parentItemNamestring必填
一级利润项目
示例 平台收入
displayFormatinteger必填
显示格式:1=整数,2=金额,3=百分比
示例 2
displayFormatNamestring必填
显示格式名称
示例 金额
sortOrderinteger必填
排序顺序
示例 1
tooltipstring必填
气泡注释
fieldsarray<object>必填
关联的明细字段列表
隐藏子属性
fieldNamestring必填
字段名称
示例 salesAmount
displayNamestring必填
显示名称
示例 销售额
platformCodesarray<any>必填
适用的平台代码列表
示例 ["AMAZON"]
totalinteger必填
总数
示例 0

返回成功示例

{
    "code": 0,
    "message": "success",
    "error_details": [],
    "request_id": "b2ba3388cbee49a7bb4c7add1f1948fa",
    "response_time": "2026-04-09 17:06:17",
    "data": {
        "profitGroup": [
            {
                "itemType": 1,
                "itemTypeName": "收入",
                "name": "平台收入",
                "items": [
                    {
                        "displayFormat": 2,
                        "displayFormatName": "金额",
                        "fields": null,
                        "itemField": "salesAmount",
                        "itemName": "销售额",
                        "itemType": 1,
                        "itemTypeName": "收入",
                        "parentItemName": "平台收入",
                        "sortOrder": 1,
                        "tooltip": ""
                    },
                    {
                        "displayFormat": 2,
                        "displayFormatName": "金额",
                        "fields": null,
                        "itemField": "promotionDiscount",
                        "itemName": "促销折扣",
                        "itemType": 1,
                        "itemTypeName": "收入",
                        "parentItemName": "平台收入",
                        "sortOrder": 99,
                        "tooltip": ""
                    }
                ]
            },
            {
                "itemType": 5,
                "itemTypeName": "利润",
                "name": "利润",
                "items": [
                    {
                        "displayFormat": 2,
                        "displayFormatName": "金额",
                        "fields": null,
                        "itemField": "profit",
                        "itemName": "利润",
                        "itemType": 5,
                        "itemTypeName": "利润",
                        "parentItemName": "利润",
                        "sortOrder": 2,
                        "tooltip": "=销售收益+收入退款+..."
                    }
                ]
            }
        ]
    },
    "total": 0
}

附加说明

1. 部分二级利润项目无明细字段列表(fields 为 null)

部分二级利润项目(如成本类型、利润类型字段)没有关联的明细字段列表,返回的 fields 为 null。

对于这类项目,应直接使用其 itemField 值去匹配利润报表-明细列表查询接口返回的 profitItems 中的字段名。

涉及的典型字段举例:

itemFielditemName所属一级项目
productCost采购成本成本
firstLegCost头程费用成本
otherCost其他成本成本
costSubtotal成本小计成本
thirdPartyDeliveryFee三方配送费仓储物流费
profit利润利润

2. 自定义费用字段的前缀匹配规则

自定义费用会受到费用管理模块以及列表筛选范围的影响而动态变化。本配置接口仅返回一个统一的占位项 customFee,而在利润报表-明细列表查询接口的 configList 中,会返回实际展开后的自定义费用字段。

匹配规则: 自定义费用的 itemField 格式统一为 customFee + 费用ID,需要使用 customFee 作为前缀进行匹配。

示例:

配置接口返回(本接口):

{
    "itemField": "customFee",
    "itemName": "自定义费用",
    "fields": null
}

明细列表接口 configList 实际返回:

[
    { "itemField": "customFee101", "itemName": "包装费" },
    { "itemField": "customFee102", "itemName": "质检费" },
    { "itemField": "customFee205", "itemName": "贴标费" }
]

因此,在做字段映射时,应对 itemField 以 customFee 为前缀进行匹配,将所有 customFee* 字段归类到自定义费用项下。