Selling Partner API for Feeds (2021-06-30)

The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.

feeds

getFeeds

Returns feed details for the feeds that match the filters that you specify.

Usage Plan:

Rate (requests per second) Burst
0.0222 10

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

query Parameters
feedTypes
Array of strings [ 1 .. 10 ] items

A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.

marketplaceIds
Array of strings [ 1 .. 10 ] items

A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.

pageSize
integer [ 1 .. 100 ]
Default: 10

The maximum number of feeds to return in a single call.

processingStatuses
Array of strings non-empty
Items Enum: "CANCELLED" "DONE" "FATAL" "IN_PROGRESS" "IN_QUEUE"

A list of processing statuses used to filter feeds.

createdSince
string <date-time>

The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.

createdUntil
string <date-time>

The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.

nextToken
string

A string token returned in the 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, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.

Responses

Response samples

Content type
application/json
{
  • "feeds": [
    ],
  • "nextToken": "string"
}

createFeed

Creates a feed. Upload the contents of the feed document before calling this operation.

Usage Plan:

Rate (requests per second) Burst
0.0083 15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request Body schema: application/json
feedType
required
string

The feed type.

marketplaceIds
required
Array of strings [ 1 .. 25 ] items

A list of identifiers for marketplaces that you want the feed to be applied to.

inputFeedDocumentId
required
string

The document identifier returned by the createFeedDocument operation. Upload the feed document contents before calling the createFeed operation.

object (FeedOptions)

Additional options to control the feed. These vary by feed type.

Responses

Request samples

Content type
application/json
{
  • "feedType": "string",
  • "marketplaceIds": [
    ],
  • "inputFeedDocumentId": "string",
  • "feedOptions": {
    }
}

Response samples

Content type
application/json
{
  • "feedId": "string"
}

getFeed

Returns feed details (including the resultDocumentId, if available) for the feed that you specify.

Usage Plan:

Rate (requests per second) Burst
2.0 15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
feedId
required
string

The identifier for the feed. This identifier is unique only in combination with a seller ID.

Responses

Response samples

Content type
application/json
{
  • "feedId": "string",
  • "feedType": "string",
  • "marketplaceIds": [
    ],
  • "createdTime": "2019-08-24T14:15:22Z",
  • "processingStatus": "CANCELLED",
  • "processingStartTime": "2019-08-24T14:15:22Z",
  • "processingEndTime": "2019-08-24T14:15:22Z",
  • "resultFeedDocumentId": "string"
}

createFeedDocument

Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation.

Usage Plan:

Rate (requests per second) Burst
0.0083 15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request Body schema: application/json
contentType
required
string

The content type of the feed.

Responses

Request samples

Content type
application/json
{
  • "contentType": "string"
}

Response samples

Content type
application/json
{
  • "feedDocumentId": "string",
  • "url": "string"
}

getFeedDocument

Returns the information required for retrieving a feed document's contents.

Usage Plan:

Rate (requests per second) Burst
0.0222 10

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
feedDocumentId
required
string

The identifier of the feed document.

Responses

Response samples

Content type
application/json
{
  • "feedDocumentId": "string",
  • "url": "string",
  • "compressionAlgorithm": "GZIP"
}