Feeds API v2020-09-04 reference

Upload data to Amazon to manage a selling business.

Overview

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

Version information

Version : 2020-09-04

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getFeeds
createFeed
getFeed
cancelFeed
createFeedDocument
getFeedDocument

Paths

GET /feeds/2020-09-04/feeds

Operation: getFeeds

Description

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

Usage Plan:

Rate (requests per second)Burst
0.022210

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

Parameters

TypeNameDescriptionSchemaDefault
QueryfeedTypes
optional
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.
Min count : 1
Max count : 10
< string > array-
QuerymarketplaceIds
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
Max count : 10
< string > array-
QuerypageSize
optional
The maximum number of feeds to return in a single call.
Minimum : 1
Maximum : 100
integer10
QueryprocessingStatuses
optional
A list of processing statuses used to filter feeds.
Min count : 1
< enum (ProcessingStatuses) > array-
QuerycreatedSince
optional
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.string (date-time)-
QuerycreatedUntil
optional
The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.string (date-time)-
QuerynextToken
optional
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.string-

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedsResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedsResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFeedsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedsResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

POST /feeds/2020-09-04/feeds

Operation: createFeed

Description

Creates a feed. Encrypt and upload the contents of the feed document before calling this operation.

Usage Plan:

Rate (requests per second)Burst
0.008315

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

Parameters

TypeNameSchema
Bodybody
required
CreateFeedSpecification

Responses

HTTP CodeDescriptionSchema
202Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateFeedResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /feeds/2020-09-04/feeds/{feedId}

Operation: getFeed

Description

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

Usage Plan:

Rate (requests per second)Burst
2.015

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

Parameters

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

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFeedResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

DELETE /feeds/2020-09-04/feeds/{feedId}

Operation: cancelFeed

Description

Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations.

Usage Plan:

Rate (requests per second)Burst
0.022210

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

Parameters

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

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CancelFeedResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CancelFeedResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CancelFeedResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference ID.
CancelFeedResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CancelFeedResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelFeedResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CancelFeedResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CancelFeedResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CancelFeedResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

POST /feeds/2020-09-04/documents

Operation: createFeedDocument

Description

Creates a feed document for the feed type that you specify. This operation returns encryption details for encrypting the contents of the document, as well as a presigned URL for uploading the encrypted 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.008315

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

Parameters

TypeNameSchema
Bodybody
required
CreateFeedDocumentSpecification

Responses

HTTP CodeDescriptionSchema
201Successfully created a feed document that is ready to receive contents.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedDocumentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedDocumentResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedDocumentResponse
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedDocumentResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedDocumentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedDocumentResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedDocumentResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
CreateFeedDocumentResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

GET /feeds/2020-09-04/documents/{feedDocumentId}

Operation: getFeedDocument

Description

Returns the information required for retrieving a feed document's contents. This includes a presigned URL for the feed document as well as the information required to decrypt the document's contents.

Usage Plan:

Rate (requests per second)Burst
0.022210

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

Parameters

TypeNameDescriptionSchema
PathfeedDocumentId
required
The identifier of the feed document.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedDocumentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedDocumentResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedDocumentResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedDocumentResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedDocumentResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetFeedDocumentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedDocumentResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedDocumentResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetFeedDocumentResponse

For additional error status codes, descriptions and schemas, see Error responses and schemas.

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP CodeDescriptionSchema
413The request size exceeded the maximum accepted size.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference ID.
CreateFeedDocumentResponse

Definitions

Error

An error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.string
message
required
A message that describes the error condition in a human-readable form.string
details
optional
Additional details that can help the caller understand or fix the issue.string

ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

CancelFeedResponse

Response schema.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateFeedResult

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

Feed

NameDescriptionSchema
feedId
required
The identifier for the feed. This identifier is unique only in combination with a seller ID.string
feedType
required
The feed type.string
marketplaceIds
optional
A list of identifiers for the marketplaces that the feed is applied to.< string > array
createdTime
required
The date and time when the feed was created, in ISO 8601 date time format.string (date-time)
processingStatus
required
The processing status of the feed.enum (ProcessingStatus)
processingStartTime
optional
The date and time when feed processing started, in ISO 8601 date time format.string (date-time)
processingEndTime
optional
The date and time when feed processing completed, in ISO 8601 date time format.string (date-time)
resultFeedDocumentId
optional
The identifier for the feed document. This identifier is unique only in combination with a seller ID.string

