Download report

Returns a redirect URL to download the report file.
After processing the response from /runs endpoint, use the same report_type_uuid and the object_id of the report you want to retrieve.
A successful response returns a 302 status code. Your client should automatically follow the redirected link to download the file. Some clients, such as Swagger UI, can include the authorization header when following the redirected link. This will cause the request to fail with a 400 Bad Request response. To avoid this issue, ensure that the authorization header is removed when the client follows the redirected URL.

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

UUID of the report type

report_run_uuid
required
string <uuid> (Report Run UUID)

UUID of the report instance (object_id returned by /runs)

Responses
302

Redirect to download URL

422

Validation Error

get/v2/reports/{report_type_uuid}/runs/{report_run_uuid}/download
Request samples
curl -i -X GET \
'https://api.goshippo.com/v2/reports/{report_type_uuid}/runs/{report_run_uuid}/download' \
-H 'Authorization: ShippoToken <API_TOKEN>'
Response samples
application/json
{
  • "detail": [
    ]
}