Get inventory reconciliation data for WFS item
The Inventory Reconciliation Report API provides a summary of your net inventory movement for a specified time period. Use this endpoint to compare starting and ending quantities for each SKU, and track units sold, lost, returned, and other inventory changes.
The report is updated daily at 7 am PST and includes all transactions as of midnight the previous day. Data is available from January 1, 2022, and can be accessed at a monthly level. For the current month, you can also query by a single GTIN.
As the report is regenerated periodically; we recommend retrieving it no more than once per hour.
This page describes an example using only the required parameters and inputs for getting WFS inventory. For a full list of customization options and additional capabilities, refer to the Walmart WFS API Reference.
Endpoint
https://marketplace.walmartapis.com/v3/report/wfs/InventoryReconciliationReport
Sample request
This sample request retrieves a summary of net inventory changes for your SKUs within the specified date range.
GET https://marketplace.walmartapis.com/v3/report/wfs/inventory-reconciliation-report?startDate=2024-05-01&endDate=2024-05-31
WM_SEC.ACCESS_TOKEN: YOUR_ACCESS_TOKEN
WM_QOS.CORRELATION_ID: YOUR_CORRELATION_ID
WM_SVC.NAME: YOUR_SERVICE_NAME
Accept: application/json
import requests url = "https://marketplace.walmartapis.com/v3/report/wfs/inventory-reconciliation-report"
params = { "startDate": "2024-05-01", "endDate": "2024-05-31"
}
headers = { "WMSEC.ACCESSTOKEN": "YOURACCESSTOKEN", "WMQOS.CORRELATIONID": "YOURCORRELATIONID", "WMSVC.NAME": "YOURSERVICENAME", "Accept": "application/json"
} response = requests.get(url, headers=headers, params=params) if response.statuscode == 200: print("Success!") print(response.json())
else: print(f"Error: {response.status_code}") print(response.text)
This sample request queries a single GTIN for the current month.
GET https://marketplace.walmartapis.com/v3/report/wfs/inventory-reconciliation-report?startDate=2024-06-01&endDate=2024-06-10>in=00012345678905
WM_SEC.ACCESS_TOKEN: YOUR_ACCESS_TOKEN
WM_QOS.CORRELATION_ID: YOUR_CORRELATION_ID
WM_SVC.NAME: YOUR_SERVICE_NAME
Accept: application/json
import requests
import requests url = "https://marketplace.walmartapis.com/v3/report/wfs/inventory-reconciliation-report"
params = { "startDate": "2024-06-01", "endDate": "2024-06-10", "gtin": "00012345678905"
}
headers = { "WM_SEC.ACCESS_TOKEN": "YOUR_ACCESS_TOKEN", "WM_QOS.CORRELATION_ID": "YOUR_CORRELATION_ID", "WM_SVC.NAME": "YOUR_SERVICE_NAME", "Accept": "application/json"
} response = requests.get(url, headers=headers, params=params) print(response.status_code)
print(response.json())
Modify your code
Replace all placeholder values with your actual shipment data before making the API request.
Authorization
- Replace with your actual Base64-encoded credentials.WM_QOS.CORRELATION_ID
- Use a unique correlation UUID to track the request.WM_SEC.ACCESS_TOKEN
- Replace with your valid access token obtained through authentication.
Sample response
The data is returned as a .csv file, which will be available in your designated folder. A successful API response includes a Content-Disposition header with the report attached. This header specifies the filename, for example: attachment: filename=WFSInventoryHealthReport_2021-07-15T06_42_13.766Z.csv
, where the timestamp indicates when the file was generated. The attachment contains the report in CSV format.
Result
If successful, the API returns an HTTP status 200 OK
with a CSV file as the response body. The CSV file contains inventory reconciliation data for the specified WFS item(s) and time period. Each row provides details for a SKU, including GTIN, beginning and ending quantities, units sold, returned, lost, found, damaged, and other adjustments for the specified period.
Updated about 22 hours ago