Skip to main content
POST
Create Report Run

Authorizations

Authorization
string
header
required

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.

report_type
string
required
interval
CreateReportRunInterval · object
required

Requested report interval in UTC epoch seconds.

columns
string[] | null
Minimum array length: 1
output_format
enum<string>
default:csv_gzip

File format for the generated report.

Available options:
csv,
csv_gzip,
parquet
idempotency_key
string | null

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 - 128

Response

Idempotent replay of an existing report run.

Run resource while queued for processing.

id
string<uuid>
required
report_type
string
required
interval
ReportRunInterval · object
required

Report interval in UTC epoch seconds.

columns
string[]
required
output_format
enum<string>
required

File format for the generated report.

Available options:
csv,
csv_gzip,
parquet
created
integer
required
status
string
required
Allowed value: "QUEUED"
Last modified on September 16, 2026