getInvoices

get

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

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

Query Params

transactionIdentifierName

string

The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the transactionIdentifierId field.Use the getInvoicesAttributes operation to check transactionIdentifierName options.

pageSize

integer

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

Minimum: 1

Maximum: 200

dateEnd

date-time

The latest invoice creation date for invoices that you want to include in the response. Dates are in ISO 8601 date-time format. The default is the current date-time.

marketplaceId

string

required

The response includes only the invoices that match the specified marketplace.

transactionType

string

The marketplace-specific classification of the transaction type for which the invoice was created. Use the getInvoicesAttributes operation to check transactionType options.

transactionIdentifierId

string

The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the transactionIdentifierName field.

dateStart

date-time

The earliest invoice creation date for invoices that you want to include in the response. Dates are in ISO 8601 date-time format. The default is 24 hours prior to the time of the request.

series

string

Return invoices with the specified series number.

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.

sortOrder

string

enum

Sort the invoices in the response in ascending or descending order.

Allowed:

invoiceType

string

The marketplace-specific classification of the invoice type. Use the getInvoicesAttributes operation to check invoiceType options.

statuses

array of strings

length ≥ 1

A list of statuses that you can use to filter invoices. Use the getInvoicesAttributes operation to check invoice status options.

Min count: 1

statuses

externalInvoiceId

string

Return invoices that match this external ID. This is typically the Government Invoice ID.

sortBy

string

enum

The attribute by which you want to sort the invoices in the response.

Allowed:

Responses

Language

Loading…

Response

Choose an example:

application/json

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.