Create Report Run
Report Runs
Create Report Run
POST
Create Report Run
Authorizations
Shippo API token header, for example ShippoToken shippo_live_xxxx.
Body
application/json
Create an asynchronous report run. Select column names from the report type's available_columns.
Requested report interval in UTC epoch seconds.
Minimum array length:
1File format for the generated report.
Available options:
csv, csv_gzip, parquet Optional client key that makes create idempotent. Reusing the same key with the same request returns the original run (200); reusing it with a different request returns 409.
Required string length:
1 - 128Response
Idempotent replay of an existing report run.
- AcceptedReportRunResponse
- RunningReportRunResponse
- SucceededReportRunResponse
- FailedReportRunResponse
Run resource while queued for processing.
Report interval in UTC epoch seconds.
File format for the generated report.
Available options:
csv, csv_gzip, parquet Allowed value:
"QUEUED"Last modified on September 16, 2026