Return list of reports

Returns a list of reports that can be downloaded.
A report type is a report that can be executed on a schedule and/or on demand. If you have requested Shippo a custom report, you will receive the report type UUID that represents that report type. With this report type UUID, you can call this endpoint to list all the available runs of your report.

SecurityAPIKeyHeader
Request
path Parameters
report_type_uuid
required
string <uuid> (Report Type UUID)

UUID of the report type

query Parameters
status
string (ReportStatus)

Filters report runs by their current status. This is an optional parameter, but it's recommended setting it to SUCCEEDED if your integration doesn't handle the other statuses

Enum: "QUEUED" "PROCESSING" "SUCCEEDED" "FAILED"
mode
string (ReportInstanceMode)

Filters results for only one report mode. (only scheduled reports are supported currently)

Enum: "ON_DEMAND" "SCHEDULED"
page
string (Page)

Link to the next page

Example: page=bmV4dDs5MTsyMDI0LTA4LTA3VDE0OjQ1OjA4LjkyNzg1MSswMDowMA==
limit
integer (Limit) >= 1
Default: 10

The upper limit to the number of results returned

Responses
200

Successful Response

422

Validation Error

get/v2/reports/{report_type_uuid}/runs
Request samples 
curl -i -X GET \
'https://api.goshippo.com/v2/reports/{report_type_uuid}/runs?status=QUEUED&mode=ON_DEMAND&page=bmV4dDs5MTsyMDI0LTA4LTA3VDE0OjQ1OjA4LjkyNzg1MSswMDowMA==&limit=10' \
-H 'Authorization:  ShippoToken <API_TOKEN>'
Response samples
application/json
{
  • "resources": [
    ],
  • "page_info": {
    }
}