Get single report schedule

Call this endpoint to retrieve the details of a single report schedule. A schedule tells Walmart what report to generate, how often to run it, and what filters to apply. Use this endpoint when you need to view the next run time, confirm schedule settings, or troubleshoot why a scheduled report did not run.

Note: This page shows an example that retrieves a single schedule by scheduleId. For all fields and report types, refer to the Reports Scheduler API reference.

Endpoint

GET https://marketplace.walmartapis.com/v3/reports/schedules/{scheduleId}

Sample request

This sample request retrieves an existing schedule. It uses the required path parameter scheduleId and the required headers.

Scheduling workflow

1. Capture the scheduleId when you create a schedule.
2. Call GET /v3/reports/schedules/{scheduleId} to retrieve the schedule details.
3. Inspect payload to confirm frequency, interval, and any date or row filters.
4. Use nextScheduledTime to determine when Walmart will generate the next report.

Note: The time in payload.hour is based on UTC. nextScheduledTime shows the next time Walmart plans to generate the report.

curl -X GET "https://marketplace.walmartapis.com/v3/reports/schedules/dea4dca3-0b38-4202-85ed-14923686cce1" \ -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'

import requests schedule_id = "dea4dca3-0b38-4202-85ed-14923686cce1"
url = f"https://marketplace.walmartapis.com/v3/reports/schedules/{schedule_id}" headers = { "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_SVC.NAME": "Walmart Marketplace", "WM_QOS.CORRELATION_ID": "<CORRELATION_ID>", "Accept": "application/json",
} response = requests.get(url, headers=headers)
print("Status code:", response.status_code)
print("Response JSON:", response.json())

Modify your code

• Use a unique WM_QOS.CORRELATION_ID for each request.
• Replace WM_SEC.ACCESS_TOKEN with a valid access token obtained through authentication.
• Replace {scheduleId} with the schedule ID you want to retrieve.
• Expect schedule timing fields to use UTC.

Sample response

The example below shows a yearly schedule (frequency = YEARLY) that repeats every 2 years and includes row filters.

{ "scheduleId": "dea4dca3-0b38-4202-85ed-14923686cce1", "requestSubmissionDate": "2025-04-29T17:36:51Z", "reportType": "ITEM", "reportVersion": "v4", "reportSummary": "reportSummary", "scheduleStartDate": "2025-04-30T18:30:00Z", "nextScheduledTime": "2027-06-27T20:30:00Z", "payload": { "dayOfMonth": 28, "monthOfYear": 6, "hour": 2, "frequency": "YEARLY", "repeatsEvery": 2, "filters": { "rowFilters": [ { "type": "rangeFilter", "columnName": "Offer Start Date", "from": "2022-01-01", "to": "2022-01-20" }, { "type": "rangeFilter", "columnName": "Price", "from": "100.00", "to": "500.00" }, { "type": "enumFilter", "values": [ "PUBLISHED" ], "columnName": "Publish Status" } ] } }, "requestModifiedTime": "2025-04-29T17:36:51Z"
}

Result

If the request is successful, the API returns HTTP 200 OK with a JSON body that includes:

• The schedule definition (payload)
• The next time Walmart will generate the report (nextScheduledTime)
• The report type and version (reportType, reportVersion)
• Submission and last modified timestamps (requestSubmissionDate, requestModifiedTime)

Keep the scheduleId for later calls to update or delete this schedule.