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

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
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

Specifies the starting timestamp of the report range to filter data from that point onward.

Market availability: Global

dataEndTime

string

End timestamp of the report date range.

Market availability: Global

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:

Response

200Successful Operation