getCustomerInvoices

get https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/customerInvoices

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
10	10

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Responses

Response body

object

payload

object

Represents a list of customer invoices, potentially paginated.

pagination

object

The pagination elements required to retrieve the remaining data.

customerInvoices

array of objects

Represents a customer invoice within the CustomerInvoiceList.

customerInvoices

object

purchaseOrderNumber

string

required

The purchase order number for this order.

content

string

required

The Base64encoded customer invoice.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/customerInvoices \
3
     --header 'accept: application/json'


xxxxxxxxxx
20
 
1
{
2
  "payload": {
3
    "pagination": {
4
      "nextToken": "string"
5
    },
6
    "customerInvoices": [
7
      {
8
        "purchaseOrderNumber": "string",
9
        "content": "string"
10
      }
11
    ]
12
  },
13
  "errors": [
14
    {
15
      "code": "string",
16
      "message": "string",
17
      "details": "string"
18
    }
19
  ]
20
}

200Success.

400Request has missing or invalid parameters and cannot be parsed.

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.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500Encountered an unexpected condition which prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.