getInvoicesDocument

Tested

GET

/tax/invoices/2024-06-19/documents/{invoicesDocumentId}

invoices

Last modified:2024-12-03 11:27:53

Maintainer:Sarath S

Returns the invoice document's ID and URL. Use the URL to download the ZIP file, which contains the invoices from the corresponding createInvoicesExport request.

Usage Plan:

Rate (requests per second)	Burst
0.0167	1

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

Path Params

invoicesDocumentId

string

required

The export document identifier.

Example:

18c598f5-75db-4c1a-bd3e-4c64b36781c5

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/documents/18c598f5-75db-4c1a-bd3e-4c64b36781c5'

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.

invoicesDocument

object (InvoicesDocument)

optional

An object that contains the documentId and an S3 pre-signed URL that you can use to download the specified file.

invoicesDocumentId

string

optional

The identifier of the export document.

invoicesDocumentUrl

string

optional

A pre-signed URL that you can use to download the invoices document in zip format. This URL expires after 30 seconds.

Example

{
    "invoicesDocument": {
        "invoicesDocumentId": "string",
        "invoicesDocumentUrl": "string"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

getInvoicesAttributes

createInvoicesExport