Create report request

post

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

This request creates a report, 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 API Overview guide for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

reportType

string

enum

required

Specifies the requested report type.

For example, INVENTORY_DSV creates an inventory report.

Valid values are:

Value	Meaning
DSV_ORDERS	Creates a report with all a supplier's drop ship vendor (DSV) orders placed within a defined time period.
INVENTORY_DSV	Creates a DSV inventory report.
INVOICES	Creates a report with all invoices a supplier has successfully submitted to Walmart, including payment status and details.
ITEM_CONFIGURATION_DATA	Creates an item configuration data report.
PRODUCT_CONTENT_DATA	Creates a report containing all the items you sell to Walmart.
VENDOR_MANAGED_PRICING	Creates a report with all the cost and prices for each item-store combination, including distributor information. This report is only available to suppliers in select departments.

Allowed:

reportVersion

string

required

Specifies the version of the created report.

Supported versions for each report type include:

Report Type	Supported Version
DSV_ORDERS	v1
INVENTORY_DSV	v1
INVOICES	v1
ITEM_CONFIGURATION_DATA	v1
PRODUCT_CONTENT_DATA	v1
VENDOR_MANAGED_PRICING	v1

Body Params

Request fields

rowFilters

array of objects

Array of objects containing filters for the report you want to generate.

rowFilters

includeColumns

array of strings

List of columns returned in the report.

includeColumns

Headers

WM_CONSUMER.CHANNEL.TYPE

string

Identifier that tracks the consumer request by channel.

Use the consumer channel type received during your onboarding. Contact your system administrator or developer management for the correct WM_CONSUMER.CHANNEL.TYPE value.

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.

WM_SEC.ACCESS_TOKEN

string

required

Access token returned by the Create access token request.

This value is required for token-based authentication.

Response

200Successful Operation