---
title: "Generate a Shipment Report"
method: POST
path: "/public/v3/Shipments/generateReport"
tags: ["Shipments"]
---

# Generate a Shipment Report

`POST /public/v3/Shipments/generateReport`

Creates a report of sensor data for the specified shipment(s).

## Headers

- `x-tive-account-id` integer, required

## Request body

- ShipmentReportRequest
  - `publicShipmentIds` string[], required — A list of public shipment IDs you would like to run a report on. Maximum of 10 shipments per report.
  - `format` string, required — The format of the report. Values include `PDF`, `PdfRawData`, or `CSV`.
  - `sensorData` string[], required — The sensor fields you would like to include in your report. At least one of the following values must be specified: `Location`, `Temperature`, `ProbeTemperature`, `Humidity`, `Pressure`, `Light`, `Motion`, `Acceleration`, `Battery`.
  - `timeZone` string, required — The timezone that report timestamps will display in.
  - `generationTrigger` string, required — Determines when the report gets generated. Values include `Immediately` or `OnShipmentsCompletion`.
  - `multiShipmentFormat` string, required — Determines if each shipment specified in `shipmentIds` will be generated in their own file or in a single file. Values include `ShipmentOwnFile` or `AllShipmentsOneFile`.
  - `users` string[], nullable — A list of user IDs to share the report with.
  - `dateTimeStart` string, date-time, nullable — The UTC start date and time of data to be reported on. Date range defaults to the full shipment duration.
  - `dateTimeEnd` string, date-time, nullable — The UTC end date and time of data to be reported on. Date range defaults to the full shipment duration.
  - `visibility` string, required — Determines if the shipment is visible to users in the shipment account, all shipment collaborators, or just the report creator. Values can be `AccountUsers` or `AllShipmentCollaborators`, or `CreatorOnly`.

## Response `202`

Shipment report created and will be available once generated.

## Other responses

- `400` — Unable to generate the shipment report. See response message for details.
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/tive/apis/tive-public-api.md) · [All operations](https://skmtc.net/tive/apis/tive-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tive/tive-public-api/versions/9a8d869e3cdc/schema)