Guides
My Account

Request and download a report

Learn how to generate and retrieve an on‑request report using the Walmart Marketplace Reports API.

Workflow

The report flow has three stages:

  1. Create a report request – submit the type of report and optional filters.
  2. Track the request – poll for status until the report is ready.
  3. Download the report – fetch the file or receive a webhook notification when it’s complete.

Step 1: Create a report request

Use the POST /v3/reports/requests endpoint to create a new report request.

Request

POST https://marketplace.walmartapis.com/v3/reports/requests
Authorization: Bearer <access_token>
WM_QOS.CORRELATION_ID: <guid>
WM_SVC.NAME: Walmart Marketplace
Content-Type: application/json { "reportType": "ITEM_PERFORMANCE", "filters": { "sku": ["SKU123", "SKU456"], "startDate": "2025-08-01", "endDate": "2025-08-31" }, "format": "CSV"
}

Response (example)

{ "requestId": "rpt-78910", "status": "IN_PROGRESS", "createdAt": "2025-09-01T10:15:00Z"
}

Step 2: Track report status

Check the status of a report with:

GET https://marketplace.walmartapis.com/v3/reports/requests/{requestId}
Authorization: Bearer <access_token>
WM_QOS.CORRELATION_ID: <guid>
WM_SVC.NAME: Walmart Marketplace

Response (example)

{ "requestId": "rpt-78910", "status": "COMPLETED", "downloadUrl": "https://marketplace.walmartapis.com/download/rpt-78910/file.csv", "expiresAt": "2025-09-30T10:15:00Z"
}

Status values may include:

  • IN_PROGRESS
  • COMPLETED
  • FAILED

Step 3: Download the report

When status is COMPLETED, use the downloadUrl to fetch the file. The link remains valid until the expiresAt date.

GET https://marketplace.walmartapis.com/download/rpt-78910/file.csv
Authorization: Bearer <access_token>

The file may be returned as CSV, XLSX, or compressed ZIP depending on the type and size.

Optional: webhook notifications

Instead of polling, you can subscribe to report status notifications. When a report finishes, Walmart sends an event payload such as:

{ "event": "report.completed", "requestId": "rpt-78910", "reportType": "ITEM_PERFORMANCE", "status": "COMPLETED", "downloadUrl": "https://marketplace.walmartapis.com/download/rpt-78910/file.csv"
}

Retries follow exponential backoff. Use the requestId to correlate events with your system.

Next Steps

Updated 3 days ago