v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

Retrieve shipment reports

Retrieve paginated reports for a specified shipment

get/public/v3/Shipments/{shipmentId}/reports

Path parameters

shipmentIdstring required

shipmentId of the shipment.

Query parameters

PageSizeinteger

The number of results to retrieve. Default and maximum is 50.

PageNumberinteger

The page number to use. This is needed when there are more objects than the max page size. The default is 1.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The requested reports for shipment

totalRecordsinteger
pageNumberinteger
pageSizeinteger
nextstring nullable
previousstring nullable