Skip to main content

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Reporting API lets you generate and download CSV reports containing data related to your Sendcloud account for tracking and analysis purposes. You can refine the data which will be included by selecting which fields to show on the report, and filter on when the parcel was announced or updated in the Sendcloud system. Reports are generated asynchronously: create the report, then poll its status until the CSV is ready to download.
Reporting endpoints are gated by per-feature access. Depending on your account’s plan and enabled features, the Reporting API may not be available to you.

​
What can you do with this API?

  • Create a parcels CSV report filtered by date window, direction, integration, brand, or shipping option
  • Retrieve a parcels report by id to check its status and download the CSV once it’s ready
Tip: To create a report of your return shipments, include the property direction: "incoming". Similarly, direction: "outgoing" will create a report of your outgoing shipments. Omit the field to include both incoming and outgoing parcels.
Each report is capped at 100,000 parcels. If your filters match more, the report fails with a 400 response and a detail message like CSV export exceeds row limit of 100000, .... Narrow the date range or apply additional filters to stay under the cap.