Retrieve Details on a Single Report

get

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

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 guide for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

reportType

string

required

Specifies the report type.

UseINVOICES to retrieve an invoice report.

Valid values are:

Value	Meaning
INVOICES	Creates a report with all invoices a supplier has successfully submitted to Walmart, including payment status and details. Returns the last two months of invoices by default.

reportVersion

string

required

Indicates the version of the created report. Invoice reports support version 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

Language

URL

Loading…

Response

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

application/json

200Successful Operation