Create report request

post

https://marketplace.walmartapis.com/v3/reports/reportRequests

Creates a new request for report by specifying the reportType and reportVersion.

Market availability: Global

Max reporting window: For ITEM_PERFORMANCE v3, the date range between dataStartTime and dataEndTime must not exceed 2 years (730 days). Exceeding this limit will return a 400 error.

Row limit: There is no limit on the number of rows returned in the report.

Query Params

reportType

string

enum

required

Type of report for which the request is created. Example, ITEM for Item Report.

Market availability:

ITEM: Global
INVENTORY: Global
LAGTIME: US|CA|MX
Other Reports: US only

reportVersion

string

required

Version of report for which the request is created.

Market availability: Global

ReportType	Market Availabilty	Version Supported
ITEM	Global	v1 (v3 to v6 : US only)
INVENTORY	Global	v1
LAGTIME	US,CA,MX	v1
DELIVERY_DEFECT	US only	v1
ITEM_PERFORMANCE	US only	v1 to v3
PROMO	US only	v1
RETURN_OVERRIDES	US only	v1
CPA	US only	v1
SHIPPING_CONFIGURATION	US only	v1
SHIPPING_PROGRAM	US only	v1
FITMENT_MISSING_ATTR	US only	v1
FITMENT_ACES_COVERAGE	US only	v1
BUYBOX	US only	v1
ASSORTMENT_RECOMMENDATIONS	US only	v1
CANCELLATION	US only	v1
INVENTORY_RECOMMENDATIONS	US only	v1

Body Params

Request body

Request payload

rowFilters

array of objects

Specifies a set of row level filters used to narrow down data by specific reportType. Refer to the guide section for more details.

Market availability: Global

rowFilters

excludeColumns

array of strings

Specifies columns to exclude from a report. Note that not all reports support this filter. Refer to the guide section for more details.

Market availability: Global

excludeColumns

dataStartTime

string

Start timestamp for the report data range. Use ISO 8601 format for the date (YYYY-MM-DDTHH:mm:ssZ). Required when using reportType=ITEM_PERFORMANCE and reportVersion=v3. The date range from dataStartTime to dataEndTime must not exceed 2 years (730 days).

Market availability: Global

dataEndTime

string

End timestamp for the report data range. Use ISO 8601 format for the date (YYYY-MM-DDTHH:mm:ssZ). Required when using reportType=ITEM_PERFORMANCE and reportVersion=v3. Must be greater than or equal to dataStartTime.

Market availability: Global

dateGranularity

string

enum

Specifies the date granularity for aggregating report data. Required when using reportType=ITEM_PERFORMANCE and reportVersion=v3. Valid values are DAILY, WEEKLY, MONTHLY, or QUARTERLY. Ignored for all other report types and versions.

Market availability: Global

Allowed:

Headers

WM_SEC.ACCESS_TOKEN

string

required

Access token obtained from the Token API. Required for authenticating requests to Walmart Marketplace APIs.

Market availability: Global

WM_CONSUMER.CHANNEL.TYPE

string

A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding.

Market availability: Global

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.

Market availability: Global

WM_SVC.NAME

string

required

Specifies the name of the Walmart service being called.

Market availability: Global

WM_MARKET

string

enum

required

The target market of the API call.

Market availability: Global

Allowed:

WM_GLOBAL_VERSION

string

enum

required

The version of the global API used.

Market availability: Global

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

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

application/json

application/problem+json

200Successful Operation

400Bad request. The request contains invalid or missing parameters.