What's in the Insurance CSV Report?
You can access the Insurance Report in a .csv
format through our Reports Object, which you can create via the API or download directly from the dashboard. The .csv
file contains the fields listed below with their definitions.
Field | Definition or Sample Data |
---|---|
created_at | The timestamp the Insurance was created |
updated_at | The timestamp the Insurance was last updated |
id | ins_... (unique identifier of the Insurance) |
reference | A reference you assigned to the Insurance object, if any |
amount | Amount of coverage specified for the Insurance |
provider | "EasyPost" |
shipment_id | shp_... (EasyPost Shipment identifier, if insurance was purchased with a Shipment) |
tracking_code | Tracking code tied to the Insurance |
status | "pending" - awaiting tracking details "purchased" - insurance successfully purchased "failed" - insurance transaction failed "refunded" - insurance was successfully refunded |
tracker_id | trk_... (Tracker objected tied to the Insurance) |
to_address_id | adr_... (Destination Address tied to the Insurance) |
from_address_id | adr_... (From Address tied to the Insurance) |
insurance_fee | The amount EasyPost charged for insuring the Shipment |
refund_status | refunded" if the refund was successful |
messages | Array of any relevant error messages for the Shipment |