Choose a reports API
This page helps you select the right On Request report for your job. Start with the question you need to answer, pick the report that contains the fields you need, then decide how often to run it and which filters to apply.
How to choose
- Identify the outcome. Do you need a catalog snapshot, operational quality metrics, or performance insights.
- Confirm the data fields. Open the report guide to check the column list and definitions.
- Pick the cadence. Decide if this is a one‑time request or a recurring schedule.
- Plan filters. Use row filters, exclude columns, and date ranges to reduce size and speed up processing.
Tip: Some reports support filters. Others return a fixed schema. Each report guide states what is supported and provides examples.
Quick decision table
| Use case | Recommended report | Typical cadence | Supports filters | Common filters | Notes |
|---|---|---|---|---|---|
| Catalog status and attributes | Item report | Daily or as needed | Yes | Lifecycle status, category, exclude columns | Large catalogs benefit from exclude‑column filters. |
| Inventory position by SKU | Inventory report | Daily | Varies | Ship node, SKU list | Use when reconciling counts across nodes. |
| Assortment opportunities | Assortment recommendations | Weekly | Yes | Category, brand, exclude columns | Great for growth planning. |
| Order cancellations monitoring | Cancellation report | Daily | Yes | Date range, reason codes | Use with alerts for spikes. |
| Delivery defects tracking | Delivery defect report | Weekly | Varies | Date range | Helpful for carrier and SLA reviews. |
| Buy Box positioning | Buy Box insights report | Daily or weekly | Varies | Item or SKU list | Pairs well with pricing workflows. |
| Item performance analytics | Item performance report | Weekly or monthly | Yes (date range) | Start and end dates | Defaults to past 30 days when no date range is set. |
| Promotions audit | Promotions report | Daily | Varies | Promotion ID, date range | Use for compliance and effectiveness checks. |
| Cost‑per‑action (CPA) review | CPA report | Monthly | Varies | Date range | Financial reconciliation scenarios. |
| Shipping configuration audit | Shipping configuration report | As needed | Varies | Program, ship node | Run after policy changes. |
| Shipping program eligibility and status | Shipping program report | Weekly | Varies | Program name | Audit against participation goals. |
| Lag time hygiene | Lag time report | Weekly | Varies | Ship node, category | Run after catalog or node updates. |
| Return overrides review | Return item overrides report | Monthly | Varies | Reason code, date range | Use for policy governance. |
| ACES coverage and fitment gaps | ACES gap reports | As needed | Varies | Category, brand | Automotive catalog focus. |
Filter support varies by report. The report guide states which filter types are available and shows payload shapes.
Choosing cadence
- Run a one‑time request for audits, large migrations, and catalog checks.
- Create a schedule for operational monitoring, alerts, and period‑over‑period analysis.
- Pin a report version when you automate schedules to keep schema stable.
Examples
One‑time Item report
curl -X POST \ 'https://marketplace.walmartapis.com/v3/reports/reportRequests?reportType=ITEM&reportVersion=v6' \ -H 'WM_SEC.ACCESS_TOKEN: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....' \ -H 'WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6' \ -H 'WM_SVC.NAME: Walmart Marketplace' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "filters": { "rowFilters": [ {"column": "lifecycleStatus", "operator": "IN", "values": ["ACTIVE"]} ], "excludeColumns": ["longDescription", "imageUrl"] } }'Scheduled Item performance report
curl -X POST \ 'https://marketplace.walmartapis.com/v3/reports/schedules' \ -H 'WM_SEC.ACCESS_TOKEN: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....' \ -H 'WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6' \ -H 'WM_SVC.NAME: Walmart Marketplace' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "reportType": "ITEM_PERFORMANCE", "reportVersion": "v1", "schedule": {"cadence": "WEEKLY", "dayOfWeek": "MONDAY"}, "filters": {"dateRange": {"from": "2025-08-01", "to": "2025-08-31"}} }'Next steps
- Learn how to request and download a report.
- Learn how to use report filters.
- Set up schedules and status notifications for automation.
Updated about 1 month ago