--- updatedAt: 2026-04-12T09:21:45.000Z --- # Pre-Generated Reports Management API overview ## Overview Use the **Pre-Generated Reports Management API** to retrieve a drop-ship vendor (DSV) **item report** that lists information for items you have set up on Walmart. The report includes identifiers, pricing, publication status, availability, shipping methods, imagery, ratings, and other attributes. Use this API when you need a current snapshot of item data for auditing, reconciliation, pricing checks, or analytics. It is read-only and returns data in JSON. **Audience**: DSV suppliers who need a current snapshot of item data.\ **Base URLs**: * Production: `https://api-gateway.walmart.com` * Sandbox: `https://sandbox.walmartapis.com` ### Authentication & headers Use the Authentication Management API to obtain `WM_SEC.ACCESS_TOKEN`. Send the token in the header for each call. Refresh when tokens expire. | Header | Required | Description | | -------------------------- | -------- | ------------------------------------------------------------------------------- | | `WM_SEC.ACCESS_TOKEN` | Yes | Access token for token-based authentication. | | `WM_QOS.CORRELATION_ID` | Yes | A GUID you generate per call. Use it for tracing and support. | | `Accept` | No | Response format. Supported: `application/json`, `application/xml`. | | `WM_CONSUMER.CHANNEL.TYPE` | No | Channel identifier assigned during onboarding. | | `Content-Type` | Yes | Gateway requires a value. Use `application/xml` as specified for this endpoint. | > Tip: Use a new GUID for each `WM_QOS.CORRELATION_ID` and verify the access token has not expired. ## Generate an item report ### GET `/v3/getReport` Retrieve the DSV item report. #### Query parameters | Name | Required | Type | Description | | --------- | -------- | ------ | ------------------------------------------------------------------------- | | `type` | Yes | string | Report type. Use `vendor_item` to request the DSV item report. | | `version` | Yes | string | Report version. Use `2` to request the latest vendor item report version. | #### Headers Include the headers listed earlier. Example values are shown below. #### Request example (Production) ```bash curl -X GET 'https://api-gateway.walmart.com/v3/getReport?type=vendor_item&version=2' -H 'WM_SEC.ACCESS_TOKEN: ' -H 'WM_QOS.CORRELATION_ID: 9c2ab4a1-4b86-4b3b-8e44-6bb2e6d1c5f1' -H 'WM_CONSUMER.CHANNEL.TYPE: ' -H 'Accept: application/json' -H 'Content-Type: application/xml' ``` #### Request example (Sandbox) ```bash curl -X GET 'https://sandbox.walmartapis.com/v3/getReport?type=vendor_item&version=2' -H 'WM_SEC.ACCESS_TOKEN: ' -H 'WM_QOS.CORRELATION_ID: 9c2ab4a1-4b86-4b3b-8e44-6bb2e6d1c5f1' -H 'Accept: application/json' -H 'Content-Type: application/xml' ``` #### Response **200 OK** returns the report as JSON. Example fields are shown below. ```json { "vendorId": "837252", "sku": "1487132332472", "productName": "Kenmore CF1", "productCategory": "Grocery", "shortDescription": "Frozen beans sourced locally and packed fresh", "longDescription": "24oz bag of frozen pinto and brown beans with steam-in-bag option for quick freezer to table meals", "cost": "5.99", "price": "7.99", "currency": "USD", "buyBoxShippingPrice": "7.99", "publishStatus": "true", "lifecycleStatus": "ACTIVE", "availabilityStatus": "In stock", "shipMethods": "Standard", "wpid": "434K5CFOY8G7ZZZ", "itemId": "CBA-1357", "wm": "0864213579", "gtin": "00097531246801", "upc": "123456789012", "primaryImageUrl": "www.genericproductimage.com", "shelfName": "B1", "primaryCatPath": "General Merchandise", "offerStartDate": "2025-11-16", "offerEndDate": "2025-11-19", "itemCreationDate": "2025-11-16T10:30:15Z", "lastUpdationDate": "2025-11-19T10:30:15Z", "itemPageUrl": "www.genericitempage.com", "reviewCount": "2400", "averageRating": "7.9", "productTaxCode": "4004000", "shippingWeight": "20", "shippingWeightUnit": "LB", "statusChangeReason": "Incorrect information", "availableInventoryUnits": "2401" } ``` > Notes > > * Values such as `cost`, `price`, `reviewCount`, and `averageRating` are strings in the response. Convert to numeric types in your application if needed. > * The response structure is flat. The API does not return pagination fields for this endpoint. > * Use `Accept: application/json` to receive JSON. ## Field reference (selected) | Field | Type | Description | | ------------------------- | ------ | ----------------------------------------------------------- | | `vendorId` | string | Vendor identifier. | | `sku` | string | Supplier-assigned SKU. | | `wpid` | string | Walmart product identifier. | | `gtin` | string | Global Trade Item Number. | | `upc` | string | Universal Product Code. | | `price` | string | Current price. | | `cost` | string | Item cost. | | `currency` | string | ISO 4217 currency code (for example, USD, CAD). | | `publishStatus` | string | Indicates if the item is published. | | `availabilityStatus` | string | Inventory availability status (for example, In stock). | | `shipMethods` | string | Shipping methods available (for example, Standard, OneDay). | | `itemCreationDate` | string | Creation time in ISO 8601 format. | | `lastUpdationDate` | string | Last update time in ISO 8601 format. | | `availableInventoryUnits` | string | Units in stock. | ## Error handling This endpoint returns standard HTTP status codes. * **401 Unauthorized**: Invalid or expired token. Refresh the token and retry. * **400 Bad Request**: Missing or invalid headers or parameters. * **403 Forbidden**: Your account does not have access to this report. * **5xx Server errors**: Temporary problems. Retry with exponential backoff. For faster support, log the full error payload and your `WM_QOS.CORRELATION_ID`. ## Best practices * Cache report responses if you run the report frequently. * Validate required query parameters (`type`, `version`) before sending. * Convert numeric string fields to numbers in your analytics pipeline. * Monitor for schema changes tied to `version` and update your parser when you move versions. ## Origin of Report Content: Walmart or Supplier Some of the information in the Item report comes from the vendor, and some originates from Walmart. The table below shows the supplier item report fields that originate from Walmart or the supplier.
| Origin: Walmart | Origin: Supplier | | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Vendor ID, Availability Status, Lifecycle Status, Publish Status, BuyBox Shipping Price, BuyBox Item Price, WPID, Item ID, WM#, GTIN, UPC, Primary Image URL, Shelf Name, Primary Cat Path,Item Creation Date, Last Update on Date, Item Page URL, Reviews Count, Average Rating, Status Change Reason, Available Inventory Units | SKU, Product Name, Product Category, Short Description, Long Description, Cost, Price, Currency, Ship Methods, Offer Start Date, Offer End Date, Product Tax Code, Shipping Weight, Shipping Weight Unit | To view descriptions for each field, see the response schema in the [GET Item Report request ](/suppliers/reference/getgenerateitemreport)API reference. ## What’s in the Item Report CSV File? The response contains the compressed comma-separated value (CSV) file as an attachment, with values for all of the fields listed in the response schema in the [GET Item Report request API ](/suppliers/reference/getgenerateitemreport)reference. The `Content-Disposition` header contains the name of the report; for example, `filename=ItemReport_742202_2020-03-31T012243.0960000.zip`. The report file title includes the supplier’s vendor ID, such as 742202, and the file generation timestamp. ## OPTIONAL: Parse CSV File with Java To format the comma-separated value (CSV) file, suppliers can use Java code to parse the response to a comma-separated value (CSV) file. The example below demonstrates the use of the header and the body to process the response. Example: Java code to parse CSV file ```java if (response.getStatus() == Response.Status.OK.getStatusCode() && response.hasEntity()) { InputStream inputStream = (InputStream)response.getEntity(); try { String header = response.getHeaderString("Content-Disposition"); if(header != null && !("").equals(header)) { if(header.contains("filename")){ //header value will be something like: //attachment; filename=10000000354_2016-01-15T23:09:54.438+0000.zip int length = header.length(); String fileName = header.substring(header.indexOf("filename="),length); System.out.println("filenameText " + fileName); String [] str = fileName.split("="); System.out.println("fileName: " + str[1]); //replace "/Users/anauti1/Documents/" below with your values File reportFile = new File("/Users/anauti1/Documents/" + str[1].toString()); OutputStream outStream = new FileOutputStream(reportFile); byte[] buffer = new byte[8 * 1024]; int bytesRead; while ((bytesRead = inputStream.read(buffer)) != -1) { outStream.write(buffer, 0, bytesRead); } IOUtils.closeQuietly(inputStream); IOUtils.closeQuietly(outStream); } } } catch (Exception ex){ System.out.print("Exception: " + ex.getMessage()); } } ``` ## Deprecation notice The Pre-Generated Reports Management API is deprecated and will be unsupported in a future Walmart Supplier API release. Use the On Request API Reporting Platform to request more relevant reports: 1. Item product reports: Provides all of the items a supplier sells to Walmart customers in a single report with relevant attributes & insights, such as content quality scores & insights, and key information on the Walmart.com shopping experience. * Primary Key: GTIN 14 2. Item configurations report: Provides all of the different item configurations that a supplier sells to Walmart and all of the related supply chain and logistics Information, such as cost, supply item status codes, and the trade item hierarchy. * Primary Key: Walmart Item Number The On Request API Reporting Platform allows for larger data sets to be sent to suppliers, as well as additional capabilities such as filtering to be applied to reports.