v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB

Shipments

Generate a Shipment Report

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

post/public/v3/Shipments/generateReport

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Request body

publicShipmentIdsstring[] required

A list of public shipment IDs you would like to run a report on. Maximum of 10 shipments per report.

formatstring required

The format of the report. Values include PDF, PdfRawData, or CSV.

sensorDatastring[] 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.

timeZonestring required

The timezone that report timestamps will display in.

generationTriggerstring required

Determines when the report gets generated. Values include Immediately or OnShipmentsCompletion.

multiShipmentFormatstring 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.

usersstring[] nullable

A list of user IDs to share the report with.

dateTimeStartstring date-time nullable

The UTC start date and time of data to be reported on. Date range defaults to the full shipment duration.

dateTimeEndstring date-time nullable

The UTC end date and time of data to be reported on. Date range defaults to the full shipment duration.

visibilitystring 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

Shipment report created and will be available once generated.