Deliverr API Guide - Reports

Notes:

• To access any of the reports endpoints, you will need to have authenticated with the api/reports as a scope in the Authorization process. For more information, please visit the guide on authentication.
• This guide is meant to be accompanied with Deliverr's API spec: https://api.deliverr.com/documentation/v1/spec

Deliverr's Reports API allows you to generate new reports and download them as CSV files. For specific information on each type of report available, please visit this link.

1. Generate Report POST /reports/v1/report

   • To generate a new report, make the following request to the Reports API’s generate endpoint

     curl --location --request POST '<https://api.deliverr.com/reports/v1/report>' \\
     --header 'Authorization: Bearer {valid_access_token}' \\
     --header 'Content-Type: application/json' \\
     --data-raw '{
         "reportType": "Products-All_SKUs_With_Alias_Counts"
     }'
     

   • This will give you a response like:

     {
         "reportReference": {report_name_received}
     }

2. Get Report Status GET /reports/v1/status/{report_name}

   • Once a report generation request has been made, the report generation process has begun. To check on the status of your report, make the following request to the Reports API’s get report status endpoint using the report name received

     curl --location --request GET '<https://api.deliverr.com/reports/v1/status/{report_name_received}>' \\
     --header 'Authorization: Bearer {valid_access_token}'
     

   • If the report is still being generated, you will receive a response like:

     {
     	"status": "PENDING"
     }
     

     If that happens, continue to periodically poll the endpoint until you receive a different response.

   • Once the report has been generated, you will receive the following response at the same endpoint:

     {
         "status": "SUCCESS",
         "urlExpiration": "{datetime_GMT}",
         "url": "{valid_CSV_download_URL}"
     }
     

     Once you get a URL, it is valid for 2 minutes during which you can download your report. If the URL expires, you can use the same request to generate a new URL that will also last 2 minutes.