Reports Scheduler
Using the reports scheduler, you can configure Walmart to generate reports automatically. Specify how often each report should run, add filters, and download the output from your destination URL. Walmart offers flexible scheduling options, but each report type has limits on how many active schedules you can create.
How do I schedule a report?
- Choose the report type you want to schedule.
- Set the frequency (for instance, once per day or every hour).
- (Optional ) Set a future start date for the schedule.
- Create the schedule with
POST /v3/report‑schedulerand provide the report type and frequency. - Download the report from your destination URL after Walmart generates it.
Note: The
frequencyandtimeparameters indicate when Walmart starts generating the report, not when the file becomes available for download.
How do schedules work?
Each schedule requires:
frequency: How often the report runs.repeatsEvery: An integer that defines the interval (for example, every 2 hours).
Additional parameters depend on the selected frequency.
Frequency options
| Frequency | Required additional parameters |
|---|---|
HOURLY | None |
DAILY | hour |
WEEKLY | hour, dayOfWeek |
MONTHLY | hour, dayOfMonth |
YEARLY | hour, dayOfMonth, monthOfYear |
Parameter reference
| Parameter | Type | Allowed values / notes |
|---|---|---|
hour | Integer | 0‑23 (UTC). 0 = 12:00 AM; 23 = 11:00 PM. |
dayOfWeek | Integer | 0‑6, where 0 = Monday and 6 = Sunday. |
dayOfMonth | Integer | 1‑31. If the value exceeds the number of days in the month, the report runs on the last day. |
monthOfYear | Integer | 1‑12, where 1 = January and 12 = December. |
Examples
| Example parameters | Result |
|---|---|
frequency=HOURLY, repeatsEvery=2 | Runs every other hour. |
frequency=DAILY, repeatsEvery=1, hour=9 | Runs daily at 09:00 UTC. |
frequency=WEEKLY, repeatsEvery=1, hour=18, dayOfWeek=2 | Runs every Wednesday at 18:00 UTC. |
frequency=MONTHLY, repeatsEvery=3, hour=11, dayOfMonth=1 | Runs on the first day of every third month at 11:00 UTC. |
frequency=YEARLY, repeatsEvery=1, hour=20, dayOfMonth=1, monthOfYear=1 | Runs every 1 January at 20:00 UTC |
How many schedules can I create?
Each report type supports one active frequency. Within that frequency, you can create up to the following number of schedules:
| Frequency | Maximum schedules |
|---|---|
HOURLY | 1 |
DAILY | 3 |
WEEKLY | 5 |
MONTHLY | 5 |
YEARLY | 1 |
Can I use filters with scheduled reports?
Yes. Scheduled reports support the following filters:
rowFilterexcludeColumnsdataStartTimedataEndTime
Use these filters to limit the scope and content of each generated report.
Updated about 12 hours ago