getInvoicesExports

get https://sellingpartnerapi-na.amazon.com/tax/invoices/2024-06-19/exports

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.

Query Params

marketplaceId

string

required

The returned exports match the specified marketplace.

dateStart

date-time

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.

nextToken

string

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

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

Minimum: 1

Maximum: 100

dateEnd

date-time

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.

status

string

Return exports matching the status specified.

Responses

Response body

object

exports

array of objects

length ≤ 100

A list of exports.

exports

object

errorMessage

string

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

exportId

string

The export identifier.

generateExportFinishedAt

date-time

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

generateExportStartedAt

date-time

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

invoicesDocumentIds

array of strings

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.

invoicesDocumentIds

status

string

The current status of the request.

REQUESTED PROCESSING DONE ERROR

Show Details

REQUESTED	The export request was created, but has not yet started.
PROCESSING	The export request is being processed.
DONE	The export request has finished successfully. Use the document IDs to download the output documents.
ERROR	The export request resulted in an error. Refer to the `errorMessage` attribute for more information.

nextToken

string

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.

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/tax/invoices/2024-06-19/exports \
3
     --header 'accept: application/json'


xxxxxxxxxx
15
 
1
{
2
  "exports": [
3
    {
4
      "errorMessage": "string",
5
      "exportId": "string",
6
      "generateExportFinishedAt": "2025-04-01T17:18:47.159Z",
7
      "generateExportStartedAt": "2025-04-01T17:18:47.159Z",
8
      "invoicesDocumentIds": [
9
        "string"
10
      ],
11
      "status": "REQUESTED"
12
    }
13
  ],
14
  "nextToken": "string"
15
}

200Success.

400Request has missing or invalid parameters and cannot be parsed.

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

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.