Help CenterGitHub

List insured shipments

Returns a list of shipping labels with insurance coverage.

Parameters

Query Parameters

page integer
Page number for pagination
limit integer
Items per page (max 100)
status string (draft | generated | printed | shipped | delivered | delivered_exception | returned | cancelled | void)
Filter by shipment status. Valid values are the label statuses: draft | generated | printed | shipped | delivered | delivered_exception | returned | cancelled | void. purchased is accepted as an alias for generated. Anything else returns 400 INVALID_STATUS — note in_transit and voided are not valid (the void status is spelled void).
has_claim boolean
Filter by whether a claim has been filed. Applied in the query, so pagination and total both reflect the filter.

Returns

200 List of insured shipments retrieved successfully
401 Authentication required

Related

Insurance
GET/api/v1/insurances