Insurance

Create an Insurance Policy

Create insurance for a shipment whose label isn't provided by Easyship. For the shipment whose label is provided by Easyship, please use Shipment Insurance Endpoint to insure it.

Easyship relies on the tracking number and courier service ID to validate the shipment. Once the tracking record is successfully established, the insurance will be automatically set up and charged.

If the tracking record is initiated using the tracking endpoint POST /:version/trackings, it becomes valid for insurance only after receiving a response from the courier service, and within 24 hours of that time.

Required authorization scope: public.insurance_policy_3p:write

This API requires an updated contract with Easyship. Get in touch with your account manager or Easyship Support Team.

post/2024-09/insurances/policies

Request body

tracking_numberstring required
courier_service_idstring uuid

unique identifier for a courier service

courier_service_namestring

Name of the courier service. Required if courier_service_id is not provided. For courier services that Easyship doesn't support label generation, please retrieve the name using GET /trackings/external_courier_services

platform_order_numberPlatformOrderNumber — unresolved $ref
origin_address_idstring uuid

ID of origin address. Required if the origin_address object is not provided. If provided, the origin address attributes will be ignored.

Response

Insurance policy successfully created