logo

Reports

The Reports API allows you to generate new reports and download them as CSV files. Here is a complete list of available reports

Report Code Report Name and Link startDate/endDate parameters used
Claims-Claims_Submitted Claims - Claims Submitted YES
Inbounds-Packages Inbounds - Packages Report YES
Inbounds-Shipments Inbounds - Shipments Report YES
Inbounds-Shipping_Plan_Reconciliation Inbounds - Inventory / Shipping Plan Reconciliation Report NO
Inbounds-Inventory_Reconciliation Inbounds - Inventory / Shipping Plan Reconciliation Report NO
Inventory-Levels_Today Inventory - Levels Today Report NO
Inventory-Units_In_Long_Term_Storage Inventory - Units in Long Term Storage Report NO
Orders-All_Orders Orders - Orders Report YES
Orders-Shipments Orders - Shipments Report YES
Products-All_SKUs_With_Alias_Counts Products - All SKUs With Alias Counts Report NO
Products-Available_SKUs_With_Alias_Counts Products - Available SKUs With Alias Counts Report NO
Products-Available_SKUs_With_No_Aliases Products - Available SKUs With No Aliases Report NO
Products-SKUs_With_Linked_Aliases Products - SKUs with Linked Aliases Report NO
Returns-All_Returns Returns - All Returns YES
Returns-All_SKUs Returns - All Return Items by MSKU YES

GetReportStatus

Returns a report or report status identified by the reportReference id

SecurityBEARER
Request
path Parameters
reportReference
required
string
Responses
200

Report status and url

Response Schema: application/json
status
required
string (reports_ReportStatus)
  1. PENDING: The report is still being generated
  2. SUCCESS: Report has been generated, use the url field to download the report as a CSV file
  3. ERROR: There was an issue while creating this report, see errorMessage field for details
Enum: "PENDING" "SUCCESS" "ERROR"
urlExpiration
string <date-time>

date-time of download url expiration in GMT.

url
string

download report as a csv using this URL. Note that this URL will expire at the urlExpiration time.

errorMessage
string

If status is ERROR, a description of the error.

401

Unauthorized

404

A report with the given report reference was not found

get/logistics/api/2023-10/reports/{reportReference}
Response samples
application/json
{
  • "status": "PENDING",
  • "urlExpiration": "2019-08-24T14:15:22Z",
  • "url": "string",
  • "errorMessage": "string"
}

GenerateReport

Creates a new report that can be downloaded in CSV format

SecurityBEARER
Request
Request Body schema: application/json
required
reportType
required
string (reports_SellerReportType)
Enum: "Billing-Credits_Balance" "Claims-Claims_Submitted" "Pricing-Fulfillment_Fees" "Inbounds-Packages" "Inbounds-Inventory_Reconciliation" "Inbounds-Monthly_Reconciliation" "Inbounds-Shipping_Plan_Reconciliation" "Incident-Impact_Report" "Inventory-Units_In_Long_Term_Storage" "Inventory-Ecommerce_Monthly_Reconciliation" "Inventory-Ecommerce_Transaction_History" "Inventory-Levels_Today" "Inventory-Lot_Tracking_FEFO_All_Products" "Inventory-Lot_Tracking_FEFO_Single_Product" "Orders-Shipments" "Orders-All_Orders" "Parcel-All_Parcels" "Parcel_All_Parcels_Tracking_Details" "Products-All_SKUs_With_Alias_Counts" "Products-Available_SKUs_With_Alias_Counts" "Products-Available_SKUs_With_No_Aliases" "Products-SKUs_With_Linked_Aliases" "Reserve-Storage-Orders_And_Transfers" "Reserve-Storage-Pallet-Inventory" "Returns-All_SKUs" "Returns-All_Returns"
startDate
string <date-time>

The start date for the data in the report.

endDate
string <date-time>

The end date for the data in the report.

Responses
200

Report is being created

Response Schema: application/json
reportReference
required
string

A reference for polling the status of the report.

400

Bad Request

401

Unauthorized

422

Unprocessable Entity

post/logistics/api/2023-10/reports
Request samples
application/json
{
  • "reportType": "Billing-Credits_Balance",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "reportReference": "string"
}
➔ Next to Returns