Selling Partner API SDK for JavaScript
    Preparing search index...

    Interface ReportDocument

    Information required for the report document.

    interface ReportDocument {
        compressionAlgorithm?: "GZIP";
        reportDocumentId: string;
        url: string;
    }
    Index

    Properties

    compressionAlgorithm? reportDocumentId url

    Properties

    compressionAlgorithm?: "GZIP"

    If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to Step 2. Download the report in the use case guide, where sample code is provided.

    reportDocumentId: string

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

    url: string

    A presigned URL for the report document. If compressionAlgorithm is not returned, you can download the report directly from this URL. This URL expires after 5 minutes.

    Settings

    Member Visibility

    On This Page

    Properties