API Reference
My Account
  1. On Request Report Management
  2. Report Scheduler

Create Report Schedule

post
https://marketplace.walmartapis.com/v3/reports/schedules

This API allows you to create a new report schedule based on the necessary parameters specified in the request body.

Market availability: US only

Query Params
string
enum
required

Specifies the type of report to be generated. Example: ITEM for Item Report.

Market availability: US only

string

Specifies the version of the report. For example, v1.

Market availability: US only

Body Params
string
enum
required

Specifies the frequency at which the report should be generated. For example, if set to YEARLY, the report will be generated once every year.

Market availability: US only

Allowed:
number

Defines the interval at which the report repeats based on the selected frequency. Required for HOURLY, DAILY, WEEKLY, MONTHLY, and YEARLY frequencies.

Market availability: US only

number

Specifies the hour of the day at which the schedule will be triggered. Allowed values are from 0 to 23, where 0 corresponds to 12:00 AM UTC and 23 corresponds to 11:00 PM UTC. The hour selection is based on the UTC timezone. Required for DAILY, WEEKLY, MONTHLY, and YEARLY frequencies.

Market availability: US only

number

Specifies the day of the month on which the schedule will be triggered. Required for MONTHLY and YEARLY frequencies.

Market availability: US only

number

Specifies the day of the week on which the schedule will be triggered. Allowed values are from 0 to 6, where 0 represents Monday and 6 represents Sunday. Required for WEEKLY frequency.

Market availability: US only

number

Specifies the month in which the schedule will be triggered. Allowed values are from 1 to 12. Required for YEARLY frequency.

Market availability: US only

date

Specifies the start date for the schedule. The date should be in a valid date format (Example: YYYY-MM-DD).

Market availability: US only

filters
object
Headers
string

Idempotency key to prevent duplicate operations on retry.

string
required

Specifies the name of the Walmart service being called.

Market availability: US only

string
required

A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID

Market availability: US only

string
required

Access token obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs.

Market availability: US only

string
enum
required

The target market of the API call.

Market availability: US only

Allowed:
string
enum
required

The version of the global API used.

Market availability: US only

Allowed:
Responses

Updated about 7 hours ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 7 hours ago

Did this page help you?