getSellingPartnerMetrics

北美(North America）

https://sellingpartnerapi-na.amazon.com

POST

/replenishment/2022-11-07/sellingPartners/metrics/search

Replenishment

返回销售合作伙伴的聚合补货程序指标。

使用计划：

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

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

请求参数

Body 参数application/json

`getSellingPartnerMetrics` 操作的请求主体。

aggregationFrequency

enum<string>

可选

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

枚举值:

WEEKMONTHQUARTERYEAR

timeInterval

object (TimeInterval)

必需

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

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

startDate

string <date-time>

必需

当这个对象用作请求参数时，指定的 startDate 会根据聚合频率进行调整。

对于 WEEK，该指标从包含 startDate 的那一周的第一天（星期日，基于 ISO 8601）开始计算。

对于 MONTH，该指标从包含 startDate 的那个月的第一天开始计算。

对于 QUARTER，该指标从包含 startDate 的那一季度的第一天开始计算。

对于 YEAR，该指标从包含 startDate 的那一年的第一天开始计算。

endDate

string <date-time>

必需

当此对象用作请求参数时，指定的 endDate 会根据聚合频率进行调整。

对于 WEEK，指标计算到包含 endDate 的最后一周的最后一天（星期天，基于 ISO 8601）。

对于 MONTH，指标计算到包含 endDate 的最后一天。

对于 QUARTER，指标计算到包含 endDate 的季度的最后一天。

对于 YEAR，指标计算到包含 endDate 的年份的最后一天。
注意：结束日期可能会基于我们系统中可用的数据调整为较低的值。

metrics

array[string]

可选

请求的指标列表。如果未提供指标值，将返回所有指标的数据。

>= 1 items

枚举值:

SHIPPED_SUBSCRIPTION_UNITSTOTAL_SUBSCRIPTIONS_REVENUEACTIVE_SUBSCRIPTIONSNOT_DELIVERED_DUE_TO_OOSSUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUELOST_REVENUE_DUE_TO_OOSSUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERSCOUPONS_REVENUE_PENETRATION

timePeriodType

enum<string>

必需

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

枚举值:

PERFORMANCEFORECAST

marketplaceId

string

必需

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

programTypes

array[string]

补货计划类型列表。

必需

>= 1 items

枚举值:

SUBSCRIBE_AND_SAVE

示例

{
    "aggregationFrequency": "WEEK",
    "timeInterval": {
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z"
    },
    "metrics": [
        "SHIPPED_SUBSCRIPTION_UNITS"
    ],
    "timePeriodType": "PERFORMANCE",
    "marketplaceId": "string",
    "programTypes": [
        "SUBSCRIBE_AND_SAVE"
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/sellingPartners/metrics/search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "aggregationFrequency": "WEEK",
    "timeInterval": {
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z"
    },
    "metrics": [
        "SHIPPED_SUBSCRIPTION_UNITS"
    ],
    "timePeriodType": "PERFORMANCE",
    "marketplaceId": "string",
    "programTypes": [
        "SUBSCRIBE_AND_SAVE"
    ]
}'

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

`getSellingPartnerMetrics` 操作的响应模式。

metrics

array[object (GetSellingPartnerMetricsResponseMetric) {12}]

可选

卖方的指标数据列表。

notDeliveredDueToOOS

number <double>

可选

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

>= 0<= 100

totalSubscriptionsRevenue

number <double>

可选

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

>= 0

shippedSubscriptionUnits

number <int64>

可选

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

>= 0

activeSubscriptions

number <int64>

可选

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

>= 0

subscriberAverageRevenue

number <double>

可选

该计划在过去12个月内的每位订阅者的平均收入（针对卖家）和过去6个月内的每位订阅者的平均收入（针对供应商）。仅适用于PERFORMANCE timePeriodType。

>= 0

nonSubscriberAverageRevenue

number <double>

可选

该计划在过去12个月对卖家的非订阅者的平均收入，以及过去6个月对供应商的非订阅者的平均收入。仅适用于PERFORMANCE timePeriodType。

>= 0

lostRevenueDueToOOS

number <double>

可选

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

>= 0

subscriberAverageReorders

number <double>

可选

该程序在12个月期间内每个订阅者的平均复购次数。仅适用于PERFORMANCE时间周期类型。

>= 0

nonSubscriberAverageReorders

number <double>

可选

过去12个月内，非订阅用户的平均重订次数。仅适用于PERFORMANCE时间周期类型。

>= 0

couponsRevenuePenetration

number <double>

可选

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

>= 0<= 100

timeInterval

object (TimeInterval)

可选

currencyCode

string

可选

ISO 4217 格式的货币代码。

示例

{
    "metrics": [
        {
            "subscriberAverageRevenue": 125.93,
            "nonSubscriberAverageRevenue": 73.62,
            "shippedSubscriptionUnits": 5290,
            "notDeliveredDueToOOS": 5.54,
            "totalSubscriptionsRevenue": 131340.24,
            "activeSubscriptions": 0,
            "lostRevenueDueToOOS": 38493.29,
            "subscriberAverageReorders": 3.25,
            "nonSubscriberAverageReorders": 1.11,
            "couponsRevenuePenetration": 0,
            "currencyCode": "USD",
            "timeInterval": {
                "endDate": "2023-05-09T22:36:56Z",
                "startDate": "2022-05-09T22:36:56Z"
            }
        }
    ]
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠413413

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

getListingOffersBatch

listOfferMetrics