createReport

Creates a report for the specified input parameters.

Usage Plan:

Rate (requests per second)Burst
0.016715

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.

📘

To test this API, use any of the following sample request bodies. You can either populate the input fields below with values from these samples, or select the Edit JSON body field ({ }) in the request code box on the right and provide a full request payload.

Example #1 - Click to expand
{
"reportType": "GET_AB_INVOICE_PDF",
"marketplaceIds": [
  "A1PA6795UKMFR9"
],
"reportOptions":{
    "invoiceId": "GB1UFB1HAEUI",
    "documentType": "Invoice"
  }
}
Example #2 - Click to expand
{
"reportType": "GET_AB_INVOICE_PDF",
"marketplaceIds": [
  "A1PA6795UKMFR9"
],
"reportOptions":{
    "orderId": "203-9277085-5441169",
    "orderLineItemId": "20710282414442",
    "shipmentId": "D6jrvDy6t"
  }
}
Example #3 - Click to expand
{
  "reportOptions": 
  { 
      "invoiceId":"1111-2222-3333", 
      "documentType": "Credits" 
  }, 
  "reportType": "GET_AB_INVOICE_PDF", 
  "marketplaceIds": ["ATVPDKIKX0DER"] 
} 
Body Params
reportOptions
object

Additional information passed in the request. This varies by report type.

string
required

The type of report used for filtering reports to retrieve.

date-time

The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.

date-time

The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.

marketplaceIds
array of strings
required
length between 1 and 25

A list of marketplace identifiers. The report will contain data for all of the specified marketplaces, unless the report type indicates otherwise.

marketplaceIds*
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json