getInvoicesExport

Returns invoice export details (including the exportDocumentId, if available) for the export that you specify.

Usage Plan:

Rate (requests per second)	Burst
2	15

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

Success.

export

object (Export)

optional

Detailed information about the export.

errorMessage

string

optional

When the export generation fails, this attribute contains a description of the error.

exportId

string

optional

The export identifier.

generateExportFinishedAt

string <date-time>

optional

The date and time when the export generation finished. Vales are in ISO 8601 date-time format.

generateExportStartedAt

string <date-time>

optional

The date and time when the export generation started. Values are in ISO 8601 date-time format.

invoicesDocumentIds

array[string]

optional

The identifier for the export documents. To get the information required to retrieve the export document's contents, pass each ID in the getInvoicesDocument operation.

This list is empty until the status is DONE.

status

enum<string>

optional

The current status of the request.

Allowed values:

REQUESTEDPROCESSINGDONEERROR

Example

{
    "export": {
        "errorMessage": "string",
        "exportId": "string",
        "generateExportFinishedAt": "2019-08-24T14:15:22Z",
        "generateExportStartedAt": "2019-08-24T14:15:22Z",
        "invoicesDocumentIds": [
            "string"
        ],
        "status": "REQUESTED"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses