Report status notification
The Report Status notification is triggered when a report request created using the Create Report Request API changes status. You’ll receive this event at least when the request reaches READY (report is available to download) or ERROR.
When this event occurs, Walmart posts a JSON payload to your destination URL.
Event metadata
- Event Type: REPORT_STATUS
- Event Version: V1
- Resource Name: REPORTS
Response parameters
| Name | Description | Type |
|---|---|---|
| source | Event meta information | Object |
| eventType | Event for which the notification is received | String |
| eventTime | Time at which the event occurs | String |
| eventId | Unique ID of the event | String |
| payload | Event details | Object |
| partnerId | Seller’s Partner ID | String |
| requestId | Unique ID for the Report generation request | String |
| requestStatus | Status of the Report generation request | String |
| requestSubmissionDate | Request submission time | String |
| reportGenerationDate | Report generation time | String |
| reportType | Type of Report | String |
| reportVersion | Version of Report | String |
| errorDescription | Error description, in case of an error | String |
Sample payload 1: Report status event
{
"source": {
"eventType": "REPORT_STATUS",
"eventTime": "2020-07-03T14:12:42.913Z",
"eventId": "03d34580-61d4-11ea-9e23-cd38810ff7cd"
},
"payload": {
"partnerId": "10902014482",
"requestId": "6da7357b-1c3b-4c1d-9685-ca2931eb96b4",
"requestStatus": "READY",
"requestSubmissionDate": "2020-12-10T07:08:35.393Z",
"reportGenerationDate": "2020-12-10T07:21:34.473Z",
"reportType": "ITEM",
"reportVersion": "v1"
}
}
Sample payload 2: Report status even
{
"source": {
"eventType": "REPORT_STATUS",
"eventTime": "2020-07-03T14:12:42.913Z",
"eventId": "e435c380-fbe6-11ea-bc39-c314c32822dc"
},
"payload": {
"partnerId": "10902014482",
"requestId": "6da7357b-1c3b-4c1d-9685-ca2931eb96b4",
"requestStatus": "ERROR",
"requestSubmissionDate": "2020-12-10T07:08:35.393Z",
"reportGenerationDate": "2020-12-10T07:21:34.473Z",
"reportType": "ITEM",
"reportVersion": "v1",
"errorDescription": "Your report request has resulted in error. Please try creating a new request."
}
}
Updated 1 day ago