Report status notification event
Report status notifications are triggered when the requested report moves to READY status and is available to download.
- Event type:
REPORT_STATUS - Event trigger: A report has completed its generation process
- Event version: V1
- Resource name:
REPORTS
When the report status notification event occurs, you will receive the notification payload at your defined destination URL.
Event notification payload parameters
| Name | Description | Type |
|---|---|---|
| partnerId | Specifies the supplier vendor identifier. | String |
| requestId | Specifies the identifier for the report generation that the supplier received when initially requesting the event. | String |
| requestStatus | Specifies the status of the report generation request. There are two possible values: READY or ERROR. | String |
| requestSubmissionDate | Specifies the time at which the supplier initially requested the report. | String |
| reportGenerationDate | Specifies the time at which the report completed generation. | String |
| reportType | Specifies the type of report. | String |
| reportVersion | Specifies the version of the report. | String |
| errorDescription | Specifies the error description. This is only present if requestStatus has the value of ERROR. | String |
Sample payload: Report status event
{"source": {"eventType": "REPORT_STATUS", "eventTime": "2025-07-03T14:12:42.913Z", "eventId": "03d34580-61d4-11ea-9e23-cd38810ff7cd" },
"payload": { "partnerId": "651263",
"requestId": "6da7357b-1c3b-4c1d-9685-ca2931eb96b4",
"requestStatus": "READY",
"requestSubmissionDate": "2025-12-10T07:08:35.393Z",
"reportGenerationDate": "2025-12-10T07:21:34.473Z",
"reportType": "DSV_INVENTORY",
"reportVersion": "v1"}}
Sample Payload: Report status event - error
{"source": { "eventType": "REPORT_STATUS", "eventTime": "2025-07-03T14:12:42.913Z", "eventId": "e435c380-fbe6-11ea-bc39-c314c32822dc"},
"payload": {"partnerId": "651263", "requestId": "6da7357b-1c3b-4c1d-9685-ca2931eb96b4",
"requestStatus": "ERROR",
"requestSubmissionDate": "2025-12-10T07:08:35.393Z",
"reportGenerationDate": "2025-12-10T07:21:34.473Z",
"reportType": "DSV_INVENTORY",
"reportVersion": "v1",
"errorDescription": "Your report request has resulted in error. Please try creating a new request."}}
Updated 40 minutes ago
