listOfferMetrics - Amazon Selling Partner API (SP-API)-中文

返回销售合作伙伴报价的聚合补给计划指标。

使用计划：

速率（每秒请求次数）	突发
1	1

x-amzn-RateLimit-Limit 响应头返回已应用于请求操作的使用计划速率限制（如果可用）。上表指示此操作的默认速率和突发值。业务需求较高的销售合作伙伴可能会看到比这里显示的更高的速率和突发值。有关更多信息，请参阅销售合作伙伴 API 中的使用计划和速率限制。

请求参数

Body 参数application/json

`listOfferMetrics` 操作的请求主体。

pagination

object (ListOfferMetricsRequestPagination)

必需

使用这些参数来分页响应。

limit

integer <int64>

必需

响应中返回的最大结果数量。

>= 1<= 500

offset

integer <int64>

必需

检索由 limit 值指定的结果数量的偏移量。第一个结果位于偏移量 0。

>= 0<= 9000

sort

object (ListOfferMetricsRequestSort)

可选

使用这些参数对响应进行排序。

order

enum<string>

排序顺序。

必需

枚举值:

ASCDESC

key

enum<string>

必需

用于排序结果的属性。

枚举值:

SHIPPED_SUBSCRIPTION_UNITSTOTAL_SUBSCRIPTIONS_REVENUEACTIVE_SUBSCRIPTIONSNEXT_90DAYS_SHIPPED_SUBSCRIPTION_UNITSNEXT_60DAYS_SHIPPED_SUBSCRIPTION_UNITSNEXT_30DAYS_SHIPPED_SUBSCRIPTION_UNITSNEXT_90DAYS_TOTAL_SUBSCRIPTIONS_REVENUENEXT_60DAYS_TOTAL_SUBSCRIPTIONS_REVENUENEXT_30DAYS_TOTAL_SUBSCRIPTIONS_REVENUE

filters

object (ListOfferMetricsRequestFilters)

必需

使用这些参数来过滤结果。任何结果必须匹配所有提供的参数。对于任何数组类型的参数，结果必须匹配提供的数组中的至少一个元素。

aggregationFrequency

enum<string>

可选

用于对响应中的数据进行分组的时间段。请注意，这仅对 PERFORMANCE 时间段类型有效。

枚举值:

WEEKMONTHQUARTERYEAR

timeInterval

object (TimeInterval)

必需

一个以ISO 8601格式表示的日期时间间隔，用于计算指标。只需日期，但必须传递完整的日期和时间值。例如，2022年11月11日应传递为“2022-11-07T00:00:00Z”。请注意，仅支持过去2年的数据。

注意：listOfferMetrics操作仅支持覆盖聚合频率的单个单位的时间间隔。例如，对于一个月的聚合频率，startDate和endDate之间的间隔持续时间不能超过1个月。

timePeriodType

enum<string>

必需

确定所请求指标是向后看的（表现）还是向前看的（预测）的时间段类型。

枚举值:

PERFORMANCEFORECAST

marketplaceId

string

必需

市场标识符。卖家和供应商支持的市场包括美国、加拿大、西班牙、英国、法国、意大利、印度、德国和日本。仅供应商支持的市场包括巴西、澳大利亚、墨西哥、阿联酋和荷兰。请参阅市场ID 查找市场的标识符。

programTypes

array[string]

补货计划类型列表。

必需

>= 1 items

枚举值:

SUBSCRIBE_AND_SAVE

asins

array[string]

可选

亚马逊标准识别号码（ASIN）列表。

>= 1 items<= 20 items

示例

