Retrieve Parcels Report

GET {{baseUrl}}/reporting/parcels/:report_id

Get parcels report

Once you've created a parcel report, use this endpoint to generate a URL which will allow you to download it in CSV format. The report id is the one you obtained via the Create parcels report endpoint:

"id": "9d2e0de3-204e-4edf-992f-71dd624f8e2e",

Depending on the size of the report, it may not be immediately available for download. The status of the report is indicated in the response:

  "status_message": "The report is ready",

The report will expire after a certain amount of time, after which you will have to generate it again. The time of expiry is indicated in the response body:

"expires_at": "2022-05-24T16:10:21.084724",

Example:

GET https://panel.sendcloud.sc/api/v2/reporting/parcels/9d2e0de3-204e{...}71dd624f8e2e

HEADERS

RESPONSES

status: OK

{"filters":{"direction":"incoming","integration_id":"\u003cinteger\u003e","updated_after":"\u003cdateTime\u003e","updated_before":"\u003cdateTime\u003e","announced_after":"\u003cdateTime\u003e","announced_before":"\u003cdateTime\u003e"},"fields":["order_number","first_delivery_at"],"id":"\u003cuuid\u003e","user_id":"\u003cinteger\u003e","status":"failed","status_message":"\u003cstring\u003e","url":"\u003curi\u003e","expires_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","created_at":"\u003cdateTime\u003e"}