ReportRequest
Version 2024-11-01
Important
The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.
Overview
Represents a report request.
Fields
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
lastUpdatedTime (String required) | The time the request status was last updated in ISO-8601 UTC format. | ||||||||
reportType (String required) | The report type. The value is constrained to one of the following | value | description
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | USER_EVENTS | The User Events report contains users engagement data (e.g., a customer browsing a detail page, purchasing items) such as event name, event ID, etc. for events like Page Loads, Prime Badge views, checkout started, checkout completed, etc. | | ORDER_FEES | The Order Fees report contains detailed fee-level data for each order, including Prime Service fees, Fulfillment fees, and Payment Processing fees. It tracks fees charged throughout the order lifecycle, providing key information such as order IDs, payment IDs, fee amounts, tax on fees, discounts, and credits. | | ORDER_FULFILLMENT | The Order Fulfillment report contains detailed lineItem-level data for each order. It tracks package fulfillment and shipment status throughout the order lifecycle, providing key information such as order IDs, product IDs, shipping address, tracking number, etc. | | ORDER_LINEITEM | The Order LineItem report contains detailed lineItem-level data for each order. It tracks order lineItem status throughout the order lifecycle, providing key information such as order IDs, product IDs, product price, product variance, lineItem subtotal amount, tax, promotions and lineItem status. | | ||||||||
requestTime (String required) | The time the request was created in ISO-8601 UTC format. | ||||||||
status (String required) | The current processing status of the report. The value is constrained to one of the following:
| ||||||||
taskId (ID required) | The task ID of the report. |
Updated about 21 hours ago