Sign in

v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Shipment Reports

Starts shipment report generation

This endpoint starts the shipment report generation. One can specify which shipments to include in the shipments report by using the filters in the request body. The response contains the generated shipment report ID shipmentReportId.

After the shipment report generation has been requested, the status of the shipment report generation can be checked by using the /shipment-reports/v4/{shipmentReportId}/status endpoint.

post/shipment-reports/v4

Request body

endedAfterstring date-time

Include successfully completed shipments of each shipment plan into the shipment report generation which ended after the provided date.

endedBeforestring date-time

Include successfully completed shipments of each shipment plan into the shipment report generation which ended before the provided date.

shipmentPlanIdsstring[]

Provide array of shipment plan ids to include into the shipment report. If just a single shipment plan id is given, then the shipment report will include only metrics and shipments for the given shipment plan. If none is given, then the shipment report will include all shipment plans.

startedAfterstring date-time

Include successfully completed shipments of each shipment plan into the shipment report generation which started after the provided date.

startedBeforestring date-time

Include successfully completed shipments of each shipment plan into the shipment report generation which started before the provided date.

Response

Accepted

The shipment reports generation started successfully. Use the shipmentReportId for checking the status of the generation, and once it's generated, it can be used for fetching the metrics.

shipmentReportIdstring required

Shipment report ID