HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

getCustomerInvoices

Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days.

Usage Plan:

Rate (requests per second)Burst
1010

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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Query Params
string

The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.

integer
1 to 100

The limit to the number of records returned

date-time
required

Orders that became available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

date-time
required

Orders that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

string

Sort ASC or DESC by order creation date.

string

Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.

Responses

Response body
object
pagination
object

The pagination elements required to retrieve the remaining data.

string

Pagination occurs when a request produces a response that exceeds the pageSize. This means that the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. There is no nextToken in the pagination object on the last page.

customerInvoices
array of objects

Represents a customer invoice within the CustomerInvoiceList.

customerInvoices
object
string
required

The purchase order number for this order.

string
required

The Base64 customer invoice.

Headers
object
string

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

string

Unique request reference identifier.

Language