Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Invoices v2024-06-19

createInvoicesExport

Creates an invoice export request.

Usage Plan:

Rate (requests per second)Burst
0.1671

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.

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

Request body

dateEndstring date

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 time of the request.

dateStartstring date

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.

externalInvoiceIdstring

The external ID of the invoices you want included in the response.

fileFormat'XML'

Supported invoice file extensions.

invoiceTypestring

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

marketplaceIdstring required

The ID of the marketplace from which you want the invoices.

seriesstring

The series number of the invoices you want included in the response.

statusesstring[]

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

Min count: 1

transactionTypestring

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

Example request

{
  "dateEnd": "2024-07-30T23:59:59",
  "dateStart": "2024-07-01T00:00:00",
  "externalInvoiceId": "1283743",
  "fileFormat": "XML",
  "invoiceType": "SYMBOLIC_RETURN",
  "marketplaceId": "A2Q3Y263D00KWC",
  "series": "32",
  "statuses": [
    "AUTHORIZED"
  ],
  "transactionIdentifier": {
    "name": "BUSINESS_TRANSACTION_ID",
    "id": "94cd4e1a-5cc5-486d-b592-045a95a168e1"
  },
  "transactionType": "CUSTOMER_SALES"
}

Response

Success.

exportIdstring

The export identifier.