v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB

Shipment Reports

Gets summary of the shipment report

After the shipment report generation is completed, use the shipmentReportId as a path parameter for fetching the summary of the shipment report.

The summary contains general information about the locations, shipments, shipment plans, segments, and segment plans which were used in the generation of the shipment report. It also includes the time when the shipment report generation started, and when it ended.

get/shipment-reports/v4/{shipmentReportId}/summary

Response

Success

completedAtstring date-time required

When generation of the shipment report was completed.

createdAtstring date-time required

When generation of the shipment report was started.

totalLocationCountinteger required

Count of locations over all segment plans in the shipment report.

totalSegmentPlanCountinteger required

Count of segment plans in the shipments report.

totalSegmentsCountinteger required

Count of segments over all segment plans in the shipment report.

totalShipmentPlanCountinteger required

Count of shipment plans in the shipments report.

totalShipmentsCountinteger required

Count of shipments over all shipment plans in the shipment report.