FeedList

Type : < Feed > array

GetFeedsResponse

Response schema.

NameDescriptionSchema
payload
optional
-FeedList
nextToken
optional
Returned when the number of results exceeds pageSize. To get the next page of results, call the getFeeds operation with this token as the only parameter.string
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

GetFeedResponse

Response schema.

NameDescriptionSchema
payload
optional
-Feed
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

FeedDocumentEncryptionDetails

Encryption details for required client-side encryption and decryption of document contents.

NameDescriptionSchema
standard
required
The encryption standard required to encrypt or decrypt the document contents.enum (Standard)
initializationVector
required
The vector to encrypt or decrypt the document contents using Cipher Block Chaining (CBC).string
key
required
The encryption key used to encrypt or decrypt the document contents.string

FeedDocument

NameDescriptionSchema
feedDocumentId
required
The identifier for the feed document. This identifier is unique only in combination with a seller ID.string
url
required
A presigned URL for the feed document. This URL expires after 5 minutes.string
encryptionDetails
required
Encryption details for required client-side encryption and decryption of document contents.FeedDocumentEncryptionDetails
compressionAlgorithm
optional
If present, the feed document contents are compressed using the indicated algorithm.enum (CompressionAlgorithm)

GetFeedDocumentResponse

Response schema.

NameDescriptionSchema
payload
optional
-FeedDocument
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateFeedResponse

Response schema.

NameDescriptionSchema
payload
optional
-CreateFeedResult
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

FeedOptions

Additional options to control the feed. For feeds that use the feedOptions parameter, you can find the parameter values in the feed description in Feed Type Values.

Type : < string, string > map

CreateFeedSpecification

NameDescriptionSchema
feedType
required
The feed type.string
marketplaceIds
required
A list of identifiers for marketplaces that you want the feed to be applied to.< string > array
inputFeedDocumentId
required
The document identifier returned by the createFeedDocument operation. Encrypt and upload the feed document contents before calling the createFeed operation.string
feedOptions
optional
Additional options to control the feed. For feeds that use the feedOptions parameter, you can find the parameter values in the feed description in feedType values.FeedOptions

CreateFeedDocumentSpecification

NameDescriptionSchema
contentType
required
The content type of the feed.string

CreateFeedDocumentResponse

The response for the createFeedDocument operation.

NameDescriptionSchema
payload
optional
Information required to encrypt and upload a feed document's contents.CreateFeedDocumentResult
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateFeedDocumentResult

Information required to encrypt and upload a feed document's contents.

NameDescriptionSchema
feedDocumentId
required
The identifier of the feed document.string
url
required
The presigned URL for uploading the feed contents. This URL expires after 5 minutes.string
encryptionDetails
required
Encryption details for required client-side encryption and decryption of document contents.FeedDocumentEncryptionDetails

ProcessingStatuses

Type : enum

ValueDescription
CANCELLEDThe feed was cancelled before it started processing.
DONEThe feed has completed processing. Examine the contents of the result document to determine if there were any errors during processing.
FATALThe feed was aborted due to a fatal error. Some, none or all of the operations within the feed may have completed successfully.
IN_PROGRESSThe feed is being processed.
IN_QUEUEThe feed has not yet started processing. It may be waiting for another IN_PROGRESS feed.

Standard

The encryption standard required to encrypt or decrypt the document contents.

Type : enum

ValueDescription
AESThe Advanced Encryption Standard (AES).

ProcessingStatus

The processing status of the feed.

Type : enum

ValueDescription
CANCELLEDThe feed was cancelled before it started processing.
DONEThe feed has completed processing. Examine the contents of the result document to determine if there were any errors during processing.
FATALThe feed was aborted due to a fatal error. Some, none, or all of the operations within the feed may have completed successfully.
IN_PROGRESSThe feed is being processed.
IN_QUEUEThe feed has not yet started processing. It may be waiting for another IN_PROGRESS feed.

CompressionAlgorithm

If present, the feed document contents are compressed using the indicated algorithm.

Type : enum

ValueDescription
GZIPThe gzip compression algorithm.