Deliverr API指南 - 报告篇

注意事项:

• 要访问任何报告端点，需要在“Authorization”（授权）过程中，把 api/reports 作为一个作用域进行认证。 欲了解更多信息，请访问《Deliverr API指南 - 认证篇》。
• 本指南应与Deliverr API规范一起使用： https://api.deliverr.com/documentation/v1/spec

Deliverr的 Reports API 允许您生成新报告并将其下载为CSV文件。有关每种可用报告的具体信息，请访问此链接。

1. 生成报告 POST /reports/v1/report

   • 要生成一个新报告，请向 Reports API 的 generate 端点发出以下请求：

     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"
     }'
     

   • 可能会收到如下响应：

     {
         "reportReference": {report_name_received}
     }

2. 获取报告状态 GET /reports/v1/status/{report_name}

   • 一旦提出了“报告生成”请求，“报告生成”过程就开始了。要检查报告的状态，请使用收到的报告名称向 Reports API 的 get report status 端点发出以下请求：

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

   • 如果报告仍在生成中，会收到如下响应：

     {
     	"status": "PENDING"
     }
     

     如果为此情况，请继续定期轮询端点，直到收到不同的响应。

   • 生成报告后，将在同一端点收到如下响应：

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

     获得URL后，其有效期为两分钟，在此期间，可以下载报告。如果URL过期，可以使用相同的请求生成新URL，该URL也将持续两分钟。