getInvoicesExports

Tested

GET

/tax/invoices/2024-06-19/exports

invoices

Last modified:2024-12-04 05:21:59

Maintainer:Sarath S

Returns invoice exports details for exports that match the filters that you specify.

Usage Plan:

Rate (requests per second)	Burst
0.1	20

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.

Request

Query Params

marketplaceId

string

required

The returned exports match the specified marketplace.

Example:

A2Q3Y263D00KWC

dateStart

string <date-time>

optional

The earliest export creation date and time for exports that you want to include in the response. Values are in ISO 8601 date-time format. The default is 30 days ago.

Example:

2024-07-10T00:00:00.000Z

nextToken

string

optional

The response includes nextToken when the number of results exceeds the specified pageSize value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

pageSize

integer

optional

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

Minimum: 1

Maximum: 100

Example:

dateEnd

string <date-time>

optional

The latest export creation date and time for exports that you want to include in the response. Values are in ISO 8601 date-time format. The default value is the time of the request.

Example:

2024-07-10T23:59:59.000Z

status

enum<string>

optional

Return exports matching the status specified.

Allowed values:

REQUESTEDPROCESSINGDONEERROR

Example:

DONE

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/tax/invoices/2024-06-19/exports?marketplaceId=A2Q3Y263D00KWC&dateStart=2024-07-10T00:00:00.000Z&nextToken=&pageSize=1&dateEnd=2024-07-10T23:59:59.000Z&status=DONE'

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.

exports

array[object (Export) {6}]

optional

A list of exports.

<= 100 items

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

nextToken

string

optional

This token is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getInvoices operation and include this token with the previous call parameters.

Example

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

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

createInvoicesExport

getInvoicesExport