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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

reportType

string

enum

required

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

reportVersion

string

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

Body Params

frequency

string

enum

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

Allowed:

repeatsEvery

number

Defines the interval at which the report repeats based on the selected frequency.

hour

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.

dayOfMonth

number

Specifies the day of the month on which the schedule will be triggered.

dayOfWeek

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.

monthOfYear

number

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

scheduleStartDate

string

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

filters

object

Headers

WM_SVC.NAME

string

required

Specifies the name of the Walmart service being called.

WM_QOS.CORRELATION_ID

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

WM_SEC.ACCESS_TOKEN

string

required

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

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response