Insurance
The Insurance API allows you to purchase and manage insurance premiums on parcels included in your shipment.
This section describes the different attributes available for insurance.
Attribute | Type | Description |
|---|---|---|
amount | number | Total cost of insurance premium. |
claim | string | Unique reference of claim filed for insurance. |
currency | string | Currency of insurance purchase. |
insurance_id | string | Unique reference for insurance. |
metadata | object | Additional context attached to insurance purchase. |
parcel | string | Unique reference of parcel linked to insurance purchase. |
shipment | string | Unique reference of shipment linked to insurance purchase. |
status | enum | Purchase status of insurance. Is always one of confirmed, pending or failed. |
transaction | string | Unique transaction reference for insurance purchase charge. |
value | number | Total value of items in parcel insured. |
created_at | datetime | Time insurance created. |
updated_at | datetime | Time insurance last updated. |
Last modified 6mo ago