--- updatedAt: 2026-08-03T17:42:58.000Z --- # Get All Report Requests

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.


[block:html] { "html": "\n \n" } [/block] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "version": "1.0", "title": "On-request Report Management", "description": "The On-request Reports API allows you to request reports immediately about your items for faster retrieval. You can request the report, check status on the report availability, and then download the report URL when report is ready. You can also get a list of all reports requested." }, "x-readme": { "samples-languages": [ "shell" ], "proxy-enabled": false, "explorer-enabled": true }, "servers": [ { "url": "https://marketplace.walmartapis.com", "description": "Production URL" } ], "security": [ { "basicScheme": [] } ], "paths": { "/v3/ca/reports/reportRequests": { "get": { "tags": [ "On-Request Report" ], "summary": "Get All Report Requests", "description": "

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.


", "operationId": "getRequestsStatus", "parameters": [ { "name": "reportType", "in": "query", "description": "Type of report for which the request is created. Example, ITEM for Item Report.", "required": true, "schema": { "type": "string", "enum": [ "ITEM_CA", "INVENTORY_CA" ] } }, { "name": "reportVersion", "in": "query", "description": "Version of report for which the request is created. Example, v1.", "required": false, "schema": { "type": "string" } }, { "name": "requestStatus", "in": "query", "description": "Status of report request. Possible values are RECEIVED, INPROGRESS, READY, ERROR.", "required": false, "schema": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] } }, { "name": "requestSubmissionStartDate", "in": "query", "description": "Report request submittal start date for range of reports requested, in format: YYYY-MM-DDTHH:mm:ssZ", "required": false, "schema": { "type": "string" } }, { "name": "requestSubmissionEndDate", "in": "query", "description": "Report request submittal end date for range of reports requested, in format YYYY-MM-DDTHH:mm:ssZ", "required": false, "schema": { "type": "string" } }, { "name": "WM_SEC.AUTH_SIGNATURE", "in": "header", "description": "The vendor's digital signature, generated by running the JAR file or custom generation code", "required": true, "schema": { "type": "string" }, "example": "9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=" }, { "in": "header", "name": "WM_CONSUMER.CHANNEL.TYPE", "description": "A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "WM_QOS.CORRELATION_ID", "description": "A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID", "required": true, "schema": { "type": "string" }, "example": "b3261d2d-028a-4ef7-8602-633c23200af6" }, { "in": "header", "name": "WM_SVC.NAME", "description": "Walmart Service Name", "required": true, "schema": { "type": "string" }, "example": "Walmart Service Name" }, { "in": "header", "name": "Accept", "description": "Only supported Media Type : application/json", "required": true, "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "description": "Current page", "format": "int32" }, "totalCount": { "type": "integer", "description": "Number of records fetched.", "format": "int64" }, "limit": { "type": "integer", "description": "Number of records to be returned. Default is 10.", "format": "int32" }, "nextCursor": { "type": "string", "description": "Used for pagination when more than specified limit (or default 10) records are found. Use this param for next API call. Just have to use this value as query param. Need to pass only the cursor value and not the initial API call query params. For e.g. if ['nextCursor'='reportType=ITEM_CA&requestStatus=ERROR&requestSubmissionStartDate=2021-08-20T10:52:59Z&requestSubmissionEndDate=2021-09-14T10:52:59Z&page=2&limit=1'] then subsequent call to will be [marketplace.walmartapis.com/v3/reports/reportRequests?reportType=ITEM_CA&requestStatus=ERROR&requestSubmissionStartDate=2021-08-20T10:52:59Z&requestSubmissionEndDate=2021-09-14T10:52:59Z&page=2&limit=1]. Just have to use nextCursor value instead of query params" }, "requests": { "type": "array", "description": "List of requests", "items": { "type": "object", "properties": { "requestId": { "type": "string", "description": "Automated ID generated by system that uniquely identifies the report request.", "format": "uuid" }, "requestStatus": { "type": "string", "description": "Status of report request. Possible values are RECEIVED, INPROGRESS, READY, ERROR.", "enum": [ "RECEIVED", "INPROGRESS", "READY", "ERROR" ] }, "requestSubmissionDate": { "type": "string", "description": "Date and time on which the report request is submitted." }, "reportType": { "type": "string", "description": "Type of report for which the request is created. Example, ITEM_CA for Item Report.", "enum": [ "ITEM_CA", "INVENTORY_CA" ] }, "reportVersion": { "type": "string", "description": "Version of report for which the request is created. Example, v1." }, "payload": { "type": "object", "properties": { "rowFilters": { "type": "array", "description": "Row Level filters", "items": { "type": "object", "description": "Supertype of all row filters.", "anyOf": [ { "title": "EnumFilter", "required": [ "columnName", "type" ], "type": "object", "properties": { "values": { "type": "array", "description": "Enum filter values which has to be included in report", "items": { "type": "string", "description": "Enum filter values which has to be included in report" } }, "columnName": { "type": "string", "description": "Column on which filter has to be applied" }, "type": { "type": "string", "description": "Type of the filter", "enum": [ "rangeFilter", "enumFilter" ] } } }, { "title": "RangeFilter", "required": [ "columnName", "rowFilterType" ], "type": "object", "properties": { "from": { "type": "string", "description": "Filter range start" }, "to": { "type": "string", "description": "Filter range end" }, "rowFilterType": { "type": "string", "description": "Type of the filter", "enum": [ "rangeFilter", "enumFilter" ] }, "columnName": { "type": "string", "description": "Column on which filter has to be applied" } } } ] } }, "excludeColumns": { "type": "array", "description": "Columns to exclude from report", "items": { "type": "string", "description": "Columns to exclude from report" } }, "dataStartTime": { "type": "string", "description": "Start timestamp of the report date range" }, "dataEndTime": { "type": "string", "description": "End timestamp of the report date range" } }, "description": "Request Payload" }, "reportGenerationDate": { "type": "string", "description": "Date and time on which the report is generated. Attribute is available only if report is generated." } } } } } }, "example": { "page": 1, "totalCount": 15, "limit": 2, "nextCursor": "reportType=ITEM_CA&page=2&limit=2", "requests": [ { "requestId": "98884f2c-46c7-48c6-8e19-0946ff371442", "requestStatus": "RECEIVED", "requestSubmissionDate": "2022-09-28T09:14:19", "reportType": "ITEM_CA", "reportVersion": "v1" }, { "requestId": "343bb2ab-63c6-4824-b07f-d97e5a7a4147", "requestStatus": "RECEIVED", "requestSubmissionDate": "2022-09-28T04:02:52", "reportType": "ITEM_CA", "reportVersion": "v1", "payload": { "rowFilters": [ { "type": "rangeFilter", "columnName": "ITEM CREATION DATE", "from": "2022-03-16", "to": "2023-06-16" }, { "type": "rangeFilter", "columnName": "ITEM LAST UPDATED", "from": "2022-03-16", "to": "2023-06-16" }, { "type": "enumFilter", "columnName": "PUBLISH STATUS", "values": [ "PUBLISHED", "RETIRED" ] }, { "type": "enumFilter", "columnName": "PRODUCT CATEGORY", "values": [ "Animal Food", "Animal Other" ] } ], "dataStartTime": "2024-08-10T20:11:24.000Z", "dataEndTime": "2024-09-10T20:11:24.000Z" } } ] } } } } } } } } } ```