销售API v1参考

亚马逊SPAPI

# 概述

销售合作伙伴API提供与销售业绩相关的API.

# Version information

版本 : v1

# Operations

getOrderMetrics
<a name="paths">

# 路径

<a name="getordermetrics">

# getOrderMetrics

**GET /sales/v1/orderMetrics **

# Description

返回给定时间间隔的汇总订单指标,按颗粒度细分,针对给定的买方类型.

使用计划:

Rate (requests per second) Burst
.5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema Default
Query marketplaceIds
required
A list of marketplace identifiers. 示例ATVPDKIKX0DER表示美国市场. < string > array -
Query interval
required
A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00请求在-07:00区订购9月1日、2日和3日的指标. string -
Query granularityTimeZone
optional
An IANA-compatible time zone for determining the day boundary.required when specified a granularity value greater than Hour. granularityTimeZone value must align with the offset of the specified interval value. For example, 如果间隔值使用Z符号,那么granularityTimeZone必须是UTC. 如果间隔值使用偏移量,那么granularityTimeZone必须是与偏移量相匹配的IANA-兼容的时区. 示例US/Pacific计算日界,考虑到夏令时,为US/Pacific区. string -
Query granularity
required
订单指标分组的粒度,基于时间单位.指定granularity=Hour的结果是,只有当指定的时间间隔小于或等于从现在开始的30天,请求才会成功.对于所有其他粒度指定的间隔必须小于或等于从现在开始的2年. 指定粒度=总数的结果是在你指定的整个间隔内汇总的订单指标. 如果间隔的开始和结束日期与指定的粒度不一致,响应间隔的头部和尾部将包含部分数据. 例如日来获得请求间隔的每日细分,其中日的边界由粒度TimeZone. enum (粒度) -
Query buyerType
optional
按您指定的买家类型过滤结果,B2B (business to business)或B2C (business to customer).示例B2B,如果你希望响应只包括B2B买家的订单指标. enum (BuyerType "All"
Query fulfillmentNetwork
optional
按您指定的履行网络过滤结果,MFN (merchant fulfillment network)或AFN (Amazon fulfillment network).如果您希望响应包括所有履行网络的订单指标,请不要包含这个过滤器.例子AFN,如果你希望响应中只包括亚马逊履行网络的订单指标. string -
Query firstDayOfWeek
optional
指定granularity=Week时一周开始的日子,可以是周一或周日.默认星期一.例子星期日,如果你想让一周从星期日开始. enum (FirstDayOfWeek) "星期一"
Query asin
optional
按您指定的ASIN过滤结果.同时指定ASIN和SKU会返回一个错误.如果您希望响应包括所有ASIN的订单指标,请不要包括这个过滤器.例子B0792R1RSN,如果您希望响应只包括ASIN的订单指标 B0792R1RSN. string -
Query sku
optional
按您指定的SKU过滤结果.同时指定ASIN和SKU会返回一个错误.如果您希望响应包括所有SKU的订单指标,请不要包括这个过滤器.例子TestSKU,如果您希望响应中只包括SKU TestSKU. string -

# Responses

HTTP Code Description Schema
200 OrderMetric对资源采取的行动 OrderMetrics.
Headers :
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求..
x-amzn-RequestId (string) unique request reference id.
GetOrderMetricsResponse

错误状态代码、描述和模式,见错误响应和模式.

<a name="error-responses-and-schemas">

# 错误响应和模式

该表包含HTTP状态代码和错误响应的相关信息.

HTTP Code Description Schema
400 Request有缺失或无效的参数,无法解析.
Headers
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
GetOrderMetricsResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
**头
x-amzn-RequestId (string):Unique request reference id.
GetOrderMetricsResponse
404 指定的资源不存在.

x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
GetOrderMetricsResponse
413 请求的大小超过了最大接受的大小.

x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考ID.
GetOrderMetricsResponse
415 请求的实体的格式不被请求的资源所支持.
头信息
x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考ID.
GetOrderMetricsResponse
429 请求的频率超过了允许的范围.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考ID.
GetOrderMetricsResponse
500 遇到了一个意外情况,使服务器无法完成请求.
***头信息
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考ID.
GetOrderMetricsResponse
503 服务器的临时超载或维护.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考ID.
GetOrderMetricsResponse

<a name="definitions">

# Definitions

<a name="getordermetricsresponse">

# GetOrderMetricsResponse

getOrderMetrics操作的响应模式.

Name Description Schema
payload
optional
getOrderMetrics操作的有效载荷. OrderMetricsList
errors
optional
在 getOrderMetrics 操作中遇到的错误. ErrorList

<a name="ordermetricslist">

# OrderMetricsList

一组订单指标,每个指标都适用于一个特定的时间区间.

类型: < OrderMetricsInterval > 数组

<a name="ordermetricsinterval">

# OrderMetricsInterval

包含订单指标.

Name Description Schema
interval
required
基于请求的粒度的时间间隔(ex.小时、日等.)如果这是列表中的第一个或最后一个间隔,如果请求的间隔与请求的粒度不一致,它可能包含不完整的数据(ex.请求间隔 2018-09-01T02 00:00Z--2018-09-04T19:00:00Z和颗粒度日将导致9月1日UTC日和9月4日UTC日有部分数据). string
unitCount
required
根据指定的过滤器,订单中的单位数量. integer
*orderItemCount
required
基于指定的过滤器的订单项目的数量. integer
orderCount
required
基于指定过滤器的订单数量. integer
averageUnitPrice
required
基于指定的过滤器的物品的平均价格.公式为totalSales/unitCount. Money
totalSales
required
根据指定的过滤器,所有订单的产品销售总额. Money

<a name="error">

# Error

当请求不成功时返回的错误响应.

Name Description Schema
code
required
一个错误代码,用于识别发生的错误类型. string
message
required
一个以人类可读的形式描述错误情况的信息. string
details
optional
可以帮助呼叫者理解或解决这个问题的额外细节. string

<a name="errorlist">

# ErrorList

当一个请求不成功时返回的错误响应列表.

类型 < Error > 数组

<a name="money">

# Money

货币类型和金额.

Name Description Schema
currencyCode
required
三位数的货币代码.在ISO 4217格式中. string
amount
required
The currency amount. Decimal

<a name="十进制">

# Decimal

一个没有精度损失的十进制数.在不能接受精度损失的情况下很有用,比如货币.遵循RFC7159的数字表示法.

类型:字符串

<a name="buyertype">

# BuyerType

按你指定的买方类型过滤结果,B2B (企业对企业)或B2C (企业对客户).例子B2B,如果你希望响应中只包括B2B买家的订单指标.

类型 : 枚举

Value Description
B2B 企业对企业.
B2C 企业对客户.
所有 企业对企业和企业对客户.

<a name="granularity">

# Granularity

订单指标分组的粒度,以时间单位为基础.指定粒度=小时,只有在指定的间隔小于或等于从现在开始的30天时,请求才会成功.对于所有其他粒度指定的间隔必须小于或等于从现在开始的2年. 指定粒度=总的结果是在你指定的整个间隔内汇总的订单指标. 如果间隔的开始和结束日期与指定的粒度不一致,响应间隔的头部和尾部将包含部分数据. 例如日来获得请求区间的每日细分,其中日的边界由粒度TimeZone定义.

类型 : 枚举

Value Description
Hour Hour
Day Day
Week Week
Month Month
Year Year
Total Total

<a name="firstdayofweek">

# FirstDayOfWeek

指定当颗粒度=周时,一周开始的日子,可以是星期一或星期日. 默认星期一. 例子星期日,如果你想让一周从星期日开始.

类型 : 枚举

Value Description
Monday Monday
Sunday Sunday
Last Updated: 2022/10/17 下午9:17:02