Create report request

post

https://api-gateway.walmart.com/v3/reports/reportRequests

This request creates a new request for a report by specifying the report type and version.

In the request body, define one or more attributes to include in the report. The attribute must be a valid attribute for the report.

Refer to the On Request Reports guide for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

reportType

string

required

Specifies the report type for the request.

Valid values:

Value	Meaning
ITEM_CONFIGURATION_DATA	Creates an item configuration data report.
PRODUCT_CONTENT_DATA	Creates a product content data report.

Market availability: Global

reportVersion

string

required

Specifies the version of the created report.

Valid values:

Report Type	Supported Version
ITEM_CONFIGURATION_DATA	v1
PRODUCT_CONTENT_DATA	v1

Market availability: Global

Body Params

Request objects and fields.

rowFilters

array of objects

Array of objects for row filters.

Use this array to define what filters are placed on the generated report. Filter records included in the report that meet criteria set in this object.

rowFilters

includeColumns

array of strings

Array that defines the exact columns returned in the report.

Certain columns will always be returned in each report. Refer to the On Request Reports guide for more information.

includeColumns

Headers

WM_CONSUMER.CHANNEL.TYPE

string

Identifier that tracks the consumer request by channel.

Use the consumer channel type received during your onboarding.

See your system administrator or developer management for the correct WM_CONSUMER.CHANNEL.TYPE value.

Market availability: Global

WM_QOS.CORRELATION_ID

string

required

Unique identifier for each API call, used to track and debug issues.

Use a randomly generated GUID for this ID.

Market availability: Global

WM_SEC.ACCESS_TOKEN

string

required

Access token returned by the Create access token request.

This value is required for token-based authentication.

Market availability: Global

Response

200Successful Operation