{
    "pagination": {
        "limit": 1,
        "offset": 0
    },
    "sort": {
        "order": "ASC",
        "key": "SHIPPED_SUBSCRIPTION_UNITS"
    },
    "filters": {
        "aggregationFrequency": "WEEK",
        "timeInterval": {
            "startDate": "2019-08-24T14:15:22Z",
            "endDate": "2019-08-24T14:15:22Z"
        },
        "timePeriodType": "PERFORMANCE",
        "marketplaceId": "string",
        "programTypes": [
            "SUBSCRIBE_AND_SAVE"
        ],
        "asins": [
            "string"
        ]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

您对此操作的速率限制（每秒请求数量）。

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

`listOfferMetrics` 操作的响应模式。

offers

array[object (ListOfferMetricsResponseOffer) {16}]

可选

一份优惠及相关指标的列表。

asin

string

可选

亚马逊标准识别号码（ASIN）

notDeliveredDueToOOS

number <double>

可选

在一段时间内，由于缺货而未发货的商品占总发货单位的百分比。仅适用于 PERFORMANCE timePeriodType。

>= 0<= 100

totalSubscriptionsRevenue

number <double>

可选

在一段时间内通过订阅产生的收入。仅适用于PERFORMANCE timePeriodType。

>= 0

shippedSubscriptionUnits

number <int64>

可选

在一段时间内发货给订阅者的单位数量。仅适用于 PERFORMANCE timePeriodType。

>= 0

activeSubscriptions

number <int64>

可选

期末活跃订阅的数量。仅适用于 PERFORMANCE timePeriodType。

>= 0

revenuePenetration

number <double>

可选

总项目收入占总产品收入的百分比。仅适用于 PERFORMANCE timePeriodType。

>= 0<= 100

lostRevenueDueToOOS

number <double>

可选

如果没有缺货，将会产生的收入。仅适用于 PERFORMANCE 时间类型。

>= 0

couponsRevenuePenetration

number <double>

可选

来自带有优惠券的ASIN的收入占所有ASIN总收入的百分比。仅适用于PERFORMANCE时间周期类型。

>= 0<= 100

next30DayTotalSubscriptionsRevenue

number <double>

可选

未来30天的预计总订阅收入。仅适用于 FORECAST timePeriodType。

>= 0

next60DayTotalSubscriptionsRevenue

number <double>

可选

预测的未来60天的总订阅收入，仅适用于FORECAST timePeriodType。

>= 0

next90DayTotalSubscriptionsRevenue

number <double>

可选

下90天的预计总订阅收入。仅适用于 FORECAST timePeriodType。

>= 0

next30DayShippedSubscriptionUnits

number <int64>

可选

未来30天的预期发货订阅单位。仅适用于 FORECAST timePeriodType。

>= 0

next60DayShippedSubscriptionUnits

number <int64>

可选

预计未来60天的发货订阅单位。仅适用于 FORECAST timePeriodType。

>= 0

next90DayShippedSubscriptionUnits

number <int64>

可选

预计在接下来的90天内发货的订阅单位。仅适用于FORECAST timePeriodType。

>= 0

timeInterval

object (TimeInterval)

可选

currencyCode

string

可选

ISO 4217 格式的货币代码。

pagination

object (PaginationResponse)

可选

使用这些参数来分页响应。

totalResults

integer <int64>

可选

与给定筛选条件匹配的结果总数。

>= 0

示例

{
    "offers": [
        {
            "notDeliveredDueToOOS": 30.78,
            "shippedSubscriptionUnits": 20,
            "totalSubscriptionsRevenue": 12.89,
            "asin": "B000TMUDOW",
            "revenuePenetration": 10.34,
            "lostRevenueDueToOOS": 12.32,
            "couponsRevenuePenetration": 10,
            "timeInterval": {
                "endDate": "2023-03-11T00:00:00Z",
                "startDate": "2023-03-05T00:00:00Z"
            },
            "currencyCode": "USD"
        },
        {
            "notDeliveredDueToOOS": 40.78,
            "shippedSubscriptionUnits": 40,
            "totalSubscriptionsRevenue": 34.03,
            "asin": "B004CLH5CY",
            "revenuePenetration": 9.87,
            "lostRevenueDueToOOS": 17.82,
            "couponsRevenuePenetration": 17,
            "timeInterval": {
                "endDate": "2023-03-11T00:00:00Z",
                "startDate": "2023-03-05T00:00:00Z"
            },
            "currencyCode": "USD"
        }
    ],
    "pagination": {
        "totalResults": 17
    }
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障