Reports Scheduler API overview
Use the Report Scheduler API to automatically create Walmart reports at specific times. You can set when and how often reports run. The API lets you create, view, update, and delete report schedules. You can also apply filters to include only the data you need.
Note: The number of schedules you can create is subject to limits based on the selected frequency.
How it works
A typical flow for managing report scheduling involves creating schedules, viewing current schedules, and updating or deleting schedules as needed. The table below outlines these key scenarios:
| Scenario | Action | Endpoint |
|---|---|---|
| Create a new report schedule | Create a scheduled report | POST /v3/reports/schedules |
| View all existing schedules | Retrieve all schedules | GET /v3/reports/schedules |
| View details of a specific schedule | Retrieve a single schedule | GET /v3/reports/schedules/{schedule-id} |
| Modify an existing schedule | Update a schedule | PUT /v3/reports/schedules/{schedule-id} |
| Remove an existing schedule | Delete a schedule | DELETE /v3/reports/schedules/{schedule-id} |
Reference guide
This guide explains how to use the Marketplace Report Scheduler API, providing practical examples and step-by-step instructions for integrating report scheduling into your solution.
For full technical details, including endpoints, parameters, and brief descriptions, refer to the Report Scheduler API reference guide.
Prerequisites
Complete the following before integrating the Report Scheduler API:
- Complete the steps in the Getting Started guide:
- If you are a seller, refer to the Marketplace Getting Started Guide for Sellers.
- If you are an approved Solution Provider, refer to the Marketplace Getting Started Guide for Solution Providers.
- OAuth 2.0 authentication is required to access Walmart Marketplace APIs. Obtain credentials and tokens before making API requests. For details, refer to OAuth 2.0 authorization.
Commonly used terms
| Term | Description |
|---|---|
| Report Type | Specifies the type of report, such as ITEM, INVENTORY, or SALES. |
| Schedule Frequency | The frequency at which reports are automatically generated (hourly, daily, weekly, monthly, yearly). |
| Schedule ID | A unique identifier generated when creating a new report schedule, used for subsequent retrieval, updates, or deletions. |
| Filters | Criteria used to refine the data included in a report, such as date ranges or status types. |
Market availability
The Report Scheduler API is available for sellers listing on Walmart marketplaces in Canada, Chile, Mexico, and the U.S.
Next steps
- Review detailed instructions on creating a report schedule.
- Learn how to retrieve existing schedules.
- Learn how to update existing schedules.
- Learn how to delete a schedule.
Updated 3 days ago