createInvoicesExport - Amazon SP API

Creates an invoice export request.

Usage Plan:

Rate (requests per second)	Burst
0.167	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

Body Params application/json

The information required to create the export request.

dateEnd

string <date>

optional

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.

dateStart

string <date>

optional

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.

externalInvoiceId

string

optional

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

fileFormat

enum<string>

optional

Supported invoice file extensions.

Allowed value:

XML

invoiceType

string

optional

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

marketplaceId

string

required

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

series

string

optional

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

statuses

array[string]

optional

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

Min count: 1

>= 1 items

transactionIdentifier

object (TransactionIdentifier)

optional

The identifier for a transaction.

name

string

optional

The transaction identifier name. Use the getInvoicesAttributes operation to check transactionIdentifierName options.

string

optional

The transaction identifier.

transactionType

string

optional

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

Example

{
    "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"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

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.

exportId

string

optional

The export identifier.

Example

{
    "exportId": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable