# 概述
feeds的销售伙伴API让你代表销售伙伴向亚马逊上传数据.
# Version information
版本 : 2021-06-30
# Operations
getFeeds
createFeed
getFeed
cancelFeed
createFeedDocument
getFeedDocument
# 路径
# getFeeds
GET /feeds/2021-06-30/feeds
# Description
返回符合你指定的过滤器的feeds的详细信息.
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Query | feedTypes optional | A list of feed types used to filter feeds.当提供feedTypes时，也可以提供其他过滤参数(processingStatuses, marketplaceIds, createdSince, createdUntil)和pageSize.需要feedTypes或nextToken. Min count : 1 *最大计数 : 10 | < string > array | - |
| Query | marketplaceIds optional | A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify. min count : 1 *最大计数 : 10 | < string > array | - |
| Query | pageSize optional | 在一次调用中返回的最大feeds数量. Minimum : 1 最大 : 100 | integer | 10 |
| Query | processingStatuses optional | A list of processing status used to filter feeds. Min count : 1 | < enum (ProcessingStatuses) > array | - |
| *Query | *createdSince optional | 响应中包含的最早的feeds创建日期和时间，ISO 8601格式.默认是90天前.feeds最多保留90天. | string (date-time) | - |
| *Query | *createdUntil optional | 响应中包含的馈送的最新创建日期和时间，ISO 8601格式.默认为现在. | string (date-time) | - |
| Query | nextToken optional | A string token in response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, 调用getFeeds操作，并将此令牌作为唯一的参数.指定nextToken与任何其他参数将导致请求失败. | string | - |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference ID. | GetFeedsResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头: x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 404 | 指定的资源不存在. Headers: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求). x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 415 | 请求的Content-Type头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式，见错误响应和模式.
# createFeed
POST /feeds/2021-06-30/feeds
# Description
创建一个feed.在调用此操作前上传feed文档的内容.
使用计划：
| 速率(每秒的请求) | 突发 |
|---|---|
| 0.0083 | 15 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | Information required to create the feed. | CreateFeedSpecification |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) x-amzn-RequestId (string) : Unique request reference ID. | CreateFeedResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头: x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 404 | 指定的资源不存在. Headers: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求). x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 415 | 请求的Content-Type头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式，见错误响应和模式.
# getFeed
GET /feeds/2021-06-30/feeds/{feedId}
# Description
返回您指定的feed的详细信息(包括 resultDocumentId，如果有的话)
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 2.0 | 15 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | feedId required | the identifier for the feed.此标识符只有在与卖家ID. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) : 独特的请求参考ID. | Feed |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头信息 : x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 404 | 指定的资源不存在. Headers: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求). x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 415 | 请求的Content-Type头无效. Headers : x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式，见错误响应和模式.
# cancelFeed
DELETE /feeds/2021-06-30/feeds/{feedId}
# Description
取消你指定的feed.只有处理状态=IN_QUEUE的feed可以被取消.取消的feed会在后续调用getFeed和getFeeds操作时返回.
使用计划：
| 速率(每秒的请求) | 突发 |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | feedId required | the identifier for the feed.此标识符只有在与卖家ID. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) : 唯一的请求参考ID. | No Content |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头信息 : x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 404 | 指定的资源不存在. Headers: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求). x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 415 | 请求的Content-Type头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式，见错误响应和模式.
# createFeedDocument
POST /feeds/2021-06-30/documents
# Description
为你指定的feed类型创建一个feed文档.该操作返回一个预设的URL，用于上传feed文档的内容.它还返回一个feedDocumentId值，你可以在后续调用createFeed操作时传入该值.
使用计划：
| 速率(每秒的请求) | 突发 |
|---|---|
| 0.0083 | 15 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | 指定createFeedDocument操作的内容类型. | CreateFeedDocumentSpecification |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | 成功创建了一个准备接收内容的馈送文件. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference ID. | CreateFeedDocumentResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头: x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 404 | 指定的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求). x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 415 | 请求的有效载荷是不支持的格式. 头信息: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
更多的错误状态代码、描述和模式，见错误响应和模式.
# getFeedDocument
GET /feeds/2021-06-30/documents/{feedDocumentId}
# Description
返回检索一个feed文档内容所需的信息.
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | feedDocumentId required | feed文档的标识符. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference ID. | FeedDocument |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头: x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 404 | 指定的资源不存在. Headers: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求). x-amzn-RequestId (string) : 唯一的请求参考ID. | ErrorList |
| 415 | 请求的Content-Type头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | ErrorList |
更多的错误状态代码、描述和模式，见错误响应和模式.
# 错误响应和模式
本表包含HTTP状态代码和错误响应的相关信息.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request有缺失或无效的参数，无法解析. Headers x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string):唯一的请求参考ID. | ErrorList |
| 401 | 请求的授权头格式不正确或不包含有效的令牌. 头 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string):唯一的请求参考ID. | ErrorList |
| 413 | 请求的大小超过了可接受的最大大小. **头信息 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string):唯一的请求参考ID. | ErrorList |
| 429 | 请求的频率超过了允许的范围. 标题 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string):唯一的请求参考ID. | ErrorList |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string):唯一的请求参考ID. | ErrorList |
| 503 | 服务器的临时超载或维护. 头信息 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string):唯一的请求参考ID. | ErrorList |
:唯一的请求参考编号.|ErrorList|
# Definitions
# Error
当请求不成功时返回的错误响应.
| Name | Description | Schema |
|---|---|---|
| code required | 一个错误代码，用于识别所发生的错误类型. | string |
| message required | 一个以人类可读的形式描述错误情况的信息. | string |
| details optional | 可以帮助呼叫者理解或解决这个问题的额外细节. | string |
# ErrorList
当一个请求不成功时返回的错误响应列表.
| Name | Schema |
|---|---|
| errors required | < Error > array |
# CreateFeedResponse
响应模式.
| Name | Description | Schema |
|---|---|---|
| feedId required | feed的标识符.这个标识符只有在与卖家ID. | string |
# Feed
关于feeds的详细信息.
| Name | Description | Schema |
|---|---|---|
| feedId required | feed的标识符.这个标识符只有在与卖家ID结合时才是唯一的. | string |
| feedType required | feed的类型. | string |
| marketplaceIds optional | A list of identifiers for the marketplaces that the feed is applied to. | < string > array |
| createdTime required | 创建feed的日期和时间，以ISO 8601日期时间格式. | string (date-time) |
| 处理状态 必须的 | feeds的处理状态. | enum (处理状态 |
| processingStartTime optional | feeds加工开始的日期和时间，ISO8601日期时间格式. | string (date-time) |
| 加工结束时间 可选 | feeds加工完成的日期和时间，ISO 8601日期时间格式. | string (date-time) |
| resultFeedDocumentId optional | feeds文件的标识符.这个标识符只有在与卖家ID结合时才是唯一的. | string |
# FeedList
一个feeds的列表.
类型 < Feed > 数组
# GetFeedsResponse
响应模式.
| Name | Description | Schema |
|---|---|---|
| feeds required | The feeds. | FeedList |
| nextToken optional | 当结果的数量超过pageSize时返回.要获得下一页的结果，调用getFeeds操作，将此token作为唯一参数. | string |
# FeedDocument
feeds文件所需的信息.
| Name | Description | Schema |
|---|---|---|
| feedDocumentId required | feed文档的标识符.该标识符只有在与卖方ID. | string |
| url required | A presigned URL for the feed document.这个URL在5分钟后过期. | string |
| compressionAlgorithm optional | 如果存在，feed文档内容将使用指定的算法进行压缩. | enum (CompressionAlgorithm) |
# FeedOptions
控制进给的附加选项.这些选项因进给类型而异.
类型 < string, string > map
# CreateFeedSpecification
创建feeds所需的信息.
| Name | Description | Schema |
|---|---|---|
| feedType required | The feed type. | string |
| marketplaceIds required | 你希望feed应用到的市场的标识符的列表. | < string > array |
| inputFeedDocumentId required | 由createFeedDocument操作返回的文档标识符.在调用createFeed操作之前上传feed文档内容. | string |
| feedOptions optional | 控制feed的附加选项.这些因feed类型而异. | FeedOptions |
# CreateFeedDocumentSpecification
指定 createFeedDocument 操作的内容类型.
| Name | Description | Schema |
|---|---|---|
| contentType required | feed的内容类型. | string |
# CreateFeedDocumentResponse
上传feeds文件内容所需的信息.
| Name | Description | Schema |
|---|---|---|
| feedDocumentId required | feed文档的标识符. | string |
| url required | 用于上传feed内容的预设URL.这个URL在5分钟后失效. | string |
# ProcessingStatuses
类型 : 枚举
| Value | Description |
|---|---|
| CANCELLED | feeds在开始处理前被取消了. |
| DONE | 该feeds已完成处理.检查结果文件的内容，以确定在处理过程中是否有任何错误. |
| FATAL | 由于致命的错误，馈送被中止了.馈送中的一些、没有或所有的操作可能已经成功完成. |
| IN_PROGRESS | 该feeds正在被处理. |
| IN_QUEUE | 该feed还没有开始处理.它可能在等待另一个IN_PROGRESS的feed. |
# ProcessingStatus
feeds的处理状态.
类型 : 枚举
| Value | Description |
|---|---|
| CANCELLED | feeds在开始处理前被取消了. |
| DONE | 该feeds已完成处理.检查结果文件的内容，以确定在处理过程中是否有任何错误. |
| FATAL | 由于致命的错误，馈送被中止了.馈送中的一些、没有或所有的操作可能已经成功完成. |
| IN_PROGRESS | 该feeds正在被处理. |
| IN_QUEUE | 该feeds还没有开始处理.可能在等待另一个IN_PROGRESSfeeds. |
# CompressionAlgorithm
如果存在，则使用指定的算法对进给文件内容进行压缩.
类型 : 枚举
| Value | Description |
|---|---|
| GZIP | gzip压缩算法. |